Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wbollock committed Sep 3, 2022
1 parent 7d04c74 commit d08dd96
Showing 1 changed file with 31 additions and 11 deletions.
42 changes: 31 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,50 @@ A Prometheus exporter currently supporting:

* Nagios XI

## Build and Release Steps
It includes metrics on the current state and configuration of Nagios. This includes the number of hosts, services, and information about their monitoring setup. For example, this exporter will output the number of flapping hosts, passive checks, or hosts in downtime.

1. Build binaries with goreleaser:
## Installation Instructions

### Configuration

Create a simple `config.toml` in `/etc/prometheus-nagios-exporter` with your Nagios API key:

```toml
# prometheus-nagios-exporter configuration

APIKey = ""
```

By default this will point to localhost, but a remote address can be specified with `-web.remote-address string`. The default port is `9111`, but can be changed with `-web.listen-address`.

### Debian/RPM package

Substitute `{{ version }}` for your desired release.

```bash
goreleaser build --snapshot --rm-dist
wget https://github.com/wbollock/nagios_exporter/releases/download/v{{ version }}/prometheus-nagios-exporter_{{ version }}_linux_amd64.deb
dpkg -i prometheus-nagios-exporter_{{ version }}_linux_amd64.deb
```

2. Use the resulting binaries in `./dist`, or create a deb/rpm packages with nfpm:
### Binary

```bash
# deb example - can substitute with rpm
nfpm package -p deb -t /tmp/
wget https://github.com/wbollock/nagios_exporter/releases/download/v{{ version }}/nagios_exporter_{{ version }}_Linux_x86_64.tar.gz
tar xvf nagios_exporter_{{ version }}_Linux_x86_64.tar.gz
./nagios_exporter/prometheus-nagios-exporter
```

3. Tag release and push:
### Source

```bash
git tag -a v0.1.0 -m "First release"
git push origin v0.1.0
goreleaser release
wget https://github.com/wbollock/nagios_exporter/archive/refs/tags/v{{ version }}.tar.gz
tar xvf nagios_expoter-{{ version }}.tar.gz
cd ./nagios_expoter-{{ version }}
go build main.go
./main.go
```

## Resources
## Resources Used

* [haproxy_expoter](https://github.com/prometheus/haproxy_exporter/blob/main/haproxy_exporter.go)
* [15 Steps to Write an Application Prometheus Exporter in GO](https://medium.com/teamzerolabs/15-steps-to-write-an-application-prometheus-exporter-in-go-9746b4520e26)
Expand Down

0 comments on commit d08dd96

Please sign in to comment.