Skip to content

NGF: Update control data plane split telemetry #485

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

Merged

Conversation

bjee19
Copy link
Contributor

@bjee19 bjee19 commented Apr 30, 2025

Proposed changes

Update docs for CP/DP split telemetry changes.

Problem: Some small docs changes are needed for the new telemetry metrics/changes introduced with the control data plane split.

Solution: Add the new metrics. Also updated the data plane configuration document small error of including the namespace field in the gateway.infrastructure.parametersRef field since that does not exist: https://gateway-api.sigs.k8s.io/reference/spec/#localparametersreference.

Note: Left out GatewayAttachedNginxProxies in the document since I think it falls under the "we collect a count of NginxProxies"

Testing:

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.

@bjee19 bjee19 requested a review from a team as a code owner April 30, 2025 21:46
@github-actions github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels Apr 30, 2025
@bjee19 bjee19 requested a review from a team April 30, 2025 21:47
@bjee19 bjee19 merged commit 707e7df into nginx:ngf-feature-cp-dp-split May 1, 2025
6 checks passed
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/ngf Issues related to NGINX Gateway Fabric
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants