https://github.com/tommy-muehle/speakerdeck_exporter
Unofficial Prometheus Exporter for SpeakerDeck.
https://github.com/tommy-muehle/speakerdeck_exporter
metrics prometheus prometheus-exporter speakerdeck
Last synced: about 2 months ago
JSON representation
Unofficial Prometheus Exporter for SpeakerDeck.
- Host: GitHub
- URL: https://github.com/tommy-muehle/speakerdeck_exporter
- Owner: tommy-muehle
- License: mit
- Created: 2019-09-12T20:56:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-09-15T20:26:39.000Z (over 5 years ago)
- Last Synced: 2023-08-02T03:54:19.876Z (almost 2 years ago)
- Topics: metrics, prometheus, prometheus-exporter, speakerdeck
- Language: Go
- Homepage:
- Size: 784 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SpeakerDeck Prometheus Exporter
SpeakerDeck Prometheus exporter makes it possible to monitor stats of various decks by various authors on SpeakerDeck using Prometheus.
## Project status
[](https://travis-ci.org/tommy-muehle/speakerdeck_exporter)
[](https://goreportcard.com/report/github.com/tommy-muehle/speakerdeck_exporter)
[](https://codecov.io/gh/tommy-muehle/speakerdeck_exporter)
## Exported Metrics
* ```speakerdeck_scrape_collector_state```
The status of the last metric scrape: 1 for a successful scrape and 0 for a failed one.
* ```speakerdeck_scrape_collector_duration_seconds```
Duration of the last metric scrape in seconds.
* ```speakerdeck_stars```
The stars of a deck and by an author.
* ```speakerdeck_views```
The stars of a deck and by an author.
An example set of metrics can be found [here](METRICS.md).
## Prerequisites
I assume that you have already installed Prometheus. Configure Prometheus to scrape metrics from the server with the exporter.
Note that the default scrape port of the exporter is 9887 and the metrics path -- "/metrics".
## Usage
#### Command-line Arguments
```shell
Usage of ./speakerdeck-exporter:
-addr
An address to listen on for web interface and telemetry.
-users
Comma separated list of Speakerdeck users to watch.
-version
Prints the current version.
```
## Grafana
An example dashboard in Grafana could look like [this](grafana/dashboard.json):
