tcms-prometheus-exporter

A Kiwi TCMS plugin that exposes Prometheus-format metrics for scraping.

Installation

pip install -e /path/to/tcms-prometheus-exporter

Then add to INSTALLED_APPS (handled automatically via the kiwitcms.plugins entry point).

Restart Kiwi TCMS.

Metrics Endpoint

Once installed, the following URLs are available:

• /tcms_prometheus_exporter/ — Dashboard (requires login)
• /tcms_prometheus_exporter/metrics/ — Prometheus scrape endpoint

Token Protection

By default, the /metrics/ endpoint is open (no authentication required so that Prometheus can scrape it).

To add token-based protection, set the PROMETHEUS_METRICS_TOKEN environment variable:

export PROMETHEUS_METRICS_TOKEN=my-secret-token

Then configure Prometheus to pass the token as a query parameter:

scrape_configs:
  - job_name: 'kiwi-tcms'
    params:
      token: ['my-secret-token']
    metrics_path: '/tcms_prometheus_exporter/metrics/'
    static_configs:
      - targets: ['your-kiwi-host:8000']

Exposed Metrics (23 total)

Test Cases (4)

Test Plans (3)

Test Runs (4)

Test Executions (3)

Products & Builds (2)

Users & Activity (6)

Instance Info (1)

License

MIT