Skip to content

Commit 4bc48ba

Browse files
authored
Merge pull request #4668 from ClickHouse/Blargian-patch-62656
Turn back on anchor checker
2 parents 82c39bb + 6dcc320 commit 4bc48ba

File tree

4 files changed

+26
-25
lines changed

4 files changed

+26
-25
lines changed

docs/integrations/data-ingestion/etl-tools/vector-to-clickhouse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ Notice that the second string returned is the user agent successfully parsed fro
162162

163163
Before looking at the final `CREATE MATERIALIZED VIEW` command, let's view a couple more functions used to clean up the data.
164164
For example, the value of `RequestMethod` is `"GET` containing an unwanted double-quote.
165-
You can use the [`trim`](/sql-reference/functions/string-functions#trim) function to remove the double quote:
165+
You can use the [`trimBoth` (alias `trim`)](/sql-reference/functions/string-functions#trimBoth) function to remove the double quote:
166166

167167
```sql
168168
SELECT trim(LEADING '"' FROM '"GET')

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import search_view from '@site/static/images/clickstack/nginx-logs-search-view.p
1818

1919
# Monitoring Nginx Logs with ClickStack {#nginx-clickstack}
2020

21-
::::note[TL;DR]
21+
:::note[TL;DR]
2222
This guide shows you how to monitor nginx with ClickStack by configuring the OpenTelemetry collector to ingest nginx access logs. You'll learn how to:
2323

2424
- Configure nginx to output JSON-formatted logs
@@ -29,7 +29,7 @@ This guide shows you how to monitor nginx with ClickStack by configuring the Ope
2929
A demo dataset with 10,000 sample logs is provided to test the integration before connecting your production nginx instances.
3030

3131
Time Required: 5-10 minutes.
32-
::::
32+
:::
3333

3434
## Prerequisites {#prerequisites}
3535
- ClickStack instance running
@@ -118,12 +118,12 @@ This configuration:
118118
- Adds source: nginx attribute for filtering in HyperDX
119119
- Routes logs to the ClickHouse exporter via a dedicated pipeline
120120
121-
::::note
121+
:::note
122122
- You only define new receivers and pipelines in the custom config
123123
- The processors (memory_limiter, transform, batch) and exporters (clickhouse) are already defined in the base ClickStack configuration - you just reference them by name
124124
- The time_parser operator extracts timestamps from nginx's time_local field to preserve original log timing
125125
- The pipelines route data from your receivers to the ClickHouse exporter via the existing processors
126-
::::
126+
:::
127127
128128
## Configure ClickStack to load custom configuration {#load-custom}
129129
@@ -161,9 +161,9 @@ docker run --name clickstack \
161161
docker.hyperdx.io/hyperdx/hyperdx-all-in-one:latest
162162
```
163163

164-
::::note
164+
:::note
165165
Ensure the ClickStack collector has appropriate permissions to read the nginx log files. In production, use read-only mounts (:ro) and follow the principle of least privilege.
166-
::::
166+
:::
167167

168168
## Verifying Logs in ClickStack {#verifying-logs}
169169
Once configured, log into HyperDX and verify logs are flowing:
@@ -255,9 +255,9 @@ Once ClickStack is running (you may have to create an account and login first):
255255

256256
1. Open [HyperDX](http://localhost:8080/search?from=1760976000000&to=1761062400000&isLive=false&source=690235c1a9b7fc5a7c0fffc7&select=Timestamp,ServiceName,SeverityText,Body&where=&whereLanguage=lucene&filters=[]&orderBy=)
257257

258-
::::note
258+
:::note
259259
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 20 11:00:00 - Oct 21 11:00:00 to see proper results.
260-
::::
260+
:::
261261

262262
Here's what you should see in your search view:
263263

@@ -274,7 +274,7 @@ To help you get started monitoring nginx with ClickStack, we provide essential v
274274
<VerticalStepper>
275275
## <a href={useBaseUrl('/examples/example-logs-dashboard.json')} download="nginx-logs-dashboard.json">Download</a> the dashboard configuration.
276276

277-
## Import Pre-built Dashboard {#import-dashboard}
277+
## Import the pre-built dashboard {#import-dashboard}
278278
1. Open HyperDX and navigate to the Dashboards section.
279279
2. Click "Import Dashboard" in the upper right corner under the ellipses.
280280

@@ -333,7 +333,7 @@ docker exec `<container>` cat /etc/otel/supervisor-data/effective.yaml | grep fi
333333
docker exec `<container>` cat /etc/otel/supervisor-data/agent.log
334334
```
335335

336-
## Next Steps {#next-steps}
336+
## Next steps {#next-steps}
337337
If you want to explore further, here are some next steps to experiment with your dashboard
338338

339339
- Set up alerts for critical metrics (error rates, latency thresholds)

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

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ pagination_prev: null
66
pagination_next: null
77
description: 'Monitoring Nginx Traces with ClickStack'
88
doc_type: 'guide'
9+
keywords: ['ClickStack', 'nginx', 'traces', 'otel']
910
---
1011

1112
import Image from '@theme/IdealImage';
@@ -17,7 +18,7 @@ import view_traces from '@site/static/images/clickstack/nginx-traces-search-view
1718

1819
# Monitoring Nginx Traces with ClickStack {#nginx-traces-clickstack}
1920

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

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

2829
Time Required: 5-10 minutes.
29-
::::
30+
:::
3031

3132
## Prerequisites {#prerequisites}
3233
- ClickStack instance running with OTLP endpoints accessible (ports 4317/4318)
@@ -55,9 +56,9 @@ image: nginx:1.27-otel
5556
5657
This image includes the `ngx_otel_module.so` pre-installed and ready to use.
5758

58-
::::note
59+
:::note
5960
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-
::::
61+
:::
6162

6263
## Configure nginx to send traces to ClickStack {#configure-nginx}
6364

@@ -125,13 +126,13 @@ services:
125126

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

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

134-
### Understanding the Configuration {#understanding-configuration}
135+
### Understanding the configuration {#understanding-configuration}
135136

136137
**What gets traced:**
137138
Each request to nginx creates a trace span showing:
@@ -225,19 +226,19 @@ curl -X POST http://localhost:4318/v1/traces \
225226
-d @nginx-traces-sample.json
226227
```
227228

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

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

234235
## Verify traces in HyperDX {#verify-demo-traces}
235236

236237
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=[])
237238

238-
::::note
239+
:::note
239240
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-
::::
241+
:::
241242

242243
Here's what you should see in your search view:
243244

@@ -253,7 +254,7 @@ To help you get started monitoring traces with ClickStack, we provide essential
253254

254255
## <a href={useBaseUrl('/examples/example-traces.json')} download="example-traces.json">Download</a> the dashboard configuration. {#download}
255256

256-
## Import Pre-built Dashboard {#import-dashboard}
257+
## Import the pre-built dashboard {#import-dashboard}
257258
1. Open HyperDX and navigate to the Dashboards section.
258259
2. Click "Import Dashboard" in the upper right corner under the ellipses.
259260

@@ -307,7 +308,7 @@ Look for OpenTelemetry-related errors.
307308
tail -f /var/log/nginx/access.log
308309
```
309310

310-
## Next Steps {#next-steps}
311+
## Next steps {#next-steps}
311312
If you want to explore further, here are some next steps to experiment with your dashboard
312313

313314
- Set up alerts for critical metrics (error rates, latency thresholds)

docusaurus.config.en.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ const config = {
6060
onBrokenLinks: "throw",
6161
onBrokenMarkdownLinks: "warn",
6262
onDuplicateRoutes: "throw",
63-
onBrokenAnchors: "warn",
63+
onBrokenAnchors: process.env.ON_BROKEN_ANCHORS ?? "throw",
6464
favicon: "img/docs_favicon.ico",
6565
organizationName: "ClickHouse",
6666
trailingSlash: false,

0 commit comments

Comments
 (0)