diff --git a/README.md b/README.md index 866c3f6..9c520a8 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,29 @@ # HMC Insights -Small utility to fetch metrics from one or more HMC's and push those to an InfluxDB time-series database. +HMCi is a small utility to fetch metrics from one or more HMC's and push those to an InfluxDB time-series database. ## Usage Instructions - 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 +- Install HMCi *.deb* or *.rpm* file from [downloads](https://bitbucket.org/mnellemann/hmci/downloads/) or compile from source - 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 :) -### Notes +#### Notes -Examples on how to change the default retention policy: +Examples on how to change the default InfluxDB retention policy: ALTER RETENTION POLICY "autogen" ON "hmci" DURATION 156w ALTER RETENTION POLICY "autogen" ON "hmci" DURATION 90d +#### InfluxDB and Grafana Packages + +You can download [Grafana ppc64le](https://www.power-devops.com/grafana) and [InfluxDB ppc64le](https://www.power-devops.com/influxdb) packages for most Linux distributions and AIX on the [Power DevOps](https://www.power-devops.com/) site. + +Binaries for amd64/x86 are available from the [Grafana website](https://grafana.com/grafana/download) and [InfluxDB website](https://portal.influxdata.com/downloads/) and also directly from your Linux distribution repository in some cases. ## Development Information @@ -26,12 +31,12 @@ You need JDK version 8 or later. ### Build & Test -Use the gradle-wrapper build tool +Use the gradle build tool, which will download all required dependencies. ./gradlew clean build -### InfluxDB for local testing +#### InfluxDB for local testing Start the InfluxDB container @@ -42,7 +47,7 @@ To use the Influx client from the same container docker exec -it influxdb influx -### Grafana for local testing +#### Grafana for local testing Start the Grafana container, linking it to the InfluxDB container