hmci/README.md

52 lines
1.7 KiB
Markdown
Raw Normal View History

# HMC Insights
Small utility to fetch metrics from one or more HMC's and push those to an InfluxDB time-series database.
2020-08-13 20:01:22 +00:00
## Usage Instructions
2020-08-14 14:12:44 +00:00
- Ensure you have correct date/time and NTP running to keep it accurate!
- Install *.deb* or *.rpm* file from [downloads](https://bitbucket.org/mnellemann/hmci/downloads/) or compile from source
2020-08-14 14:12:44 +00:00
- Copy the *doc/hmci.groovy.tpl* configuration template into */etc/hmci.groovy* and edit the configuration to suit your environment
- Configure Grafana to communicate with your InfluxDB and import dashboards from *doc/* into Grafana (The dashboards are slightly modified versions of the dashboard provided by the nmon2influxdb tool)
- Run the *bin/hmci* program in a shell, as a @reboot cron task or setup a proper service :)
2020-09-02 07:27:38 +00:00
### Notes
Examples on how to change the default retention policy:
ALTER RETENTION POLICY "autogen" ON "hmci" DURATION 156w
ALTER RETENTION POLICY "autogen" ON "hmci" DURATION 90d
## Development Information
2020-08-14 14:12:44 +00:00
You need JDK version 8 or later.
### Build & Test
2020-08-14 14:12:44 +00:00
Use the gradle-wrapper build tool
./gradlew clean build
### InfluxDB for local testing
Start the InfluxDB container
2020-08-13 09:48:00 +00:00
docker run --name=influxdb --rm -d -p 8086:8086 influxdb
To use the Influx client from the same container
docker exec -it influxdb influx
### Grafana for local testing
Start the Grafana container, linking it to the InfluxDB container
2020-08-13 09:48:00 +00:00
docker run --name grafana --link influxdb:influxdb --rm -d -p 3000:3000 grafana/grafana:7.1.3
Configure a new InfluxDB datasource on *http://influxdb:8086* named *hmci* to connect to the InfluxDB container. The database must be created beforehand, this can be done by running the hmci tool first. Grafana dashboards can be imported from the *doc/* folder.