Skip to content
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

Expose NGINX Plus dashboard #1488

Merged
merged 4 commits into from
Jan 22, 2024
Merged

Conversation

sjberman
Copy link
Contributor

Problem: As a user, I want observability into the NGINX Plus configuration and metrics.

Solution: By exposing the NGINX Plus dashboard, a user can easily visualize real-time metrics and information about the configuration.

Closes #1381

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@sjberman sjberman requested review from a team as code owners January 18, 2024 20:52
@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 18, 2024
site/content/how-to/monitoring/dashboard.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/dashboard.md Show resolved Hide resolved
internal/mode/static/nginx/conf/nginx-plus.conf Outdated Show resolved Hide resolved
internal/mode/static/nginx/conf/nginx-plus.conf Outdated Show resolved Hide resolved
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.

LGTM: I have approved but please review the feedback I have for the image's alt text.

Screenshots come with a maintenance cost: if the UI they are capturing is updated, all screenshots of it also need to be updated.

I would avoid using screenshots in the future, or document a procedure for routinely checking and updating the accuracy of screenshots in the documentation.

Copy link
Contributor

@pleshakov pleshakov left a comment

Choose a reason for hiding this comment

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

the updates look good.

does it make sense to include this port to this https://github.com/nginxinc/nginx-gateway-fabric/blob/main/site/static/img/ngf-pod.png and into architecture doc?

It it described in NIC -- https://docs.nginx.com/nginx-ingress-controller/overview/design/#the-nginx-ingress-controller-pod

@sjberman
Copy link
Contributor Author

@pleshakov Since it's only an N+ port, I hesitate to add to the image and main table. I could add a separate note to the architecture doc though that briefly describes.

Problem: As a user, I want observability into the NGINX Plus configuration and metrics.

Solution: By exposing the NGINX Plus dashboard, a user can easily visualize real-time metrics and information about the configuration.
Copy link
Contributor

@pleshakov pleshakov left a comment

Choose a reason for hiding this comment

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

👍

@sjberman sjberman merged commit 9dd2968 into nginxinc:main Jan 22, 2024
27 checks passed
@sjberman sjberman deleted the enh/nplus-dashboard branch January 22, 2024 21:01
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 enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

NGINX+ dashboard
5 participants