README.md

Sentry exporter

The sentry exporter expose sentry stats to Prometheus.

Building and running

Local Build

make
./sentry_exporter <flags>

or you can use gox

Visiting http://localhost:9412/probe?target={sentry_project} will return metrics for a probe against the sentry project

Building with Docker

docker build -t sentry_exporter .
docker run -d -p 9412:9412 --name sentry_exporter -v `pwd`:/config sentry_exporter --config.file=/config/sentry_exporter.yml

Configuration

Sentry exporter is configured via a configuration file and command-line flags (such as what configuration file to load, what port to listen on, and the logging format and level).

Sentry exporter can reload its configuration file at runtime. If the new configuration is not well-formed, the changes will not be applied. A configuration reload is triggered by sending a SIGHUP to the Sentry exporter process or by sending a HTTP POST request to the /-/reload endpoint.

To view all available command-line flags, run ./sentry_exporter -h.

To specify which configuration file to load, use the --config.file flag.

Additionally, an example configuration is also available.

The timeout of each probe is automatically determined from the scrape_timeout in the Prometheus config, slightly reduced to allow for network delays.

Prometheus Configuration

The sentry exporter needs to be passed the target as a parameter, this can be done with relabelling.

Example config:

scrape_configs:
  - job_name: 'sentry'
    metrics_path: /probe
    static_configs:
      - targets:
        - {project name}    # First project name.
        - {second project name}   # Second project name
    relabel_configs:
      - source_labels: [__address__]
        target_label: __param_target
      - source_labels: [__param_target]
        target_label: instance
      - target_label: __address__
        replacement: 127.0.0.1:9412  # The sentry exporter's real hostname:port.