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
@@ -17,35 +17,35 @@ import log_view from '@site/static/images/clickstack/log-view.png';
17
17
import search_view from '@site/static/images/clickstack/nginx-logs-search-view.png';
18
18
import { TrackedLink } from '@site/src/components/GalaxyTrackedLink/GalaxyTrackedLink';
19
19
20
-
# Monitoring nginx logs with ClickStack {#nginx-clickstack}
20
+
# Monitoring Nginx Logs with ClickStack {#nginx-clickstack}
21
21
22
22
:::note[TL;DR]
23
-
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:
23
+
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:
24
24
25
-
- Configure nginx to output JSON-formatted logs
25
+
- Configure Nginx to output JSON-formatted logs
26
26
- Create a custom OTel collector configuration for log ingestion
27
27
- Deploy ClickStack with your custom configuration
28
-
- Use a pre-built dashboard to visualize nginx metrics
28
+
- Use a pre-built dashboard to visualize Nginx metrics
29
29
30
-
A demo dataset with sample logs is available if you want to test the integration before configuring your production nginx.
30
+
A demo dataset with sample logs is available if you want to test the integration before configuring your production Nginx.
31
31
32
32
Time Required: 5-10 minutes
33
33
:::
34
34
35
-
## Integration with existing nginx {#existing-nginx}
35
+
## Integration with existing Nginx {#existing-nginx}
36
36
37
-
This section covers configuring your existing nginx installation to send logs to ClickStack by modifying the ClickStack OTel collector configuration.
37
+
This section covers configuring your existing Nginx installation to send logs to ClickStack by modifying the ClickStack OTel collector configuration.
38
38
If you would like to test the integration before configuring your own existing setup, you can test with our preconfigured setup and sample data in the [following section](/use-cases/observability/clickstack/integrations/nginx#demo-dataset).
39
39
40
40
##### Prerequisites {#prerequisites}
41
41
- ClickStack instance running
42
-
- Existing nginx installation
43
-
- Access to modify nginx configuration files
42
+
- Existing Nginx installation
43
+
- Access to modify Nginx configuration files
44
44
45
45
<VerticalStepperheaderLevel="h4">
46
46
47
-
#### Configure nginx log format {#configure-nginx}
48
-
First, configure nginx to output logs in JSON format for easier parsing. Add this log format definition to your nginx.conf:
47
+
#### Configure Nginx log format {#configure-nginx}
48
+
First, configure Nginx to output logs in JSON format for easier parsing. Add this log format definition to your nginx.conf:
- Extracts and preserves the original log timestamps
120
-
- Adds source: nginx attribute for filtering in HyperDX
120
+
- Adds source: Nginx attribute for filtering in HyperDX
121
121
- Routes logs to the ClickHouse exporter via a dedicated pipeline
122
122
123
123
:::note
124
124
- You only define new receivers and pipelines in the custom config
125
125
- The processors (memory_limiter, transform, batch) and exporters (clickhouse) are already defined in the base ClickStack configuration - you just reference them by name
126
-
- The time_parser operator extracts timestamps from nginx's time_local field to preserve original log timing
126
+
- The time_parser operator extracts timestamps from Nginx's time_local field to preserve original log timing
127
127
- The pipelines route data from your receivers to the ClickHouse exporter via the existing processors
128
128
:::
129
129
@@ -133,7 +133,7 @@ To enable custom collector configuration in your existing ClickStack deployment,
133
133
134
134
1. Mount the custom config file at /etc/otelcol-contrib/custom.config.yaml
135
135
2. Set the environment variable CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml
136
-
3. Mount your nginx log directories so the collector can read them
136
+
3. Mount your Nginx log directories so the collector can read them
137
137
138
138
##### Option 1: Docker Compose {#docker-compose}
139
139
@@ -268,7 +268,7 @@ If you don't see logs, ensure the time range is set to 2025-10-20 11:00:00 - 202
268
268
269
269
## Dashboards and visualization {#dashboards}
270
270
271
-
To help you get started monitoring nginx with ClickStack, we provide essential visualizations for nginx logs.
271
+
To help you get started monitoring nginx with ClickStack, we provide essential visualizations for Nginx Logs.
@@ -17,41 +17,41 @@ import example_dashboard from '@site/static/images/clickstack/nginx-traces-dashb
17
17
import view_traces from '@site/static/images/clickstack/nginx-traces-search-view.png';
18
18
import { TrackedLink } from '@site/src/components/GalaxyTrackedLink/GalaxyTrackedLink';
19
19
20
-
# Monitoring nginx traces with ClickStack {#nginx-traces-clickstack}
20
+
# Monitoring Nginx Traces with ClickStack {#nginx-traces-clickstack}
21
21
22
22
:::note[TL;DR]
23
-
This guide shows you how to capture distributed traces from your existing nginx installation and visualize them in ClickStack. You'll learn how to:
23
+
This guide shows you how to capture distributed traces from your existing Nginx installation and visualize them in ClickStack. You'll learn how to:
24
24
25
-
- Add the OpenTelemetry module to nginx
26
-
- Configure nginx to send traces to ClickStack's OTLP endpoint
25
+
- Add the OpenTelemetry module to Nginx
26
+
- Configure Nginx to send traces to ClickStack's OTLP endpoint
27
27
- Verify traces are appearing in HyperDX
28
28
- Use a pre-built dashboard to visualize request performance (latency, errors, throughput)
29
29
30
-
A demo dataset with sample traces is available if you want to test the integration before configuring your production nginx.
30
+
A demo dataset with sample traces is available if you want to test the integration before configuring your production Nginx.
31
31
32
32
Time Required: 5-10 minutes
33
33
::::
34
34
35
-
## Integration with existing nginx {#existing-nginx}
35
+
## Integration with existing Nginx {#existing-nginx}
36
36
37
-
This section covers adding distributed tracing to your existing nginx installation by installing the OpenTelemetry module and configuring it to send traces to ClickStack.
37
+
This section covers adding distributed tracing to your existing Nginx installation by installing the OpenTelemetry module and configuring it to send traces to ClickStack.
38
38
If you would like to test the integration before configuring your own existing setup, you can test with our preconfigured setup and sample data in the [following section](/use-cases/observability/clickstack/integrations/nginx-traces#demo-dataset).
39
39
40
40
##### Prerequisites {#prerequisites}
41
41
- ClickStack instance running with OTLP endpoints accessible (ports 4317/4318)
42
-
- Existing nginx installation (version 1.18 or higher)
43
-
- Root or sudo access to modify nginx configuration
42
+
- Existing Nginx installation (version 1.18 or higher)
43
+
- Root or sudo access to modify Nginx configuration
The easiest way to add tracing to nginx is using the official nginx image with OpenTelemetry support built-in.
50
+
The easiest way to add tracing to Nginx is using the official Nginx image with OpenTelemetry support built-in.
51
51
52
52
##### Using the nginx:otel image {#using-otel-image}
53
53
54
-
Replace your current nginx image with the OpenTelemetry-enabled version:
54
+
Replace your current Nginx image with the OpenTelemetry-enabled version:
55
55
56
56
```yaml
57
57
# In your docker-compose.yml or Dockerfile
@@ -61,10 +61,10 @@ image: nginx:1.27-otel
61
61
This image includes the `ngx_otel_module.so` pre-installed and ready to use.
62
62
63
63
:::note
64
-
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.
64
+
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.
65
65
:::
66
66
67
-
#### Configure nginx to send traces to ClickStack {#configure-nginx}
67
+
#### Configure Nginx to send traces to ClickStack {#configure-nginx}
68
68
69
69
Add OpenTelemetry configuration to your `nginx.conf` file. The configuration loads the module and directs traces to ClickStack's OTLP endpoint.
70
70
@@ -116,7 +116,7 @@ http {
116
116
}
117
117
```
118
118
119
-
If running nginx in Docker, pass the environment variable to the container:
119
+
If running Nginx in Docker, pass the environment variable to the container:
120
120
121
121
```yaml
122
122
services:
@@ -131,15 +131,15 @@ services:
131
131
Replace `<clickstack-host>` with your ClickStack instance hostname or IP address.
132
132
133
133
:::note
134
-
- **Port 4317** is the gRPC endpoint used by the nginx module
135
-
- **otel_service_name** should be descriptive of your nginx instance (e.g., "api-gateway", "frontend-proxy")
134
+
- **Port 4317** is the gRPC endpoint used by the Nginx module
135
+
- **otel_service_name** should be descriptive of your Nginx instance (e.g., "api-gateway", "frontend-proxy")
136
136
- Change **otel_service_name** to match your environment for easier identification in HyperDX
137
137
:::
138
138
139
139
##### Understanding the configuration {#understanding-configuration}
140
140
141
141
**What gets traced:**
142
-
Each request to nginx creates a trace span showing:
142
+
Each request to Nginx creates a trace span showing:
143
143
- Request method and path
144
144
- HTTP status code
145
145
- Request duration
@@ -148,12 +148,12 @@ Each request to nginx creates a trace span showing:
148
148
**Span attributes:**
149
149
The `otel_span_attr` directives add metadata to each trace, allowing you to filter and analyze requests in HyperDX by status code, method, route, etc.
150
150
151
-
After making these changes, test your nginx configuration:
151
+
After making these changes, test your Nginx configuration:
152
152
```bash
153
153
nginx -t
154
154
```
155
155
156
-
If the test passes, reload nginx:
156
+
If the test passes, reload Nginx:
157
157
```bash
158
158
# For Docker
159
159
docker-compose restart nginx
@@ -172,7 +172,7 @@ Once configured, log into HyperDX and verify traces are flowing, you should see
172
172
173
173
## Demo dataset {#demo-dataset}
174
174
175
-
For users who want to test the nginx trace integration before configuring their production systems, we provide a sample dataset of pre-generated nginx traces with realistic traffic patterns.
175
+
For users who want to test the nginx trace integration before configuring their production systems, we provide a sample dataset of pre-generated Nginx Traces with realistic traffic patterns.
description: 'Monitoring Redis logs with ClickStack'
7
+
description: 'Monitoring Redis Logs with ClickStack'
8
8
doc_type: 'guide'
9
9
---
10
10
@@ -17,14 +17,14 @@ import log_view from '@site/static/images/clickstack/redis/redis-log-view.png';
17
17
import log from '@site/static/images/clickstack/redis/redis-log.png';
18
18
import { TrackedLink } from '@site/src/components/GalaxyTrackedLink/GalaxyTrackedLink';
19
19
20
-
# Monitoring Redis logs with ClickStack {#redis-clickstack}
20
+
# Monitoring Redis Logs with ClickStack {#redis-clickstack}
21
21
22
22
:::note[TL;DR]
23
23
This guide shows you how to monitor Redis with ClickStack by configuring the OpenTelemetry collector to ingest Redis server logs. You'll learn how to:
24
24
25
25
- Configure the OTel collector to parse the Redis log format
26
26
- Deploy ClickStack with your custom configuration
27
-
- Use a pre-built dashboard to visualize Redis metrics (connections, commands, memory, errors)
27
+
- Use a pre-built dashboard to visualize Redis Metrics (connections, commands, memory, errors)
28
28
29
29
A demo dataset with sample logs is available if you want to test the integration before configuring your production Redis.
30
30
@@ -118,15 +118,15 @@ service:
118
118
```
119
119
120
120
This configuration:
121
-
- Reads Redis logs from their standard location
121
+
- Reads Redis Logs from their standard location
122
122
- Parses Redis's log format using regex to extract structured fields (`pid`, `role`, `timestamp`, `log_level`, `message`)
123
123
- Adds `source: redis` attribute for filtering in HyperDX
124
124
- Routes logs to the ClickHouse exporter via a dedicated pipeline
125
125
126
126
:::note
127
127
- You only define new receivers and pipelines in the custom config
128
128
- The processors (`memory_limiter`, `transform`, `batch`) and exporters (`clickhouse`) are already defined in the base ClickStack configuration - you just reference them by name
129
-
- The `time_parser` operator extracts timestamps from Redis logs to preserve original log timing
129
+
- The `time_parser` operator extracts timestamps from Redis Logs to preserve original log timing
130
130
- This configuration uses `start_at: beginning` to read all existing logs when the collector starts, allowing you to see logs immediately. For production deployments where you want to avoid re-ingesting logs on collector restarts, change to `start_at: end`.
131
131
:::
132
132
@@ -182,7 +182,7 @@ Once configured, log into HyperDX and verify that logs are flowing:
182
182
183
183
## Demo dataset {#demo-dataset}
184
184
185
-
For users who want to test the Redis integration before configuring their production systems, we provide a sample dataset of pre-generated Redis logs with realistic patterns.
185
+
For users who want to test the Redis integration before configuring their production systems, we provide a sample dataset of pre-generated Redis Logs with realistic patterns.
186
186
187
187
<VerticalStepper headerLevel="h4">
188
188
@@ -272,7 +272,7 @@ If you don't see logs, ensure the time range is set to 2025-10-27 10:00:00 - 202
272
272
273
273
## Dashboards and visualization {#dashboards}
274
274
275
-
To help you get started monitoring Redis with ClickStack, we provide essential visualizations for Redis logs.
275
+
To help you get started monitoring Redis with ClickStack, we provide essential visualizations for Redis Logs.
0 commit comments