https://github.com/riesinger/plausible-exporter
https://github.com/riesinger/plausible-exporter
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/riesinger/plausible-exporter
- Owner: riesinger
- License: mit
- Created: 2022-09-20T21:11:33.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-09T16:47:37.000Z (almost 2 years ago)
- Last Synced: 2025-04-22T07:12:46.988Z (about 1 year ago)
- Language: Go
- Size: 96.7 KB
- Stars: 25
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# plausible-exporter
`plausible-exporter` is a Prometheus exporter for [Plausible Analytics](https://plausible.io).
It enables you to keep an overview of your websites statistics in Prometheus.
## Usage
`plausible-exporter` can be run as a Docker container (preferrably) or built from source and run as a static binary.
### docker-compose
```yaml
version: "3"
services:
plausible-exporter:
image: ghcr.io/riesinger/plausible-exporter:latest
environment:
- PLAUSIBLE_HOST=https://plausible.io
- PLAUSIBLE_SITE_IDS=your-web.site
- PLAUSIBLE_TOKEN=
ports:
- 8080:8080
```
For configuration see [this section](#configuration).
### Binary
To run the exporter as binary, clone this repo, build the Go binary and run it:
```sh
git clone https://github.com/riesinger/plausible-exporter
make # or "make static"
./plausible-exporter
```
For configuration see [this section](#configuration).
### Kubernetes / Helm
If you want to run this exporter inside a Kubernetes cluster you can use this [community contributed Helm chart](https://charts.pascaliske.dev/charts/plausible-exporter/) by [@pascaliske](https://github.com/pascaliske).
For configuration see [this section](#configuration).
### Configuration
The exporter can be configured via a `config.yaml` file placed in `/etc/plausible-exporter` or via environment variables.
When put into a config file, the variable names are `snake_cased`, when set via the environment, the variables must be `UPPER_SNAKE_CASED`.
All options can be set in the config file or environment variables, with environment variables taking precedence.
| Option | Required | Description | Default |
| -------------------- | -------- | ---------------------------------------------------------------------- | -------------- |
| `plausible_host` | ✅ | The hostname and protocol of your plausible server | - |
| `plausible_site_ids` | ✅ | The IDs of the sites you want to fetch from plausible, as a list | - |
| `plausible_token` | ✅ | A valid API token for your plausible server | - |
| `listen_address` | ❌ | Which host and port to listen to | `0.0.0.0:8080` |
| `bearer_auth_token` | ❌ | Bearer token to authorize metrics route through `Authorization` header | - |
> **Note:** Config options that are lists must be comma-separated when passed as an environment variable, e.g. `PLAUSIBLE_SITE_IDS=riesinger.dev,nononsense.cooking`
### Prometheus
This exporter creates 4 metrics:
- `plausible_visitors` - How many visitors were on your site on the current day
- `plausible_visit_duration` - How long an average visit to your site was (in seconds)
- `plausible_pageviews` - How many page views your site had today
- `plausible_bounce_rate` - How many visitors left your site (in percent, 0-100)
In case you've configured multiple sites to be scraped, you can differentiate between them with the `site_id` label.
### Grafana
You can use the exported metrics just like you'd use any other metric scraped by Prometheus.
The `examples` folder contains a small [demo dashboard](./examples/grafana-dashboard.json). You can use this as a starting point for integrating the metrics into your own dashboards.
#### Authorization
If you want to restrict access to the metrics endpoint, you can set the `bearer_auth_token` (`BEARER_AUTH_TOKEN` environment variable) option.
This will require the client to send a `Authorization: Bearer ` header with the request.
## License
This project is MIT-licensed, see [LICENSE.md](./LICENSE.md)