Skip to content

Commit c4d9b35

Browse files
authored
Consistent formatting with the rest of the docs
1 parent d0d3a03 commit c4d9b35

File tree

1 file changed

+10
-10
lines changed
  • docs/use-cases/observability/clickstack/integration-examples

1 file changed

+10
-10
lines changed

docs/use-cases/observability/clickstack/integration-examples/nginx-traces.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import view_traces from '@site/static/images/clickstack/nginx-traces-search-view
1717

1818
# Monitoring Nginx Traces with ClickStack {#nginx-traces-clickstack}
1919

20-
::::note[TL;DR]
20+
:::note[TL;DR]
2121
This guide shows you how to capture distributed traces from your existing nginx installation and visualize them in ClickStack. You'll learn how to:
2222

2323
- Add the OpenTelemetry module to nginx
@@ -26,7 +26,7 @@ This guide shows you how to capture distributed traces from your existing nginx
2626
- Use a pre-built dashboard to visualize request performance (latency, errors, throughput)
2727

2828
Time Required: 5-10 minutes.
29-
::::
29+
:::
3030

3131
## Prerequisites {#prerequisites}
3232
- ClickStack instance running with OTLP endpoints accessible (ports 4317/4318)
@@ -55,9 +55,9 @@ image: nginx:1.27-otel
5555
5656
This image includes the `ngx_otel_module.so` pre-installed and ready to use.
5757

58-
::::note
58+
:::note
5959
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+
:::
6161

6262
## Configure nginx to send traces to ClickStack {#configure-nginx}
6363

@@ -125,11 +125,11 @@ services:
125125

126126
Replace `<clickstack-host>` with your ClickStack instance hostname or IP address.
127127

128-
::::note
128+
:::note
129129
- **Port 4317** is the gRPC endpoint used by the nginx module
130130
- **otel_service_name** should be descriptive of your nginx instance (e.g., "api-gateway", "frontend-proxy")
131131
- Change **otel_service_name** to match your environment for easier identification in HyperDX
132-
::::
132+
:::
133133

134134
### Understanding the Configuration {#understanding-configuration}
135135

@@ -225,19 +225,19 @@ curl -X POST http://localhost:4318/v1/traces \
225225
-d @nginx-traces-sample.json
226226
```
227227

228-
::::note[Running on localhost]
228+
:::note[Running on localhost]
229229
This demo assumes ClickStack is running locally on `localhost:4318`. For remote instances, replace `localhost` with your ClickStack hostname.
230-
::::
230+
:::
231231

232232
You should see a response like `{"partialSuccess":{}}` indicating the traces were successfully sent. All 1,000 traces will be ingested into ClickStack.
233233

234234
## Verify traces in HyperDX {#verify-demo-traces}
235235

236236
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=[])
237237

238-
::::note
238+
:::note
239239
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.
240-
::::
240+
:::
241241

242242
Here's what you should see in your search view:
243243

0 commit comments

Comments
 (0)