README.md edited online with Bitbucket

This commit is contained in:
Mark Nellemann 2020-08-14 14:12:44 +00:00
parent b6b45e7144
commit cfcdb76dcf
1 changed files with 9 additions and 8 deletions

View File

@ -5,20 +5,21 @@ Small utility to fetch metrics from one or more HMC's and push those to an Influ
## Usage Instructions
- Ensure you have correct date/time and NTP running to keep it accurate.
- Ensure you have correct date/time and NTP running to keep it accurate!
- Install jar, 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 :)
Copy the *doc/hmci.groovy.tpl* file into */etc/hmci.groovy*, change the configuration to suit your environment and run the program:
/opt/hmci/bin/hmci
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.
## Development Information
You need JDK version 8 or later.
### Build & Test
Use the gradle build tool
Use the gradle-wrapper build tool
./gradlew clean build
@ -40,4 +41,4 @@ Start the Grafana container, linking it to the InfluxDB container
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.
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.