Skip to content

Update metrics docs, add run-container guide #352

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 28 commits into from
Apr 14, 2025
Merged

Update metrics docs, add run-container guide #352

merged 28 commits into from
Apr 14, 2025

Conversation

nginx-seanmoloney
Copy link
Contributor

Proposed changes

  • Added doc to show user how to run the agent within a contaner
  • Removed obsolete OTel files
  • Updated Exporting Metrics with NGINX Agent

Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.

If this PR addresses an issue on GitHub, ensure that you link to it here:

Closes #ISSUE

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content. ↩

@nginx-seanmoloney nginx-seanmoloney requested a review from a team as a code owner April 2, 2025 15:15
@github-actions github-actions bot added documentation Improvements or additions to documentation product/agent NGINX Agent labels Apr 2, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 2, 2025

✅ Deploy Preview will be available once build job completes!

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

ADubhlaoich
ADubhlaoich reviewed Apr 2, 2025
View reviewed changes
Copy link
Contributor

@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.

Could do with more work to fit our general conventions: I can provide more feedback tomorrow if an another TW doesn't cover it in the interim period

JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
JTorreG
JTorreG reviewed Apr 2, 2025
View reviewed changes
@JTorreG JTorreG marked this pull request as draft April 3, 2025 13:36
@JTorreG
Copy link
Contributor

JTorreG commented Apr 3, 2025

Could do with more work to fit our general conventions: I can provide more feedback tomorrow if an another TW doesn't cover it in the interim period

Hi @ADubhlaoich , This is an early draft not ready for general review.

JTorreG
JTorreG reviewed Apr 3, 2025
View reviewed changes
nginx-seanmoloney and others added 17 commits April 7, 2025 14:42
@nginx-seanmoloney @ADubhlaoich
Apply suggestion to use correct note element
b5d1854 
Co-authored-by: Alan Dooley <[email protected]>
@nginx-seanmoloney @JTorreG
Apply suggestion
af7c5b7 
Co-authored-by: Jon Torre <[email protected]>
@nginx-seanmoloney @JTorreG
Apply suggestion
99daffb 
Co-authored-by: Jon Torre <[email protected]>
@nginx-seanmoloney @JTorreG
Update content/agent/how-to/run-agent-container.md
6a40c4d 
Co-authored-by: Jon Torre <[email protected]>
@nginx-seanmoloney @JTorreG
Update content/agent/how-to/run-agent-container.md
6302f0e 
Co-authored-by: Jon Torre <[email protected]>
@nginx-seanmoloney @JTorreG
Update content/agent/how-to/run-agent-container.md
cf726ce 
Co-authored-by: Jon Torre <[email protected]>
@nginx-seanmoloney @JTorreG
Update content/agent/how-to/run-agent-container.md
683c2ea 
Co-authored-by: Jon Torre <[email protected]>
@nginx-seanmoloney @JTorreG
Update content/agent/otel/configure-otel-metrics.md
20a940e 
Co-authored-by: Jon Torre <[email protected]>
@nginx-seanmoloney @JTorreG
Update content/agent/otel/configure-otel-metrics.md
dc76859 
Co-authored-by: Jon Torre <[email protected]>
@nginx-seanmoloney @JTorreG
Update content/agent/otel/configure-otel-metrics.md
ee50b27 
Co-authored-by: Jon Torre <[email protected]>
@nginx-seanmoloney @JTorreG
Update content/agent/otel/configure-otel-metrics.md
2b2c581 
Co-authored-by: Jon Torre <[email protected]>
@nginx-seanmoloney @JTorreG
Update content/agent/otel/configure-otel-metrics.md
07dbd71 
Co-authored-by: Jon Torre <[email protected]>
@nginx-seanmoloney @JTorreG
Update content/agent/otel/configure-otel-metrics.md
c8c3e3a 
Co-authored-by: Jon Torre <[email protected]>
@nginx-seanmoloney @JTorreG
Update content/agent/otel/configure-otel-metrics.md
ff61880 
Co-authored-by: Jon Torre <[email protected]>
@nginx-seanmoloney @JTorreG
Update content/agent/otel/configure-otel-metrics.md
49c039d 
Co-authored-by: Jon Torre <[email protected]>
@nginx-seanmoloney
docs: Change Container to container, based on PR feedback
03f08f5
@JTorreG
Merge branch 'agent-release-3.0' into update-export-metrics-docs
341d617
@nginx-seanmoloney nginx-seanmoloney marked this pull request as ready for review April 7, 2025 14:26
@JTorreG JTorreG requested review from mjang and ADubhlaoich April 7, 2025 14:28
y82
y82 approved these changes Apr 7, 2025
View reviewed changes
mjang
mjang reviewed Apr 7, 2025
View reviewed changes
Copy link
Contributor

@mjang mjang left a comment

Choose a reason for hiding this comment

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

Mostly formatting comments

@JTorreG JTorreG requested a review from mjang April 8, 2025 12:23
@JTorreG
Copy link
Contributor

JTorreG commented Apr 8, 2025

@mjang I have improved the layout, please re-review

@JTorreG JTorreG merged commit 7b76e79 into agent-release-3.0 Apr 14, 2025
6 checks passed
@JTorreG JTorreG deleted the update-export-metrics-docs branch April 14, 2025 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JTorreG JTorreG JTorreG left review comments

@y82 y82 y82 approved these changes

@ADubhlaoich ADubhlaoich Awaiting requested review from ADubhlaoich

@mjang mjang Awaiting requested review from mjang

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation product/agent NGINX Agent
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@nginx-seanmoloney @JTorreG @ADubhlaoich @mjang @y82