Skip to content

NGF: update nginx metrics #558

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
Open
wants to merge 1 commit into
base: ngf-feature-cp-dp-split
Choose a base branch
from
Open

NGF: update nginx metrics #558

wants to merge 1 commit into from

Conversation

sjberman
Copy link
Contributor

@sjberman sjberman commented May 16, 2025 •
edited
Loading

Agent updated some metrics names and descriptions. Updating the NGF doc that describes them.

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

@sjberman
NGF: update nginx metrics
3f6722b 
Agent updated some metrics names and descriptions. Updating the NGF doc that describes them.
@sjberman sjberman requested a review from a team May 16, 2025 14:27
@sjberman sjberman requested a review from a team as a code owner May 16, 2025 14:27
@github-actions github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels May 16, 2025
salonichf5
salonichf5 reviewed May 19, 2025
View reviewed changes
content/ngf/how-to/monitoring/prometheus.md
Comment on lines +93 to +96
- `nginx_http_connection_count_connections`: The current number of connections.
- `nginx_http_connections_total`: The total number of connections, since NGINX was last started or reloaded.
- `nginx_http_request_count_requests`: The total number of client requests received, since the last collection interval.
- `nginx_http_requests_total`: The total number of client requests received, since NGINX was last started or reloaded.
Copy link

Choose a reason for hiding this comment

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

how do we ensure these names match exactly the same on prometheus side? were do we have those settings configured for NGF?

Copy link

Choose a reason for hiding this comment

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

I know some documentation lives here:

https://github.com/nginx/agent/blob/v3/internal/collector/nginxossreceiver/documentation.md
https://github.com/nginx/agent/blob/v3/internal/collector/nginxplusreceiver/documentation.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bjee19 bjee19 bjee19 approved these changes

@ADubhlaoich ADubhlaoich ADubhlaoich approved these changes

@salonichf5 salonichf5 salonichf5 approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@sjberman @ADubhlaoich @bjee19 @salonichf5