{% extends "base.html" %} {% load humanize static hc_extras %} {% block title %}Add Prometheus - {% site_name %}{% endblock %} {% block content %}

Prometheus

{% site_name %} provides a Prometheus-compatible metrics endpoint for each project. The endpoints are secured using each project's read-only API key. If your team uses Prometheus, you can configure it to scrape {% site_name %} and have up-to-date check and tag status values available in Prometheus.

Setup Guide

1

Look up your project's read-only API key in Project Settings › API Access.

If you have not generated API keys before, you will need to do that first.

Click create integration button
2

Edit Prometheus configuration and add a new section in the scrape_configs section.

- job_name: 'healthchecks-{{ project|slugify }}'
  scheme: {% site_scheme %}
  metrics_path: /projects/{{ project.code }}/metrics/YOUR-READ-ONLY-API-KEY
  static_configs:
  - targets: ['{% site_hostname %}']
3

Reload Prometheus' configuration. You should now start seeing {% site_name %} data appear in Prometheus.

{% endblock %}