Service Mesh Interface (SMI)

SMI Traffic Metrics

Traffic Metrics is "a resource that provides a common integration point for tools that can benefit by consuming metrics related to HTTP traffic." It is exposed as a Kubernetes APIService extension at `metrics.smi-spec.io/v1alpha1` and reports latency percentiles (p50/p90/p99) and success/failure counts per pod, deployment, namespace, or traffic edge.

SMI Traffic Metrics is one of 4 APIs that Service Mesh Interface (SMI) publishes on the APIs.io network.

This API exposes 1 JSON Schema definition.

Tagged areas include Traffic Metrics, Observability, Telemetry, Kubernetes APIService, and SMI. The published artifact set on APIs.io includes sample payloads and 1 JSON Schema.

GitHub

Examples

📝
Example
https://raw.githubusercontent.com/api-evangelist/service-mesh-interface/refs/heads/main/./examples/traffic-metrics-example.json

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/service-mesh-interface/refs/heads/main/./json-schema/traffic-metrics-schema.json

Other Resources

🔗
APIVersion
🔗
Kind
🔗
Kind
🔗
Specification
https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-metrics/v1alpha1/traffic-metrics.md
🔗
ReferenceImplementation
https://github.com/servicemeshinterface/smi-metrics

API entry from apis.yml

apis.yml Raw ↑ 
name: SMI Traffic Metrics
description: 'Traffic Metrics is "a resource that provides a common integration point for tools

  that can benefit by consuming metrics related to HTTP traffic." It is exposed as a

  Kubernetes APIService extension at `metrics.smi-spec.io/v1alpha1` and reports

  latency percentiles (p50/p90/p99) and success/failure counts per pod, deployment,

  namespace, or traffic edge.

  '
humanURL: https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-metrics/v1alpha1/traffic-metrics.md
baseURL: https://kubernetes.default.svc/apis/metrics.smi-spec.io/v1alpha1
aid: smi-traffic-metrics
tags:
- Traffic Metrics
- Observability
- Telemetry
- Kubernetes APIService
- SMI
properties:
- type: APIVersion
  name: metrics.smi-spec.io/v1alpha1
- type: Kind
  name: TrafficMetrics
- type: Kind
  name: TrafficMetricsList
- type: Specification
  url: https://github.com/servicemeshinterface/smi-spec/blob/main/apis/traffic-metrics/v1alpha1/traffic-metrics.md
- type: ReferenceImplementation
  url: https://github.com/servicemeshinterface/smi-metrics
- type: JSONSchema
  url: ./json-schema/traffic-metrics-schema.json
- type: Example
  url: ./examples/traffic-metrics-example.json
operations:
- method: GET
  endpoint: /apis/metrics.smi-spec.io/v1alpha1/namespaces/{namespace}/pods
- method: GET
  endpoint: /apis/metrics.smi-spec.io/v1alpha1/namespaces/{namespace}/pods/{name}
- method: GET
  endpoint: /apis/metrics.smi-spec.io/v1alpha1/namespaces/{namespace}/pods/{name}/edges
- method: GET
  endpoint: /apis/metrics.smi-spec.io/v1alpha1/namespaces/{namespace}/deployments
- method: GET
  endpoint: /apis/metrics.smi-spec.io/v1alpha1/namespaces/{namespace}/deployments/{name}
- method: GET
  endpoint: /apis/metrics.smi-spec.io/v1alpha1/namespaces/{namespace}/deployments/{name}/edges
- method: GET
  endpoint: /apis/metrics.smi-spec.io/v1alpha1/namespaces