Skip to content

Quick Start

This guide takes you from zero to seeing Crossplane metrics in under five minutes.

1. Deploy xp-tracker

Create a Kustomize overlay for your environment:

deploy/overlays/my-env/
  kustomization.yaml

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

resources:
  - ../../base

patches:
  - target:
      kind: ConfigMap
      name: crossplane-metrics-exporter
    patch: |
      apiVersion: v1
      kind: ConfigMap
      metadata:
        name: crossplane-metrics-exporter
      data:
        CLAIM_GVRS: "myorg.io/v1alpha1/databases,myorg.io/v1alpha1/caches"
        XR_GVRS: "myorg.io/v1alpha1/xdatabases,myorg.io/v1alpha1/xcaches"
        CREATOR_ANNOTATION_KEY: "myorg.io/created-by"
        TEAM_ANNOTATION_KEY: "myorg.io/team"

images:
  - name: ghcr.io/kanzifucius/xp-tracker
    newTag: latest

Apply it:

kubectl apply -k deploy/overlays/my-env

2. Verify the exporter is running

kubectl -n crossplane-system get pods -l app.kubernetes.io/name=crossplane-metrics-exporter

3. Check metrics

Port-forward to the exporter:

kubectl -n crossplane-system port-forward svc/crossplane-metrics-exporter 8080:8080

Verify the exporter is ready:

curl -s localhost:8080/readyz
# Should print "ok" once the first poll cycle completes

Then query the metrics endpoint:

curl -s localhost:8080/metrics | grep crossplane_

You should see output like:

# HELP crossplane_claims_total Number of Crossplane claims by group, kind, namespace, composition and creator.
# TYPE crossplane_claims_total gauge
crossplane_claims_total{composition="db-small",creator="alice@example.com",group="myorg.io",kind="Database",namespace="team-a",team="platform"} 3

4. Check bookkeeping

The JSON bookkeeping endpoint provides a full snapshot of all tracked resources:

curl -s localhost:8080/bookkeeping | jq .

Next steps