TiKV Metrics API

openapi: 3.1.0
info:
  title: TiKV HTTP Management Configuration Metrics API
  description: TiKV exposes an HTTP management API on each node for status monitoring, configuration management, and Prometheus metrics. The default port is 20160 for TiKV nodes and 2379 for PD (Placement Driver) nodes.
  version: '7.1'
  contact:
    name: TiKV Community
    url: https://tikv.org/
  license:
    name: Apache 2.0
    url: https://github.com/tikv/tikv/blob/master/LICENSE
servers:
- url: http://localhost:20160
  description: TiKV node HTTP API (default port)
tags:
- name: Metrics
  description: Prometheus metrics endpoint
paths:
  /metrics:
    get:
      operationId: getMetrics
      summary: Get Prometheus Metrics
      description: Returns Prometheus-formatted metrics for the TiKV node including operation counts, latencies, storage usage, and Raft consensus metrics.
      tags:
      - Metrics
      responses:
        '200':
          description: Prometheus metrics returned in text format
          content:
            text/plain:
              schema:
                type: string