CRI-O Debug API

Golang debug endpoints for goroutines, heap, and profiling.

OpenAPI Specification

cri-o-debug-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: CRI-O Metrics Containers Debug API
  description: The CRI-O metrics endpoint exposes Prometheus-compatible metrics for operations, image pulls, container lifecycle, and runtime errors. Metrics are enabled with the --enable-metrics daemon flag and served on the port configured by --metrics-port (default 9090) at the /metrics path. The endpoint can also be served over a Unix socket via --metrics-socket and secured using --metrics-cert and --metrics-key for TLS.
  version: '1.0'
  contact:
    name: CRI-O Project
    url: https://cri-o.io/
  license:
    name: Apache 2.0
    url: https://github.com/cri-o/cri-o/blob/main/LICENSE
servers:
- url: http://localhost:9090
  description: Default CRI-O metrics endpoint
tags:
- name: Debug
  description: Golang debug endpoints for goroutines, heap, and profiling.
paths:
  /debug/goroutines:
    get:
      tags:
      - Debug
      operationId: getGoroutines
      summary: Dump goroutine stacks
      description: Returns the current goroutine stack traces for the daemon.
      responses:
        '200':
          description: Goroutine stack dump as plain text.
          content:
            text/plain:
              schema:
                type: string
externalDocs:
  description: CRI-O Metrics Documentation
  url: https://github.com/cri-o/cri-o/blob/main/docs/metrics.md