Initial Version of nginx guide #4588
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
3 Skipped Deployments
|
…into clickstack-nginx-guide
…into clickstack-nginx-guide
| <VerticalStepper> | ||
|
|
||
| ## Configure nginx log format {#configure-nginx} | ||
| First, configure nginx to output logs in JSON format for easier parsing. Add this log format definition to your nginx.conf: |
There was a problem hiding this comment.
Indicate where this is often found
| - ./nginx-monitoring.yaml:/etc/otelcol-contrib/custom.config.yaml:ro | ||
| - /var/log/nginx:/var/log/nginx:ro | ||
| # ... other volumes ... | ||
| ``` |
There was a problem hiding this comment.
I think we should also provide a docker command example of doing this i.e. for the all in one image
| 1. Navigate to the Logs view | ||
| 2. Filter by source:nginx to see only nginx logs | ||
| 3. Verify you see JSON-parsed log entries with fields like request_method, request_uri, status, etc. | ||
| </VerticalStepper> |
|
|
||
| ### Custom config not loading {#troubleshooting-not-loading} | ||
|
|
||
| - Verify the environment variable CUSTOM_OTELCOL_CONFIG_FILE is set correctly |
There was a problem hiding this comment.
add simple commands to verify these
|
|
||
| ## Using the Sample Dataset {#using-data} | ||
|
|
||
| 1. [Download](../../../../../static/examples/nginx-sample-logs.json) and place the sample file in `/tmp/nginx-demo/access.log` |
There was a problem hiding this comment.
I dont think we need to be prescriptive about the location i.e. can't it just be in the folder we launch from?
| -e CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml \ | ||
| -v "$(pwd)/nginx-demo.yaml:/etc/otelcol-contrib/custom.config.yaml:ro" \ | ||
| -v /tmp/nginx-demo:/tmp/nginx-demo:ro \ | ||
| docker.hyperdx.io/hyperdx/hyperdx-all-in-one:latest |
There was a problem hiding this comment.
this wont work surely? we need to mount in the log file as well
| - Filter by `source:nginx-demo` | ||
| - Set time range to last 24 hours | ||
| - You should see ~10,000 log entries | ||
|
|
|
|
||
| You can query the data to verify patterns: | ||
|
|
||
| ```shell |
|
|
||
| ## Dashboards and visualization {#dashboards} | ||
|
|
||
| To help you get started monitoring nginx with ClickStack, we provide a pre-built dashboard with essential nginx metrics and visualizations. |
There was a problem hiding this comment.
essential visualizations for nginx logs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
nginx set up guide for clickstack
Checklist