x-metrics

x-metrics

x-metrics generates Prometheus metrics for a range of Crossplane resources, encompassing Providers, Compositions, Claims, Managed Resources, etc. These metrics provide comprehensive insights, including details such as the last transition time, creation timestamp, readiness status, and more. Access to these metrics is available via an exposed endpoint.

based on Crossplane Intro and Deep Dive - the Cloud Native Control Plane Framework

Prerequisites

Helm must be installed to use the charts. Please refer to Helm's documentation to get started.

Installation

Install the Helm chart:

helm repo add x-metrics https://crossplane-contrib.github.io/x-metrics
helm install x-metrics x-metrics/x-metrics --namespace x-metrics --create-namespace --wait

Usage

To access the metrics with the default setting trough the endpoint:

1. Port-forward the services

kubect -n x-metrics port-forward svc/x-metrics 8080:8080

1. In your browser navigate to: http://127.0.0.1:8080/x-metrics

2. To generate metrics, apply one of the CRDs under the examples/ folder:

kubectl appy -f examples/iam-metric.yaml

1. Refresh the browser to see the metrics populate.

Licensing