Skip to content

Latest commit

 

History

History
47 lines (35 loc) · 1.63 KB

observability.md

File metadata and controls

47 lines (35 loc) · 1.63 KB
Raw

Observability

Logging

This section describes logging in the Piko server.

Output

Piko uses structured logs, where logs are written to stderr formatted as JSON.

Log Levels

Each log record has a level field of either:

  • debug: Verbose logs for debugging
  • info: Important state changes
  • warn: An unexpected event occured though Piko can continue to work
  • error: An unexpected error that prevents Piko from functioning properly

The minimum level to log can be configured with --log.level.

Subsystem

Each log record has a subsystem field indicating where in the system the log occured.

All logs can be enabled for a subsystem using --log.subsystems, which overrides --log.level for the configured subsystems. Such as --log.subsystems proxy,proxy.access,gossip.

--log.subsystems enables any subsystem that are an exact match of the given list. Such as proxy will match proxy but not proxy.access.

Metrics

The Piko server exposes Prometheus on the admin port at /metrics.

Piko also includes a number of Grafana dashboards at monitoring/dashboards.

Status

Piko includes a status CLI to inspect a Piko server. Servers register endpoints at /status on the admin port that piko server status then queries.

Such as to view the endpoints registers on a server use piko server status proxy endpoints. Or to inspect the set of known nodes in the cluster use piko server status cluster nodes.

Configure the server URL with --server.url. You can also forward the request to a particular node ID using --forward (which can be useful when all nodes are behind a load balancer).