Timber

Vector Observability API

Vector ships with a local gRPC API that lets you interact with a running Vector instance — inspect component topology, read internal metrics and health, and tap live events flowing through the pipeline. It is disabled by default (api.enabled=false) and binds to 127.0.0.1:8686. The API has no authentication and is intended for isolated/debugging environments only; it must not be exposed to untrusted clients. A GET /health HTTP healthcheck is served on the same port for compatibility with existing HTTP probes.

GitHub

Documentation

📖
Documentation
https://vector.dev/docs/reference/api/

Other Resources

🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/timber/refs/heads/main/grpc/timber-observability.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/timber/refs/heads/main/grpc/timber-vector.proto
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/timber/refs/heads/main/apis.yml

API entry from apis.yml

apis.yml Raw ↑ 
name: Vector Observability API
description: Vector ships with a local gRPC API that lets you interact with a running Vector instance
  — inspect component topology, read internal metrics and health, and tap live events flowing through
  the pipeline. It is disabled by default (api.enabled=false) and binds to 127.0.0.1:8686. The API has
  no authentication and is intended for isolated/debugging environments only; it must not be exposed to
  untrusted clients. A GET /health HTTP healthcheck is served on the same port for compatibility with
  existing HTTP probes.
humanURL: https://vector.dev/docs/reference/api/
baseURL: https://vector.dev
properties:
- type: Documentation
  url: https://vector.dev/docs/reference/api/
- type: Protobuf
  url: grpc/timber-observability.proto
- type: Protobuf
  url: grpc/timber-vector.proto