Skip to content

Cyb3r-Jak3/atlas-stats-exporter

Repository files navigation

RIPE Atlas Prometheus Exporter

GitHub Release GitHub go.mod Go version
Golanglint CI Go Checks

This is a Prometheus exporter for RIPE Atlas accounts, and probes. It does not currently support RIPE Atlas measurements, but plans to in the future. This exporter does require a RIPE Atlas account, and the API key for that account. You can follow the docs to create an API key for your account.

Usage

You can install the exporter by downloading the latest release from the releases page, pulling the Docker image from Docker Hub or GitHub Container Registry, or by building it from source.

Note: The docker images only support linux/amd64, linux/arm64 and linux/arm architectures. If you need a different architecture, you will need to download the binary from the releases page or build it from source.

Dashboard

There is an example Grafana dashboard available for this exporter. You can find it in the dashboards directory.

Example image of the dashboard: Example Dashboard

Docker

You can run the exporter using Docker with the following command:

docker run -d \
  --name atlas-exporter \
  -p 8080:8080 \
  -e ATLAS_EXPORTER_API_TOKEN=your_api_token_here \
  cyb3r-jak3/atlas-stats-exporter:latest

Metrics

The exporter exposes the following metrics:

  • atlas_exporter_credits: Number of credits available in the RIPE Atlas account.
  • atlas_exporter_probe_last_connected: Timestamp of the last time the probe connected to the RIPE Atlas network in seconds since epoch.
  • atlas_exporter_probe_measurements: Number of measurements the probe has performed.

Full Configuration Variables

Name Usage Default Environment Variable
api_token Required Authenticates to the RIPE API ATLAS_EXPORTER_API_TOKEN
listen_address Sets the address to listen for HTTP requests on :8080 ATLAS_EXPORTER_LISTEN_ADDRESS
metrics_path Path to expose the metrics listener /metrics ATLAS_EXPORTER_METRICS_PATH
timeout Timeout for the API requests in Seconds 30 ATLAS_EXPORTER_TIMEOUT
tls_enabled Enabled TLS for the HTTP server false ATLAS_EXPORTER_TLS_ENABLED
tls_cert_chain_path Path to the TLS certificate chain file (PEM format) cert.pem ATLAS_EXPORTER_TLS_CERT_CHAIN_PATH
tls_key_path Path to the TLS private key file (PEM format key.pem ATLAS_EXPORTER_TLS_KEY_PATH
log_level Set the logging level (debug, info, warn, error, fatal, panic) info ATLAS_EXPORTER_LOG_LEVEL

About

Promethues exporter for RIPE atlas stats

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 2

  •  
  •