generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 118
feat: Add custom OTel configuration section #1261
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
aphralG
wants to merge
4
commits into
main
Choose a base branch
from
agent/add-custom-otel-configuration
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+193
−0
Draft
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -39,3 +39,196 @@ You can validate that metrics are successfully exported by using the methods bel | |||||
```text | ||||||
Everything is ready. Begin running and processing data. | ||||||
``` | ||||||
|
||||||
### 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 | ||||||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
the last config in the list will take priority over others listed if they have the same value configured. | ||||||
|
||||||
To have NGINX Agent use your own OpenTelemetry config: | ||||||
|
||||||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
```yaml | ||||||
collector: | ||||||
additional_config_paths: | ||||||
- "/my_config.yaml" | ||||||
``` | ||||||
|
||||||
### Example usage: | ||||||
|
||||||
{{< call-out "important" >}} NGINX Agent uses `/default` for naming its default processors, exporters and pipelines using the same naming in your own config might cause issues with sending metrics to your management plane {{< /call-out >}} | ||||||
|
||||||
- **Add Prometheus Exporter** | ||||||
|
||||||
{{< tabs name="prometheus-exporter" >}} | ||||||
{{% tab name="NGINX Plus" %}} | ||||||
|
||||||
```yaml | ||||||
exporters: | ||||||
prometheus: | ||||||
endpoint: "127.0.0.1:5643" | ||||||
resource_to_telemetry_conversion: | ||||||
enabled: true | ||||||
|
||||||
service: | ||||||
pipelines: | ||||||
metrics/prometheus-example-pipeline: | ||||||
receivers: | ||||||
- nginxplus | ||||||
processors: | ||||||
- resource/default | ||||||
exporters: | ||||||
- prometheus | ||||||
``` | ||||||
|
||||||
{{% /tab %}} | ||||||
{{% tab name="NGINX OSS" %}} | ||||||
|
||||||
```yaml | ||||||
exporters: | ||||||
prometheus: | ||||||
endpoint: "127.0.0.1:5643" | ||||||
resource_to_telemetry_conversion: | ||||||
enabled: true | ||||||
|
||||||
service: | ||||||
pipelines: | ||||||
metrics/prometheus-example-pipeline: | ||||||
receivers: | ||||||
- nginx | ||||||
processors: | ||||||
- resource/default | ||||||
exporters: | ||||||
- prometheus | ||||||
``` | ||||||
|
||||||
{{% /tab %}} | ||||||
{{< /tabs >}} | ||||||
|
||||||
|
||||||
- **Third-party OTel Collector** | ||||||
|
||||||
{{< tabs name="third-party-collector" >}} | ||||||
{{% tab name="NGINX Plus" %}} | ||||||
|
||||||
```yaml | ||||||
exporters: | ||||||
otlp/local-collector: | ||||||
endpoint: "my-local-collector.com:443" | ||||||
timeout: 10s | ||||||
retry_on_failure: | ||||||
enabled: true | ||||||
initial_interval: 10s | ||||||
max_interval: 60s | ||||||
max_elapsed_time: 10m | ||||||
tls: | ||||||
insecure: true | ||||||
|
||||||
service: | ||||||
pipelines: | ||||||
metrics/otlp-example-pipeline: | ||||||
receivers: | ||||||
- nginxplus | ||||||
processors: | ||||||
- resource/default | ||||||
exporters: | ||||||
- otpl/local-collector | ||||||
``` | ||||||
|
||||||
{{% /tab %}} | ||||||
{{% tab name="NGINX OSS" %}} | ||||||
|
||||||
```yaml | ||||||
exporters: | ||||||
otlp/local-collector: | ||||||
endpoint: "my-local-collector.com:443" | ||||||
timeout: 10s | ||||||
retry_on_failure: | ||||||
enabled: true | ||||||
initial_interval: 10s | ||||||
max_interval: 60s | ||||||
max_elapsed_time: 10m | ||||||
tls: | ||||||
insecure: true | ||||||
|
||||||
service: | ||||||
pipelines: | ||||||
metrics/otlp-example-pipeline: | ||||||
receivers: | ||||||
- nginx | ||||||
processors: | ||||||
- resource/default | ||||||
exporters: | ||||||
- otpl/local-collector | ||||||
``` | ||||||
|
||||||
{{% /tab %}} | ||||||
{{< /tabs >}} | ||||||
|
||||||
|
||||||
- **Add Debug Exporter** | ||||||
|
||||||
{{< tabs name="debug-exporter" >}} | ||||||
{{% tab name="NGINX Plus" %}} | ||||||
|
||||||
```yaml | ||||||
exporters: | ||||||
debug: | ||||||
verbosity: detailed | ||||||
sampling_initial: 5 | ||||||
sampling_thereafter: 200 | ||||||
|
||||||
service: | ||||||
pipelines: | ||||||
metrics/debug-example-pipeline: | ||||||
receivers: | ||||||
- nginxplus | ||||||
processors: | ||||||
- resource/default | ||||||
exporters: | ||||||
- debug | ||||||
``` | ||||||
|
||||||
{{% /tab %}} | ||||||
{{% tab name="NGINX OSS" %}} | ||||||
|
||||||
```yaml | ||||||
exporters: | ||||||
debug: | ||||||
verbosity: detailed | ||||||
sampling_initial: 5 | ||||||
sampling_thereafter: 200 | ||||||
|
||||||
service: | ||||||
pipelines: | ||||||
metrics/debug-example-pipeline: | ||||||
receivers: | ||||||
- nginx | ||||||
processors: | ||||||
- resource/default | ||||||
exporters: | ||||||
- debug | ||||||
``` | ||||||
|
||||||
{{% /tab %}} | ||||||
{{< /tabs >}} | ||||||
|
||||||
|
||||||
|
||||||
### 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 | ||||||
|
||||||
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` |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.