Metadata-Version: 2.1
Name: gpsd-prometheus-exporter
Version: 0.3.1
Summary: Monitor GPSD with Prometheus
License: MIT
Author: Mark S
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: argparse (>=1.4.0,<2.0.0)
Requires-Dist: bump2version (>=1.0.1,<2.0.0)
Requires-Dist: gps (>=3.19,<4.0)
Requires-Dist: gpsd-py3 (>=0.3.0,<0.4.0)
Requires-Dist: prometheus-client (>=0.9.0,<0.10.0)
Description-Content-Type: text/markdown

# gpsd_prometheus_exporter
Prometheus Exporter for GPSD

## Prereqs
* python
* pip
* USB GPS device compatible with gpsd
* gpsd installed and running

It's a good idea to make sure that gpsd is working and reporting data. Verify
using gpsmon or similar:

![gpsmon example output](img/gpsmon.png)

## Usage Instructions

```
gpsd-exporter --help

Usage: gpsd-exporter [OPTIONS]

Options:
  -b, --bind TEXT     Specify alternate bind address [default: 0.0.0.0]
  -p, --port INTEGER  Specify alternate port [default: 8000]
  -d, --debug         Turns on more verbose logging, prints output [default:
                      False]

  --help              Show this message and exit.
```
### Example

Start the exporter on all addresses and port 9999:

```gpsd-exporter -b 0.0.0.0 -p 9999```


### Adding this exporter to Prometheus
```
  - job_name: gps
    static_configs:
    - targets: ['boat-pi:8000']
      labels:
        group: 'gps'
        location: 'Boat'
```
