nellemann/hmci
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Cleanup README.

Browse source
This commit is contained in:
Mark Nellemann 2021-03-25 21:09:21 +01:00
parent 00e24b8abb
commit 5ba6678062
1 changed files with 35 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -1,8 +1,9 @@
# HMC Insights # HMC Insights
**HMCi** is a utility that collects metrics from one or more *IBM Power HMC* systems. The metric data is processed and saved into an InfluxDB time-series database. Grafana can be used to visualize the metrics from InfluxDB. This software is not supported or endorsed by International Business Machines (IBM). **HMCi** is a utility that collects metrics from one or more *IBM Power HMC*. The metric data is processed and saved into an InfluxDB time-series database. Grafana can be used to visualize the metrics from InfluxDB. This software is free to use and icensed under the Apache [License](https://bitbucket.org/mnellemann/hmci/src/master/LICENSE), Version 2.0, but is not supported or endorsed by International Business Machines (IBM).
Metrics includes: Metrics includes:
- *Managed Systems* - the physical Power servers - *Managed Systems* - the physical Power servers
- *Logical Partitions* - the virtualized servers running AIX, Linux and IBM-i (AS/400) - *Logical Partitions* - the virtualized servers running AIX, Linux and IBM-i (AS/400)
- *Virtual I/O Servers* - the i/o partition(s) taking care of network and storage - *Virtual I/O Servers* - the i/o partition(s) taking care of network and storage
@ -53,12 +54,13 @@ From version 1.2 *HMCi* is made compatible with the similar [nextract Plus](http
### Start InfluxDB and Grafana at boot on RedHat 7+ ### Start InfluxDB and Grafana at boot on RedHat 7+
```shell
systemctl enable influxdb systemctl enable influxdb
systemctl start influxdb systemctl start influxdb
systemctl enable grafana-server systemctl enable grafana-server
systemctl start grafana-server systemctl start grafana-server
```
### InfluxDB Retention Policy ### InfluxDB Retention Policy
@ -66,8 +68,10 @@ Per default the *hmci* influx database has no retention policy, so data will be
Examples for changing the default InfluxDB retention policy for the hmci database: Examples for changing the default InfluxDB retention policy for the hmci database:
```text
ALTER RETENTION POLICY "autogen" ON "hmci" DURATION 156w ALTER RETENTION POLICY "autogen" ON "hmci" DURATION 156w
ALTER RETENTION POLICY "autogen" ON "hmci" DURATION 90d ALTER RETENTION POLICY "autogen" ON "hmci" DURATION 90d
```
## Grafana Screenshots ## Grafana Screenshots
@ -89,9 +93,9 @@ written to InfluxDB (which uses the name as key).
If you rename a partition, the metrics in InfluxDB will still be available by the old name, and new metrics will be available by the new name of the partition. There is no easy way to migrate the old data, but you can delete it easily: If you rename a partition, the metrics in InfluxDB will still be available by the old name, and new metrics will be available by the new name of the partition. There is no easy way to migrate the old data, but you can delete it easily:
```text
DELETE WHERE partition = 'lpar-name'; DELETE WHERE partition = 'lpar-name';
```
## Development Information ## Development Information
@ -102,8 +106,9 @@ You need Java (JDK) version 8 or later to build hmci.
Use the gradle build tool, which will download all required dependencies: Use the gradle build tool, which will download all required dependencies:
```shell
./gradlew clean build ./gradlew clean build
```
### Local Testing ### Local Testing
@ -111,18 +116,23 @@ Use the gradle build tool, which will download all required dependencies:
Start the InfluxDB container: Start the InfluxDB container:
```shell
docker run --name=influxdb --rm -d -p 8086:8086 influxdb:1.8-alpine docker run --name=influxdb --rm -d -p 8086:8086 influxdb:1.8-alpine
```
To execute the Influx client from within the container: To execute the Influx client from within the container:
```shell
docker exec -it influxdb influx docker exec -it influxdb influx
```
#### Grafana container #### Grafana container
Start the Grafana container, linking it to the InfluxDB container: Start the Grafana container, linking it to the InfluxDB container:
```shell
docker run --name grafana --link influxdb:influxdb --rm -d -p 3000:3000 grafana/grafana:7.1.3 docker run --name grafana --link influxdb:influxdb --rm -d -p 3000:3000 grafana/grafana:7.1.3
```
Setup Grafana to connect to the InfluxDB container by defining a new datasource on URL *http://influxdb:8086* named *hmci*. Setup Grafana to connect to the InfluxDB container by defining a new datasource on URL *http://influxdb:8086* named *hmci*.