Skip to content

NGINXaaS: Add display name to metrics catalog #756

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
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

arpith-f5
Copy link
Contributor

@arpith-f5 arpith-f5 commented Jun 27, 2025

Proposed changes

Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the
following format:

Problem: Platform metrics are queried using Display Names in Azure Monitor. Add Display Names to metrics catalog for easy lookup
Solution: Add a new column for Display Name

Testing: local testing

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.

@arpith-f5 arpith-f5 requested a review from a team as a code owner June 27, 2025 23:03
@github-actions github-actions bot added documentation Improvements or additions to documentation product/nginxaas NGINX as a Service for Azure labels Jun 27, 2025
@arpith-f5
Copy link
Contributor Author

I have hereby read the F5 CLA and agree to its terms

@arpith-f5 arpith-f5 force-pushed the add_display_name branch 2 times, most recently from d805b6b to 7070c21 Compare June 27, 2025 23:53
@@ -2,14 +2,14 @@
title: Migrate from Custom metrics to Platform metrics
weight: 1000
toc: true
url: /nginxaas/azure/getting-started/migrate-to-platform-metrics/
Copy link
Contributor

Choose a reason for hiding this comment

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

do we need a redirect for this so any old links to getting-started still work?

Copy link
Contributor

Choose a reason for hiding this comment

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

if you decide you do, please request it in the docs channel in slack for the docops engineers to create it

Copy link
Contributor

Choose a reason for hiding this comment

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

future: I spot checked a few and they look right, but copilot makes me nervous. These are all supposed to match https://github.com/nginxinc/nalb-shared/blob/main/nginx/native-metrics/spec.json, right? Maybe copilot could write a script to generate these tables from that file, then we'd have something deterministic. Maybe the next time we need to change these tables.

Copy link
Contributor Author

@arpith-f5 arpith-f5 Jun 30, 2025

Choose a reason for hiding this comment

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

yes they are all supposed to match https://github.com/nginxinc/nalb-shared/blob/main/nginx/native-metrics/spec.json. I asked co-pilot to generate a script and it did a decent job but there are subtle differences in the metrics catalog that makes it hard from being generated from the spec alone. The column 'Roll-up per' is not available in the spec and there are issues with capitalization and ordering. If these need to be fixed manually then it defeats the point of having a script. Perhaps we can drop the 'Roll-up per' column in metrics catalog and change the capitalization and ordering in the spec to match the current format but I don't know if LIFTR/Geneva will like that

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/nginxaas NGINX as a Service for Azure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants