openapi: 3.0.3
info:
  title: Akri Metrics API
  description: Prometheus metrics endpoint exposed by Akri Agent, Controller, and broker pods. Metrics include instance count, discovery response results and latency, and broker pod count for monitoring Akri deployments.
  version: 0.12.20
  contact:
    name: Akri Community
    url: https://github.com/project-akri/akri
  license:
    name: Apache 2.0
    url: https://github.com/project-akri/akri/blob/main/LICENSE
  x-generated-from: documentation
servers:
- url: http://localhost:8080
  description: Akri Agent/Controller metrics server (default port)
tags:
- name: Metrics
  description: Prometheus metrics endpoints for Akri Agent, Controller, and broker pods
paths:
  /metrics:
    get:
      operationId: getMetrics
      summary: Akri Get Prometheus Metrics
      description: Returns Prometheus-formatted metrics for the Akri Agent, Controller, or broker pods. Includes instance discovery counts, discovery response results, discovery latency histograms, and broker pod counts.
      tags:
      - Metrics
      responses:
        '200':
          description: Prometheus metrics in text exposition format
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/PrometheusMetrics'
              examples:
                GetMetrics200Example:
                  summary: Default getMetrics 200 response
                  x-microcks-default: true
                  value: '# HELP akri_instance_count Number of discovered Akri instances

                    # TYPE akri_instance_count gauge

                    akri_instance_count{configuration="onvif-camera",shared="false"} 3

                    # HELP akri_discovery_response_result Discovery handler response results

                    # TYPE akri_discovery_response_result counter

                    akri_discovery_response_result{configuration="onvif-camera",result="success"} 42

                    # HELP akri_discovery_response_time Discovery handler response latency

                    # TYPE akri_discovery_response_time histogram

                    akri_discovery_response_time_bucket{configuration="onvif-camera",le="0.005"} 10

                    # HELP akri_broker_pod_count Number of broker pods deployed

                    # TYPE akri_broker_pod_count gauge

                    akri_broker_pod_count{configuration="onvif-camera",node="node-01"} 1

                    '
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    PrometheusMetrics:
      title: PrometheusMetrics
      type: string
      description: Prometheus text exposition format containing Akri metrics. Includes akri_instance_count (gauge), akri_discovery_response_result (counter), akri_discovery_response_time (histogram), and akri_broker_pod_count (gauge) plus standard process metrics.
      example: '# HELP akri_instance_count Number of discovered Akri instances

        # TYPE akri_instance_count gauge

        akri_instance_count{configuration="onvif-camera",shared="false"} 3

        '