You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/use-cases/observability/clickstack/integration-examples/nginx-traces.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ import view_traces from '@site/static/images/clickstack/nginx-traces-search-view
17
17
18
18
# Monitoring Nginx Traces with ClickStack {#nginx-traces-clickstack}
19
19
20
-
::::note[TL;DR]
20
+
:::note[TL;DR]
21
21
This guide shows you how to capture distributed traces from your existing nginx installation and visualize them in ClickStack. You'll learn how to:
22
22
23
23
- Add the OpenTelemetry module to nginx
@@ -26,7 +26,7 @@ This guide shows you how to capture distributed traces from your existing nginx
26
26
- Use a pre-built dashboard to visualize request performance (latency, errors, throughput)
27
27
28
28
Time Required: 5-10 minutes.
29
-
::::
29
+
:::
30
30
31
31
## Prerequisites {#prerequisites}
32
32
- ClickStack instance running with OTLP endpoints accessible (ports 4317/4318)
@@ -55,9 +55,9 @@ image: nginx:1.27-otel
55
55
56
56
This image includes the `ngx_otel_module.so` pre-installed and ready to use.
57
57
58
-
::::note
58
+
:::note
59
59
If you're running nginx outside of Docker, refer to the [OpenTelemetry nginx documentation](https://github.com/open-telemetry/opentelemetry-cpp-contrib/tree/main/instrumentation/nginx) for manual installation instructions.
60
-
::::
60
+
:::
61
61
62
62
## Configure nginx to send traces to ClickStack {#configure-nginx}
63
63
@@ -125,11 +125,11 @@ services:
125
125
126
126
Replace `<clickstack-host>` with your ClickStack instance hostname or IP address.
127
127
128
-
::::note
128
+
:::note
129
129
- **Port 4317** is the gRPC endpoint used by the nginx module
130
130
- **otel_service_name** should be descriptive of your nginx instance (e.g., "api-gateway", "frontend-proxy")
131
131
- Change **otel_service_name** to match your environment for easier identification in HyperDX
132
-
::::
132
+
:::
133
133
134
134
### Understanding the Configuration {#understanding-configuration}
135
135
@@ -225,19 +225,19 @@ curl -X POST http://localhost:4318/v1/traces \
225
225
-d @nginx-traces-sample.json
226
226
```
227
227
228
-
::::note[Running on localhost]
228
+
:::note[Running on localhost]
229
229
This demo assumes ClickStack is running locally on `localhost:4318`. For remote instances, replace `localhost` with your ClickStack hostname.
230
-
::::
230
+
:::
231
231
232
232
You should see a response like `{"partialSuccess":{}}` indicating the traces were successfully sent. All 1,000 traces will be ingested into ClickStack.
233
233
234
234
## Verify traces in HyperDX {#verify-demo-traces}
235
235
236
236
1. Open [HyperDX](http://localhost:8080/search?from=1761501600000&to=1761588000000&isLive=false&source=69023d1b4f1d41a964641b09&where=&select=Timestamp,ServiceName,StatusCode,round(Duration/1e6),SpanName&whereLanguage=lucene&orderBy=&filters=[])
237
237
238
-
::::note
238
+
:::note
239
239
It is important to use the link above to get the correct time range, if you don't use this link set your time range to Oct 26 13:00:00 - Oct 27 13:00:00 to see proper results.
0 commit comments