generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 121
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
Open
aphralG
wants to merge
17
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.
+168
−47
Open
Changes from 4 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
08e1f5b
feat: Add custom OTel configuration section
aphralG b94a78d
feat: change section headings
aphralG 5c7c341
feat: add third party otel collector example
aphralG ddc8ae1
feat: clean up examples
aphralG 53ea4f4
Merge branch 'main' into agent/add-custom-otel-configuration
aphralG ee37fac
feat: update links and format
aphralG 003ab0d
Merge branch 'main' into agent/add-custom-otel-configuration
aphralG 93b8bbe
Merge branch 'main' into agent/add-custom-otel-configuration
aphralG 28de80a
Apply suggestions from code review
aphralG 110fbdc
Merge branch 'main' into agent/add-custom-otel-configuration
ADubhlaoich 72306ae
Merge branch 'main' into agent/add-custom-otel-configuration
ADubhlaoich 1e6b8da
Apply suggestions from code review
aphralG 26d69f6
Merge branch 'main' into agent/add-custom-otel-configuration
aphralG d1c80b0
feat: address PR feedback
aphralG e66d74b
docs: Enhance NGINX metrics export documentation
nginx-seanmoloney 8265389
Merge branch 'main' into agent/add-custom-otel-configuration
JTorreG d49f9f3
docs: move single item in section to root section
JTorreG 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, | ||||
aphralG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
aphralG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
| 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` | ||||
aphralG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
| 2. Add the collector property | ||||
|
|
||||
| ```yaml | ||||
| collector: | ||||
| additional_config_paths: | ||||
| - "/my_config.yaml" | ||||
aphralG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
| ``` | ||||
|
|
||||
| ### Example usage: | ||||
aphralG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
|
|
||||
| {{< 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** | ||||
aphralG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
|
|
||||
| {{< tabs name="prometheus-exporter" >}} | ||||
| {{% tab name="NGINX Plus" %}} | ||||
|
|
||||
| ```yaml | ||||
| exporters: | ||||
| prometheus: | ||||
| endpoint: "127.0.0.1:5643" | ||||
| resource_to_telemetry_conversion: | ||||
| enabled: true | ||||
aphralG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
|
|
||||
| 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** | ||||
aphralG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
|
|
||||
| {{< 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 | ||||
aphralG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
|
|
||||
| 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 | ||||
aphralG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
|
|
||||
| service: | ||||
| pipelines: | ||||
| metrics/otlp-example-pipeline: | ||||
| receivers: | ||||
| - nginx | ||||
| processors: | ||||
| - resource/default | ||||
| exporters: | ||||
| - otpl/local-collector | ||||
| ``` | ||||
|
|
||||
| {{% /tab %}} | ||||
| {{< /tabs >}} | ||||
|
|
||||
|
|
||||
|
||||
Excess empty line
aphralG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
aphralG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Outdated
Member
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.
Suggested change
Excess empty lines
aphralG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
aphralG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
aphralG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
aphralG marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
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.
Uh oh!
There was an error while loading. Please reload this page.