feat: Add custom OTel configuration section #1261
Open
+193
−0
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!
|
dhurley
reviewed
Oct 23, 2025
dhurley
approved these changes
Nov 6, 2025
| ```yaml | ||
| collector: | ||
| additional_config_paths: | ||
| - "/my_config.yaml" |
There was a problem hiding this comment.
Suggested change
| - "/my_config.yaml" | |
| - "/etc/nginx-agent/my_config.yaml" |
| prometheus: | ||
| endpoint: "127.0.0.1:5643" | ||
| resource_to_telemetry_conversion: | ||
| enabled: true |
There was a problem hiding this comment.
Suggested change
| enabled: true | |
| enabled: true | |
| namespace: test-space |
| prometheus: | ||
| endpoint: "127.0.0.1:5643" | ||
| resource_to_telemetry_conversion: | ||
| enabled: true |
There was a problem hiding this comment.
Suggested change
| enabled: true | |
| enabled: true | |
| namespace: test-space |
Comment on lines
+123
to
+130
| timeout: 10s | ||
| retry_on_failure: | ||
| enabled: true | ||
| initial_interval: 10s | ||
| max_interval: 60s | ||
| max_elapsed_time: 10m | ||
| tls: | ||
| insecure: true |
There was a problem hiding this comment.
Suggested change
| timeout: 10s | |
| retry_on_failure: | |
| enabled: true | |
| initial_interval: 10s | |
| max_interval: 60s | |
| max_elapsed_time: 10m | |
| tls: | |
| insecure: true |
Comment on lines
+150
to
+157
| timeout: 10s | ||
| retry_on_failure: | ||
| enabled: true | ||
| initial_interval: 10s | ||
| max_interval: 60s | ||
| max_elapsed_time: 10m | ||
| tls: | ||
| insecure: true |
There was a problem hiding this comment.
Suggested change
| timeout: 10s | |
| retry_on_failure: | |
| enabled: true | |
| initial_interval: 10s | |
| max_interval: 60s | |
| max_elapsed_time: 10m | |
| tls: | |
| insecure: true |
JTorreG
reviewed
Nov 6, 2025
| ### Custom OTel Configuration | ||
| 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 |
There was a problem hiding this comment.
Suggested change
| 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 | |
| NGINX Agent generates a default OpenTelemetry config (located at `/etc/nginx-agent/opentelemetry-collector-agent.yaml`) to send metrics to your management plane. An option is provided to |
JTorreG
reviewed
Nov 6, 2025
Comment on lines
+46
to
+48
| bring your own OpenTelemetry configs which will be merged with the NGINX Agent default config. | ||
| OpenTelemetry will merge your [OpenTelemetry Config](https://opentelemetry.io/docs/collector/configuration/). The **order of the OpenTelemetry config files matters**, the last config in the list will take priority over others listed if they have the same value configured. |
There was a problem hiding this comment.
this is a bit redundant (the part mentioning the config will be merged)
Suggested change
| bring your own OpenTelemetry configs which will be merged with the NGINX Agent default config. | |
| OpenTelemetry will merge your [OpenTelemetry Config](https://opentelemetry.io/docs/collector/configuration/). The **order of the OpenTelemetry config files matters**, the last config in the list will take priority over others listed if they have the same value configured. | |
| bring your own [OpenTelemetry configs](https://opentelemetry.io/docs/collector/configuration/) which will be merged with the NGINX Agent default config. | |
| The **order of the OpenTelemetry config files matters**: the last config in the list will take priority over others listed, if they have the same value configured. |
JTorreG
reviewed
Nov 6, 2025
| To have NGINX Agent use your own OpenTelemetry config: | ||
| 1. Edit the configuration file `sudo vim /etc/nginx-agent/nginx-agent.conf` |
There was a problem hiding this comment.
Suggested change
| 1. Edit the configuration file `sudo vim /etc/nginx-agent/nginx-agent.conf` | |
| 1. Edit the configuration file as root `vim /etc/nginx-agent/nginx-agent.conf` |
JTorreG
reviewed
Nov 6, 2025
| ### Troubleshooting | ||
| To view the merged OpenTelemetry configuration set the Agent log level to debug in `/etc/nginx-agent/nginx-agent.conf` and restart NGINX Agent |
There was a problem hiding this comment.
Suggested change
| To view the merged OpenTelemetry configuration set the Agent log level to debug in `/etc/nginx-agent/nginx-agent.conf` and restart NGINX Agent | |
| To view the merged OpenTelemetry configuration set the NGINX Agent log level to "debug" in `/etc/nginx-agent/nginx-agent.conf`, and restart NGINX Agent: |
JTorreG
reviewed
Nov 6, 2025
Comment on lines
+227
to
+234
| 1. Edit the configuration file `sudo vim /etc/nginx-agent/nginx-agent.conf` | ||
| 2. Change the log property | ||
| ```yaml | ||
| log: | ||
| level: debug | ||
| ``` | ||
| 3. Restart NGINX Agent | ||
| 4. View merged OpenTelemetry configuration `cat /var/lib/nginx-agent/opentelemetry-collector-agent-debug.yaml` |
There was a problem hiding this comment.
Suggested change
| 1. Edit the configuration file `sudo vim /etc/nginx-agent/nginx-agent.conf` | |
| 2. Change the log property | |
| ```yaml | |
| log: | |
| level: debug | |
| ``` | |
| 3. Restart NGINX Agent | |
| 4. View merged OpenTelemetry configuration `cat /var/lib/nginx-agent/opentelemetry-collector-agent-debug.yaml` | |
| 1. Edit the configuration file `sudo vim /etc/nginx-agent/nginx-agent.conf` | |
| 1. Change the log property | |
| ```yaml | |
| log: | |
| level: debug | |
| ``` | |
| 1. Restart NGINX Agent, run as root: | |
| ```shell | |
| systemctl restart nginx-agent | |
| ``` | |
| 1. View the merged OpenTelemetry configuration `cat /var/lib/nginx-agent/opentelemetry-collector-agent-debug.yaml` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This feature will be released in Agent 3.5 release
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. ↩