Private Preview

This feature is in private preview and is not publicly available.

Monitoring SPIRL Reflector

Overview

Monitoring SPIRL Reflector provides valuable insights into the performance and health of your SPIRL deployment. By enabling the Prometheus metrics endpoint, you can track key metrics such as API response times, request volumes, and system resource utilization. This visibility helps you identify potential bottlenecks, monitor system health, and make data-driven decisions about scaling and optimization. The metrics are particularly useful for understanding the behavior of gRPC APIs and ensuring your SPIRL deployment is operating efficiently.

Prerequisites

1. SPIRL Reflector enabled in SPIRL System

Enabling SPIRL Reflector Prometheus Endpoint

Add the following to your SPIRL System values.yaml file to enable the metrics endpoint in the SPIRL Reflector.

telemetry:
  enabled: true

If you want to include latency metrics for gRPC APIs then include this.

telemetry:
  enabled: true
  collectors:
    grpc:
      emmitLatencyMetrics: true

By default this enables the endpoint at port :9090. If you would like it to be enabled at a different location then you can specify it by using the below configuration.

Important: Note that the telemetry configuration in the SPIRL System Helm chart applies to both the SPIRL Agent and the SPIRL Reflector. In the future we may separate these configurations but at present they apply to both components.

telemetry:
  enabled: true
  metricsAPI:
    port: 9090