Monitoring and metrics

Healthcheck

To check the health, we use the standard gRPC service check approach: grpc-health-probe. Just run the health probe against platforma gRPC API port (default is TCP:6345) to check that service is live.

Metrics

The Platforma Backend exports metrics in prometheus format, so the most of popular metrics-collection systems and frameworks can work with it. To enable monitoring export endpoint, add monitoring section to the configuraiton file:

monitoring:
  #
  # Provide Prometheus metrics handler on a specified address.
  #
  listen: "0.0.0.0:9090"

Now metrics are available at <your server IP>:9090/metrics:

> curl 'http://localhost:9090/metrics'

# HELP core_events_execution_seconds Time of execution events
# TYPE core_events_execution_seconds histogram
core_events_execution_seconds_bucket{le="0.0005"} 8
core_events_execution_seconds_bucket{le="0.005"} 8
# ...