Closed victorcfonseca closed 3 years ago
Thank you for your contribution. Can you open a Pull Request for this? It's pretty simple with GitHub. Just edit the readme file in this repo (Pencil Icon on the upper right corner of the readme view), GitHub will create a fork for you. Then make your edits and click save. You can then open a pull request with that edit with just 2 more clicks.
solved by #14
I just added some informations on the readme.md that were useful for me. Maybe it may help other people.
Exporter for sentry data in prometheus format
This package uses the Sentry web api to query for some statistics and outputs them in OpenMetrics format to be scraped by prometheus.
You can also fire it up as a docker container.
Usage
Using this exporter throught with Composer or Docker, you will need the hostname of your sentry installation and an auth token, which you can create via
https://<YOUR-SENTRY-HOST>/api/
if you're working with the Sentry self hosted. If you're working with Sentry cloud, you will need to create the token viahttps://sentry.io/settings/account/api/auth-tokens/
.with Composer
Installation
Usage in your custom file
with Docker
The image is based on
php:7.2-apache
and thus exposes data on port 80 by default. Assuming you fire this up with-p 80:80
on localhost, you can see the metrics on http://localhost/metrics.Configuration is done with 3 env variables:
SENTRY_HOST
,AUTH_TOKEN
andHTTP_PROTO
. The first 2 are mandatory,HTTP_PROTO
is optional and set tohttps
by default. If you're working with the Sentry Cloud, yourSENTRY_HOST
variable must be "sentry.io"View on Docker Hub
Output
The script will generate something like: