Skip to content

Support Authentication to Metrics Endpoint #91

@nlgotz

Description

@nlgotz

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions