Sign inSign up

cyb3rjak3/atlas-exporter

By cyb3rjak3

•Updated 5 months ago

Image
0

2.8K

cyb3rjak3/atlas-exporter repository overview

⁠RIPE Atlas Prometheus Exporter

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

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.

The archive downloads previously had the version number in the name, for example atlas-stats-exporter_1.2.3_windows_amd64.zip. This has been deprecated and the new naming convention is just atlas-stats-exporter_windows_amd64.zip.

Note: As of v2.0.0, the docker images only support linux/amd64 and linux/arm64 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
NameUsageDefaultEnvironment Variable
api_tokenRequired Authenticates to the RIPE APIATLAS_EXPORTER_API_TOKEN
listen_addressSets the address to listen for HTTP requests on:8080ATLAS_EXPORTER_LISTEN_ADDRESS
metrics_pathPath to expose the metrics listener/metricsATLAS_EXPORTER_METRICS_PATH
timeoutTimeout for the API requests in Seconds30ATLAS_EXPORTER_TIMEOUT
tls_enabledEnabled TLS for the HTTP serverfalseATLAS_EXPORTER_TLS_ENABLED
tls_cert_chain_pathPath to the TLS certificate chain file (PEM format)cert.pemATLAS_EXPORTER_TLS_CERT_CHAIN_PATH
tls_key_pathPath to the TLS private key file (PEM formatkey.pemATLAS_EXPORTER_TLS_KEY_PATH
log_levelSet the logging level (debug, info, warn, error, fatal, panic)infoATLAS_EXPORTER_LOG_LEVEL

Tag summary

Content type

Image

Digest

sha256:47a667a99…

Size

6.7 MB

Last updated

5 months ago

docker pull cyb3rjak3/atlas-exporter