Skip to content

Conversation

@aphralG
Copy link
Contributor

@aphralG aphralG commented Oct 6, 2025

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

  1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content.

@aphralG aphralG self-assigned this Oct 6, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation product/nginx-one Issues related to NGINX One Console labels Oct 6, 2025
@github-actions
Copy link

github-actions bot commented Oct 6, 2025

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/1261/

@aphralG aphralG marked this pull request as ready for review November 4, 2025 11:29
@aphralG aphralG requested a review from a team as a code owner November 4, 2025 11:29
@JTorreG JTorreG requested a review from a team November 6, 2025 17:15
aphralG and others added 3 commits November 7, 2025 14:29
Co-authored-by: Jon Torre <78599298+JTorreG@users.noreply.github.com>
Co-authored-by: Donal Hurley <d.hurley@f5.com>
Copy link
Member

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally LGTM.

Some inconsistencies in style and a lot of Markdown issues that could have been picked up by our Linting tools.

I recommend setting up pre-commit as these will eventually be enforced by the CI/CD pipeline.


{{% /tab %}}
{{< /tabs >}}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

Excess empty line.

{{% /tab %}}
{{< /tabs >}}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

Excess empty line

Comment on lines 222 to 223
Copy link
Member

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 and others added 5 commits November 10, 2025 13:58
Co-authored-by: Alan Dooley <a.dooley@f5.com>
- Refined the overview section for improved readability and clarity.
  - Clearly identified default behavior (metrics sent to NGINX One Console).
  - Added links to relevant NGINX One documentation.
- Improved Docker command formatting for readability and ease of use.
- Expanded troubleshooting section to include example failure log entries.
- Fixed minor formatting issues and typos (e.g., parenthesis, capitalization in section titles).
- Added inline comments and additional details for configuration steps.
@github-actions github-actions bot added the product/agent Issues related to NGINX Agent label Nov 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation product/agent Issues related to NGINX Agent product/nginx-one Issues related to NGINX One Console

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants