Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/veerendra2/nordvpn-exporter

Simple NordVPN Prometheus Exporter :computer:
https://github.com/veerendra2/nordvpn-exporter

grafana grafana-dashboard grafana-datasource nordvpn nordvpn-exporter pip3 prometheus prometheus-exporter prometheus-metrics python3

Last synced: 3 months ago
JSON representation

Simple NordVPN Prometheus Exporter :computer:

Host: GitHub
URL: https://github.com/veerendra2/nordvpn-exporter
Owner: veerendra2
License: apache-2.0
Created: 2021-10-18T22:30:03.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2023-02-13T13:04:48.000Z (almost 2 years ago)
Last Synced: 2024-09-30T08:03:24.379Z (3 months ago)
Topics: grafana, grafana-dashboard, grafana-datasource, nordvpn, nordvpn-exporter, pip3, prometheus, prometheus-exporter, prometheus-metrics, python3
Language: Python
Homepage:
Size: 136 KB
Stars: 3
Watchers: 3
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        ![GitHub](https://img.shields.io/github/license/veerendra2/nordvpn-exporter)

![GitHub Repo stars](https://img.shields.io/github/stars/veerendra2/nordvpn-exporter)

![GitHub issues](https://img.shields.io/github/issues/veerendra2/nordvpn-exporter)

![PyPI - Status](https://img.shields.io/pypi/status/nordvpn-exporter)

![PyPI](https://img.shields.io/pypi/v/nordvpn-exporter?style=plastic)

![PyPI - License](https://img.shields.io/pypi/l/nordvpn-exporter)

![PyPI - Format](https://img.shields.io/pypi/format/nordvpn-exporter)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/nordvpn-exporter)

[![Release](https://github.com/veerendra2/nordvpn-exporter/actions/workflows/release.yaml/badge.svg)](https://github.com/veerendra2/nordvpn-exporter/actions/workflows/release.yaml)

# `nordvpn` Prometheus Exporter

> This is not official NordVPN exporter. 

[](https://user-images.githubusercontent.com/8393701/138961711-e56542f4-0ac0-4113-bbec-6172e4ce066e.png)

A simple exporter fetch info from `nordvpn` cli. 

## Why?

To monitor remote devices VPN connection. In my case, I use RaspberryPi4 and run `nordvpn` in [docker](https://github.com/bubuntux/nordvpn)

## Dependency

* `nordvpn` cli.

   * Installation guide [here](https://support.nordvpn.com/FAQ/Setup-tutorials/1182453582/Installing-and-using-NordVPN-on-Linux.htm)

## Install

```

$ pip3 install nordvpn_exporter

```

## Usage

```

$ nordvpn_exporter --help

usage: nordvpn_exporter [-h] [-d] [-p PORT] [-v]

Simple NordVPN exporter

optional arguments:

  -h, --help  show this help message and exit

  -d          Run as daemon

  -p PORT     Port

  -v          show program's version number and exit

```

* Run exporter directly and `curl http://localhost:8082/metrics` in another terminal

```

$ nordvpn_exporter 

Starting NordVPN Exporter on http://localhost:8082

```

List of metrics: [wiki](https://github.com/veerendra2/nordvpn-exporter/wiki)

* I created a simple "daemonize" option to run exporter background 

```

$ nordvpn_exporter -d

Starting NordVPN Exporter on http://localhost:8082

[*] Running in background

$ curl http://localhost:8082/metrics | head

#=#=-#     #                                                                                                                                     

# HELP python_gc_objects_collected_total Objects collected during gc

# TYPE python_gc_objects_collected_total counter

python_gc_objects_collected_total{generation="0"} 264.0

python_gc_objects_collected_total{generation="1"} 33.0

python_gc_objects_collected_total{generation="2"} 0.0

# HELP python_gc_objects_uncollectable_total Uncollectable object found during GC

# TYPE python_gc_objects_uncollectable_total counter

python_gc_objects_uncollectable_total{generation="0"} 0.0

python_gc_objects_uncollectable_total{generation="1"} 0.0

python_gc_objects_uncollectable_total{generation="2"} 0.0

```