Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MacroPower/wakatime_exporter
Exports Prometheus metrics from Wakatime.
https://github.com/MacroPower/wakatime_exporter
exported-metrics go golang metrics prometheus prometheus-exporter statistics wakatime wakatime-api
Last synced: 4 days ago
JSON representation
Exports Prometheus metrics from Wakatime.
- Host: GitHub
- URL: https://github.com/MacroPower/wakatime_exporter
- Owner: MacroPower
- License: apache-2.0
- Created: 2020-07-22T00:08:50.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-15T03:45:23.000Z (over 1 year ago)
- Last Synced: 2024-11-07T01:29:21.051Z (5 days ago)
- Topics: exported-metrics, go, golang, metrics, prometheus, prometheus-exporter, statistics, wakatime, wakatime-api
- Language: Go
- Homepage:
- Size: 3.55 MB
- Stars: 91
- Watchers: 3
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - MacroPower/wakatime_exporter - Exports Prometheus metrics from Wakatime. (Go)
README
_wakatime_exporter_ is a Prometheus exporter for [Wakatime](https://wakatime.com/) statistics.
It intends to extend the existing Wakatime ecosystem
via allowing users to make use of Prometheus (and therefore any consumers of its API)
as companion services alongside the traditional Wakatime web application.
This could be anything from including some of your coding statistics in Grafana,
to forecasting your coding time with prophet.
> NOTE: _wakatime_exporter_ is currently in ALPHA. Expect things to break and change.
[Click here](docs/METRICS.md) to see an example of the exported metrics.
[Click here](https://grafana.com/grafana/dashboards/12790) for a simple dashboard you can use to get started.
## Usage
In most cases, you should only need to provide an API key.
All other parameters are for advanced use-cases only
and you should be able to leave them set to their defaults.
You can get your Wakatime API key by visiting: https://wakatime.com/api-key
Provide arguments via parameters:
```text
usage: wakatime_exporter --wakatime.api-key=WAKATIME.API-KEY []
Flags:
--help, -h Show context-sensitive help.
--collector.all-time Enable the all-time collector (default: enabled).
--collector.goal Enable the goal collector (default: enabled).
--collector.leader Enable the leader collector (default: enabled).
--collector.summary Enable the summary collector (default: enabled).
--collector.disable-defaults Set all collectors to disabled by default.
--web.listen-address=":9212" Address to listen on for web interface and telemetry.
--web.metrics-path="/metrics" Path under which to expose metrics.
--web.disable-exporter-metrics Exclude metrics about the exporter itself (promhttp_*, process_*, go_*).
--wakatime.scrape-uri="https://wakatime.com/api/v1"
Base path to query for Wakatime data.
--wakatime.user="current" User to query for Wakatime data.
--wakatime.api-key Token to use when getting stats from Wakatime.
--wakatime.timeout=5s Timeout for trying to get stats from Wakatime.
--wakatime.ssl-verify Flag that enables SSL certificate verification for the scrape URI.
--log.level=info Only log messages with the given severity or above.
One of: [debug, info, warn, error]
--log.format=logfmt Output format of log messages.
One of: [logfmt, json]
--version Show application version.
```
and/or via environment variables:
```shell
WAKA_LISTEN_ADDRESS=":9212" # Address to listen on for web interface and telemetry.
WAKA_METRICS_PATH="/metrics" # Path under which to expose metrics.
WAKA_SCRAPE_URI="https://wakatime.com/api/v1" # Base path to query for Wakatime data.
WAKA_USER="current" # User to query for Wakatime data.
WAKA_API_KEY="" # Token to use when getting stats from Wakatime.
WAKA_TIMEOUT="5s" # Timeout for trying to get stats from Wakatime.
WAKA_SSL_VERIFY="true" # SSL certificate verification for the scrape URI.
WAKA_DISABLE_EXPORTER_METRICS="false" # Exclude metrics about the exporter itself.
WAKA_COLLECTOR_ALLTIME="true" # Enable the all-time collector.
WAKA_COLLECTOR_GOAL="true" # Enable the goal collector.
WAKA_COLLECTOR_LEADER="true" # Enable the leader collector.
WAKA_COLLECTOR_SUMMARY="true" # Enable the summary collector.
```
## Docker
```shell
docker run -p 9212:9212 macropower/wakatime-exporter:latest --wakatime.api-key="YOUR_API_KEY"
```
Or use docker-compose:
```shell
# Linux & Darwin
WAKA_API_KEY="YOUR_API_KEY" docker-compose up
```
```powershell
# Windows
$env:WAKA_API_KEY="YOUR_API_KEY"; docker-compose up
```
## Compatibility
_wakatime_exporter_ is designed to work with [Wakatime](https://wakatime.com/).
However, you can additionally use any other application
that is compliant with the [Wakatime API](https://wakatime.com/developers),
e.g. [wakapi](https://github.com/muety/wakapi),
via `--wakatime.scrape-uri` or `WAKA_SCRAPE_URI`.
If said application only implements portions of the Wakatime API,
you can disable collectors for any non-compliant or non-existent endpoints
using parameters or environment variables as described in [usage](#usage).
## License
This project was licensed GPL-2.0 from 0.0.0 to 0.0.5.
As of version 0.1.0, parts of this application use code from node_exporter, which is licensed APACHE 2.0.
As of version 0.1.0, this project in its entirety, excluding any packages found in vendor, is licensed APACHE 2.0.
Each file in this project has a license header which identifies the copyright for said file.