https://github.com/systemli/prometheus-onion-service-exporter

Prometheus Exporter for Tor Onion Services
https://github.com/systemli/prometheus-onion-service-exporter

onion-service prometheus-exporter

Last synced: 6 months ago
JSON representation

Prometheus Exporter for Tor Onion Services

• Host: GitHub
• URL: https://github.com/systemli/prometheus-onion-service-exporter
• Owner: systemli
• License: gpl-3.0
• Created: 2021-07-07T07:57:50.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-04-12T23:10:15.000Z (6 months ago)
• Last Synced: 2025-04-12T23:28:03.401Z (6 months ago)
• Topics: onion-service, prometheus-exporter
• Language: Go
• Homepage:
• Size: 286 KB
• Stars: 8
• Watchers: 6
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# prometheus-onion-service-exporter

[![Integration](https://github.com/systemli/prometheus-onion-service-exporter/actions/workflows/integration.yaml/badge.svg)](https://github.com/systemli/prometheus-onion-service-exporter/actions/workflows/integration.yaml)

[![Quality](https://github.com/systemli/prometheus-onion-service-exporter/actions/workflows/quality.yaml/badge.svg)](https://github.com/systemli/prometheus-onion-service-exporter/actions/workflows/quality.yaml)

[![Release](https://github.com/systemli/prometheus-onion-service-exporter/actions/workflows/release.yaml/badge.svg)](https://github.com/systemli/prometheus-onion-service-exporter/actions/workflows/release.yaml)

Prometheus Exporter for Tor onion services written in Go.

Export the status and latency of an onion service to prometheus.

## Usage

```

go install github.com/systemli/prometheus-onion-service-exporter@latest

$GOPATH/bin/prometheus-onion-service-exporter

```

### Commandline options

```

-c config.yml  # path of config file, see config.dist.yml for an example

```

## Metrics

```

# HELP onion_service_latency 

# TYPE onion_service_latency gauge

onion_service_latency{address="7sk2kov2xwx6cbc32phynrifegg6pklmzs7luwcggtzrnlsolxxuyfyd.onion",name="website",type="http"} 1.167850077

onion_service_latency{address="jntdndrgmfzgrnupgpm52xv2kwecq6mt4njyu2pzoenifsmiknxaasqd.onion:64738",name="mumble",type="tcp"} 0.331070165

# HELP onion_service_up 

# TYPE onion_service_up gauge

onion_service_up{address="7sk2kov2xwx6cbc32phynrifegg6pklmzs7luwcggtzrnlsolxxuyfyd.onion",name="website",type="http"} 1

onion_service_up{address="jntdndrgmfzgrnupgpm52xv2kwecq6mt4njyu2pzoenifsmiknxaasqd.onion:64738",name="mumble",type="tcp"} 1

```

### Docker

```

docker run -p 9999:9999 -v /path/to/config.yml:/config.yml:ro systemli/prometheus-onion-service-exporter:latest -c config.yml

```

## License

GPLv3