https://github.com/opennms/opennms-bigpanda-plugin
OpenNMS <-> BigPanda
https://github.com/opennms/opennms-bigpanda-plugin
Last synced: 8 months ago
JSON representation
OpenNMS <-> BigPanda
- Host: GitHub
- URL: https://github.com/opennms/opennms-bigpanda-plugin
- Owner: OpenNMS
- Created: 2020-09-02T17:26:30.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-10-05T14:03:01.000Z (over 5 years ago)
- Last Synced: 2025-02-16T08:13:15.669Z (over 1 year ago)
- Language: Java
- Size: 27.3 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OpenNMS BigPanda Plugin
## Usage
Download the plugin's .kar file into your OpenNMS deploy directory i.e.:
```
sudo wget https://github.com/OpenNMS/opennms-bigpanda-plugin/releases/download/alpha1/opennms-bigpanda-plugin.kar -P /opt/opennms/deploy/
```
Configure the plugin to be installed when OpenNMS starts:
```
echo 'opennms-plugins-bigpanda wait-for-kar=opennms-bigpanda-plugin' | sudo tee /opt/opennms/etc/featuresBoot.d/bigpanda.boot
```
Access the [Karaf shell](https://opennms.discourse.group/t/karaf-cli-cheat-sheet/149) and install the feature manually to avoid having to restart:
```
feature:install opennms-plugins-bigpanda
```
Configure settings:
```
config:edit org.opennms.integrations.bigpanda
property-set accessToken YOUR-TOKEN-HERE
property-set applicationKey YOUR-APP-KEY-HERE
config:update
```
Verify your setup:
```
opennms:health-check
```
View alert/event statistics:
```
opennms-bigpanda:stats
```
## Building
Build and install the plugin into your local Maven repository using:
```
mvn clean install
```
> OpenNMS normally runs as root, so make sure the artifacts are installed in `/root/.m2` or try making `/root/.m2` symlink to your user's repository
From the OpenNMS Karaf shell:
```
feature:repo-add mvn:org.opennms.plugins/karaf-features/1.0.0-SNAPSHOT/xml
feature:install opennms-plugins-bigpanda
```
Configure your API keys:
```
config:edit org.opennms.integrations.bigpanda
property-set accessToken YOUR-TOKEN-HERE
property-set applicationKey YOUR-APP-KEY-HERE
config:update
```
Alarms should now be forwarded as alerts to BigPanda.
You can use the following shell command to see statistics about how many alerts were forwarded:
```
opennms-bigpanda:stats
```
You can also try forwarding the topology using:
```
opennms-bigpanda:push-topology
```