Skip to content

Metrics & Monitoring Extension App API Package

nautobot_capacity_metrics.api

REST API module for nautobot_capacity_metrics app.

urls

Django URL patterns for nautobot_capacity_metrics app.

views

Django views for Prometheus metric collection and reporting.

AppMetricsCollector

Collector class for collecting app and extras application metrics.

Source code in nautobot_capacity_metrics/api/views.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
class AppMetricsCollector:
    """Collector class for collecting app and extras application metrics."""

    def collect(self):
        """Collect metrics for all apps and extras."""
        start = time.time()

        if "gitrepositories" in PLUGIN_SETTINGS and PLUGIN_SETTINGS["gitrepositories"]:
            for metric in metric_jobs(type_of_job="git_repository"):
                yield metric

        if "jobs" in PLUGIN_SETTINGS and PLUGIN_SETTINGS["jobs"]:
            for metric in metric_jobs(type_of_job="job"):
                yield metric

        if "models" in PLUGIN_SETTINGS:
            for metric in metric_models(PLUGIN_SETTINGS["models"]):
                yield metric

        if "versions" in PLUGIN_SETTINGS and (
            PLUGIN_SETTINGS["versions"]["basic"] or PLUGIN_SETTINGS["versions"]["plugins"]
        ):
            for metric in metric_versions():
                yield metric

        # --------------------------------------------------------------
        # Extras Function defined in configuration.py or the Regristry
        # # --------------------------------------------------------------
        if "extras" in PLUGIN_SETTINGS:
            for metric in collect_extras_metric(PLUGIN_SETTINGS["extras"]):
                yield metric

        for metric in collect_extras_metric(__REGISTRY__):
            yield metric

        gauge = GaugeMetricFamily(
            "nautobot_app_metrics_processing_ms", "Time in ms to generate the app metrics endpoint"
        )
        duration = time.time() - start
        gauge.add_metric([], format(duration * 1000, ".5f"))
        yield gauge
collect()

Collect metrics for all apps and extras.

Source code in nautobot_capacity_metrics/api/views.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def collect(self):
    """Collect metrics for all apps and extras."""
    start = time.time()

    if "gitrepositories" in PLUGIN_SETTINGS and PLUGIN_SETTINGS["gitrepositories"]:
        for metric in metric_jobs(type_of_job="git_repository"):
            yield metric

    if "jobs" in PLUGIN_SETTINGS and PLUGIN_SETTINGS["jobs"]:
        for metric in metric_jobs(type_of_job="job"):
            yield metric

    if "models" in PLUGIN_SETTINGS:
        for metric in metric_models(PLUGIN_SETTINGS["models"]):
            yield metric

    if "versions" in PLUGIN_SETTINGS and (
        PLUGIN_SETTINGS["versions"]["basic"] or PLUGIN_SETTINGS["versions"]["plugins"]
    ):
        for metric in metric_versions():
            yield metric

    # --------------------------------------------------------------
    # Extras Function defined in configuration.py or the Regristry
    # # --------------------------------------------------------------
    if "extras" in PLUGIN_SETTINGS:
        for metric in collect_extras_metric(PLUGIN_SETTINGS["extras"]):
            yield metric

    for metric in collect_extras_metric(__REGISTRY__):
        yield metric

    gauge = GaugeMetricFamily(
        "nautobot_app_metrics_processing_ms", "Time in ms to generate the app metrics endpoint"
    )
    duration = time.time() - start
    gauge.add_metric([], format(duration * 1000, ".5f"))
    yield gauge

AppMetricsView(request)

Exports /api/plugins/capacity-metrics/app-metrics as a Django view.

Source code in nautobot_capacity_metrics/api/views.py 
66
67
68
69
70
71
72
def AppMetricsView(request):  # pylint: disable=invalid-name
    """Exports /api/plugins/capacity-metrics/app-metrics as a Django view."""
    registry = CollectorRegistry()
    collector = AppMetricsCollector()
    registry.register(collector)
    metrics_page = prometheus_client.generate_latest(registry)
    return HttpResponse(metrics_page, content_type=prometheus_client.CONTENT_TYPE_LATEST)