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

Support Authentication to Metrics Endpoint #91

Open
nlgotz opened this issue Mar 21, 2024 · 0 comments · May be fixed by #94
Open

Support Authentication to Metrics Endpoint #91

nlgotz opened this issue Mar 21, 2024 · 0 comments · May be fixed by #94

Comments

@nlgotz
Copy link
Contributor

nlgotz commented Mar 21, 2024

Environment

  • Nautobot version: 2.1.5
  • nautobot-capacity-metrics version: all

Proposed Functionality

In Nautobot 2.1.5, the METRICS_AUTHENTICATED setting was added to allow for authentication to the /metrics endpoint. This proposal would be to take advantage of the METRICS_AUTHENTICATED setting and if set, require authentication for the endpoint.

The main purpose of this is so that if Nautobot is run on the internet (or even an intranet), you may be exposing data you don't want to anyone. This give the user the option to require authentication if desired.

The default state of METRICS_AUTHENTICATED is False so any existing monitoring systems will be able to still operate in the same manner.

Use Case

  • A more secure environment where the user doesn't want the /api/plugins/capacity-metrics/app-metrics endpoint accessible to unauthenticated users.
@nlgotz nlgotz linked a pull request Mar 27, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant