Helidon Observe (Health & Metrics) API

naftiko: 1.0.0-alpha2
info:
  label: Helidon Observe (Health & Metrics) API
  description: Helidon provides built-in observability endpoints following the MicroProfile Health and MicroProfile Metrics
    specifications. These endpoints expose application health status, readiness, liveness, startup checks, and application/vendor/base
    metrics. In Helidon 4.x, these are served under the /observe path by default.
  tags:
  - Helidon
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: helidon
    baseUri: http://localhost:8080
    description: Helidon Observe (Health & Metrics) API HTTP API.
    resources:
    - name: observe-health
      path: /observe/health
      operations:
      - name: gethealth
        method: GET
        description: Helidon Overall health status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: observe-health-live
      path: /observe/health/live
      operations:
      - name: getliveness
        method: GET
        description: Helidon Liveness check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: observe-health-ready
      path: /observe/health/ready
      operations:
      - name: getreadiness
        method: GET
        description: Helidon Readiness check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: observe-health-started
      path: /observe/health/started
      operations:
      - name: getstartup
        method: GET
        description: Helidon Startup check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: observe-metrics
      path: /observe/metrics
      operations:
      - name: getmetrics
        method: GET
        description: Helidon All metrics
        inputParameters:
        - name: Accept
          in: header
          type: string
          description: Response format (text/plain for Prometheus, application/json for JSON)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: observe-metrics-application
      path: /observe/metrics/application
      operations:
      - name: getapplicationmetrics
        method: GET
        description: Helidon Application metrics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: observe-metrics-vendor
      path: /observe/metrics/vendor
      operations:
      - name: getvendormetrics
        method: GET
        description: Helidon Vendor metrics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: observe-metrics-base
      path: /observe/metrics/base
      operations:
      - name: getbasemetrics
        method: GET
        description: Helidon Base metrics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: observe-info
      path: /observe/info
      operations:
      - name: getinfo
        method: GET
        description: Helidon Application info
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: openapi
      path: /openapi
      operations:
      - name: getopenapi
        method: GET
        description: Helidon OpenAPI document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: helidon-rest
    description: REST adapter for Helidon Observe (Health & Metrics) API.
    resources:
    - path: /observe/health
      name: gethealth
      operations:
      - method: GET
        name: gethealth
        description: Helidon Overall health status
        call: helidon.gethealth
        outputParameters:
        - type: object
          mapping: $.
    - path: /observe/health/live
      name: getliveness
      operations:
      - method: GET
        name: getliveness
        description: Helidon Liveness check
        call: helidon.getliveness
        outputParameters:
        - type: object
          mapping: $.
    - path: /observe/health/ready
      name: getreadiness
      operations:
      - method: GET
        name: getreadiness
        description: Helidon Readiness check
        call: helidon.getreadiness
        outputParameters:
        - type: object
          mapping: $.
    - path: /observe/health/started
      name: getstartup
      operations:
      - method: GET
        name: getstartup
        description: Helidon Startup check
        call: helidon.getstartup
        outputParameters:
        - type: object
          mapping: $.
    - path: /observe/metrics
      name: getmetrics
      operations:
      - method: GET
        name: getmetrics
        description: Helidon All metrics
        call: helidon.getmetrics
        outputParameters:
        - type: object
          mapping: $.
    - path: /observe/metrics/application
      name: getapplicationmetrics
      operations:
      - method: GET
        name: getapplicationmetrics
        description: Helidon Application metrics
        call: helidon.getapplicationmetrics
        outputParameters:
        - type: object
          mapping: $.
    - path: /observe/metrics/vendor
      name: getvendormetrics
      operations:
      - method: GET
        name: getvendormetrics
        description: Helidon Vendor metrics
        call: helidon.getvendormetrics
        outputParameters:
        - type: object
          mapping: $.
    - path: /observe/metrics/base
      name: getbasemetrics
      operations:
      - method: GET
        name: getbasemetrics
        description: Helidon Base metrics
        call: helidon.getbasemetrics
        outputParameters:
        - type: object
          mapping: $.
    - path: /observe/info
      name: getinfo
      operations:
      - method: GET
        name: getinfo
        description: Helidon Application info
        call: helidon.getinfo
        outputParameters:
        - type: object
          mapping: $.
    - path: /openapi
      name: getopenapi
      operations:
      - method: GET
        name: getopenapi
        description: Helidon OpenAPI document
        call: helidon.getopenapi
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    port: 9090
    namespace: helidon-mcp
    transport: http
    description: MCP adapter for Helidon Observe (Health & Metrics) API for AI agent use.
    tools:
    - name: gethealth
      description: Helidon Overall health status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: helidon.gethealth
      outputParameters:
      - type: object
        mapping: $.
    - name: getliveness
      description: Helidon Liveness check
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: helidon.getliveness
      outputParameters:
      - type: object
        mapping: $.
    - name: getreadiness
      description: Helidon Readiness check
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: helidon.getreadiness
      outputParameters:
      - type: object
        mapping: $.
    - name: getstartup
      description: Helidon Startup check
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: helidon.getstartup
      outputParameters:
      - type: object
        mapping: $.
    - name: getmetrics
      description: Helidon All metrics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: helidon.getmetrics
      outputParameters:
      - type: object
        mapping: $.
    - name: getapplicationmetrics
      description: Helidon Application metrics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: helidon.getapplicationmetrics
      outputParameters:
      - type: object
        mapping: $.
    - name: getvendormetrics
      description: Helidon Vendor metrics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: helidon.getvendormetrics
      outputParameters:
      - type: object
        mapping: $.
    - name: getbasemetrics
      description: Helidon Base metrics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: helidon.getbasemetrics
      outputParameters:
      - type: object
        mapping: $.
    - name: getinfo
      description: Helidon Application info
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: helidon.getinfo
      outputParameters:
      - type: object
        mapping: $.
    - name: getopenapi
      description: Helidon OpenAPI document
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: helidon.getopenapi
      outputParameters:
      - type: object
        mapping: $.