Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uninett/nav-argus-glue
A NAV <-> Argus glue service
https://github.com/uninett/nav-argus-glue
Last synced: about 1 month ago
JSON representation
A NAV <-> Argus glue service
- Host: GitHub
- URL: https://github.com/uninett/nav-argus-glue
- Owner: Uninett
- Created: 2020-11-04T09:57:39.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-27T13:50:17.000Z (about 1 month ago)
- Last Synced: 2024-11-27T14:37:30.476Z (about 1 month ago)
- Language: Python
- Size: 60.5 KB
- Stars: 1
- Watchers: 12
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# NAV ↔ Argus glue service
This is a glue service for integration between
[Argus](https://github.com/Uninett/Argus), the alert aggregation server, and
[Network Administration Visualized](https://github.com/Uninett/nav) (NAV), the
network monitoring software suite provided by Uninett.
## How it works
`navargus` acts as an export script for the NAV event engine. It accepts
stacked, JSON-serialized alert objects on its STDIN.
The event engine will feed `navargus` a continuous stream of NAV alerts as they
are generated. `navargus` uses these alerts to either create new incidents in
the Argus API, or resolve existing ones as needed.
Refer to the Argus server documentation to learn more about [integrating monitoring
systems](https://argus-server.readthedocs.io/en/latest/integrating-monitoring-systems.html)
with Argus.
## Installation
If you don't want to install from the source code repository, the latest
version of the package is always available on PyPI:
```shell
pip install nav-argus-glue
```
## Configuration
### NAV
Add `navargus` in the `[export]` section of the `eventengine.conf` file.
```ini
[export]
# If set, the script option will point to a program that will receive a
# continuous stream of JSON serialized alert objects on its STDIN.
script = /path/to/navargus
```
### Argus
In the Argus admin interface, create a new "Source system" for your
NAV instance. This will automatically create an Argus user account for
this instance. Now, use the Argus admin interface to create an authentication
token for your user.
### NAV-Argus glue service
`navargus` is configured via `navargus.yml`. Since `navargus` is designed to
run in conjunction with NAV's event engine, this config file must be placed in
NAV's config directory (typically `/etc/nav`).
A minimal `navargus.yml` contains the base URL of your Argus server and the
Argus API token generated above.
An example:
```yml
---
api:
url: https://argus.example.com/api/v1
token: very-long-and-secret-string
```
The configuration file may optionally contain a list of tags.
These tags will be added to all incidents created by this NAV instance.
To learn more about tags, refer to
[Argus documentation](https://argus-server.readthedocs.io/).
A full configuration file example is provided in
[navargus.example.yml](navargus.example.yml).
Now, you can run the command `navargus --test-api` to verify that the glue
service is properly configured and able to query the Argus API.
## Code style
This module uses Black as a source code formatter for Python code.
A pre-commit hook will format new code automatically before committing.
To enable this pre-commit hook, run
```console
$ pre-commit install
```