Package

nautobot_capacity_metrics

App declaration for nautobot_capacity_metrics.

NautobotCapacityMetricsConfig

Bases: NautobotAppConfig

App configuration for the nautobot_capacity_metrics app.

Source code in nautobot_capacity_metrics/__init__.py

class NautobotCapacityMetricsConfig(NautobotAppConfig):
    """App configuration for the nautobot_capacity_metrics app."""

    name = "nautobot_capacity_metrics"
    verbose_name = "Data, Metrics, and Monitoring Prometheus Endpoints"
    version = __version__
    author = "Network to Code, LLC"
    description = "Lightweight Nautobot App to expose additional metrics as Prometheus endpoints. Includes exposing Nautobot object data and metrics that can be collected and later viewed in Visualization tools."
    base_url = "capacity-metrics"
    required_settings = []
    min_version = "2.0.0"
    max_version = "2.9999"
    default_settings = {
        "app_metrics": {
            "models": {
                "dcim": {
                    "Location": True,
                    "Rack": True,
                    "Device": True,
                },
                "ipam": {"IPAddress": True, "Prefix": True},
            },
            "jobs": True,
            "queues": True,
            "versions": {
                "basic": False,
                "plugins": False,
            },
        }
    }
    caching_config = {}

register_metric_func(func)

Register an additional function to generate application metrics.

Parameters:

Name	Type	Description	Default
func	Callable	python function, taking no argument that return a list of Prometheus Metric Object	required

Source code in nautobot_capacity_metrics/__init__.py

def register_metric_func(func: Callable):
    """Register an additional function to generate application metrics.

    Args:
        func (Callable): python function, taking no argument that return a list of Prometheus Metric Object
    """
    if not callable(func):
        raise TypeError(
            f"Trying to register a {type(func)} into the application metric registry, only function (callable) are supporter"
        )

    __REGISTRY__.append(func)