feat: Add custom OTel configuration section #1261
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
github-actions
bot
added
documentation
✅ Deploy Preview will be available once build job completes!
|
| NGINX Agent generates a default OpenTelemetry config to send metrics to your management plane located at `/etc/nginx-agent/opentelemetry-collector-agent.yaml`. An option is provided to | ||
| bring your own OpenTelemetry configs which will be merged with the NGINX Agent default config. | ||
| OpenTelemetry will merge your [OpenTelemetry Config](https://opentelemetry.io/). The order of the OpenTelemetry config files matters, |
There was a problem hiding this comment.
Suggested change
| OpenTelemetry will merge your [OpenTelemetry Config](https://opentelemetry.io/). The order of the OpenTelemetry config files matters, | |
| OpenTelemetry will merge your [OpenTelemetry Config](https://opentelemetry.io/docs/collector/configuration/). The order of the OpenTelemetry config files matters, |
| NGINX Agent generates a default OpenTelemetry config to send metrics to your management plane located at `/etc/nginx-agent/opentelemetry-collector-agent.yaml`. An option is provided to | ||
| bring your own OpenTelemetry configs which will be merged with the NGINX Agent default config. | ||
| OpenTelemetry will merge your [OpenTelemetry Config](https://opentelemetry.io/). The order of the OpenTelemetry config files matters, |
There was a problem hiding this comment.
Suggested change
| OpenTelemetry will merge your [OpenTelemetry Config](https://opentelemetry.io/). The order of the OpenTelemetry config files matters, | |
| The **order of the OpenTelemetry config files matters**, |
| 1. Edit the configuration file `sudo vim /etc/nginx-agent/nginx-agent.conf` | ||
| 2. Add the collector property | ||
There was a problem hiding this comment.
Suggested change
| 3. Save and restart the NGINX agent service `sudo systemctl restart nginx-agent` |
dhurley
reviewed
Oct 23, 2025
| - "/my_config.yaml" | ||
| ``` | ||
|
|
||
| ### Example usage: |
There was a problem hiding this comment.
Suggested change
| ### Example usage: | |
| #### Example usage |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Proposed changes
Add section to OpenTelemetry Metrics on how to use a custom OpenTelemetry config with NGINX Agent.
A new feature will be added to the Agent where a user can bring there own OpenTelemetry config which will be merged with the Agents default config. This change documents how to use this feature and how to debug any issues the user might have with it.
Checklist
Before sharing this pull request, I completed the following checklist:
Footnotes
Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content. ↩