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

Update architecture drawing and move into doc/ folder.

Browse source
This commit is contained in:
Mark Nellemann 2022-05-16 16:33:27 +02:00
parent 1274e37c51
commit 907721b112
4 changed files with 15 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -2,7 +2,7 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [1.3.1] - 2022-04-xx ## [1.3.1] - 2022-05-xx
### Added ### Added
- Default configuration location on Windows platform. - Default configuration location on Windows platform.

29
README.md
View file

@ -1,26 +1,26 @@
# HMC Insights # HMC Insights
**HMCi** is a utility that collects metrics from one or more *IBM Power HMC*, without the need to install any agents. 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 is licensed under the [Apache 2.0 License](https://bitbucket.org/mnellemann/syslogd/src/master/LICENSE), but is not supported or endorsed by International Business Machines (IBM). There is an optional [companion agent](https://bitbucket.org/mnellemann/sysmon/) application, which provides more metrics from within AIX and Linux. **HMCi** is a utility that collects metrics from one or more *IBM Power Hardware Management Consoles (HMC)*, without the need to install agents on logical partitions / virtual machines running on the IBM Power systems. The metric data is processed and saved into an InfluxDB time-series database. Grafana is used to visualize the metrics from InfluxDB through provided dashboards or your own custom dashboards. This software is free to use and is licensed under the [Apache 2.0 License](https://bitbucket.org/mnellemann/syslogd/src/master/LICENSE), but is not supported or endorsed by International Business Machines (IBM). There is an optional [companion agent](https://bitbucket.org/mnellemann/sysmon/) application, which provides more metrics from within AIX and Linux.
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) virtualizing network and storage - *Virtual I/O Servers* - the i/o partition(s) virtualizing network and storage
- *Energy* - power consumption and temperatures (needs to be enabled and is not available for P7, E870, E880 and E980) - *Energy* - power consumption and temperatures (needs to be enabled and is not available for old and multi-chassis systems)
![architecture](https://bitbucket.org/mnellemann/hmci/downloads/HMCi.png) ![architecture](doc/HMCi.png)
## Installation and Setup ## Installation and Setup
There are few steps in the installation. There are few steps in the installation.
1) Preparations on the Hardware Management Console (HMC) 1. Preparations on the Hardware Management Console (HMC)
2) Installation of InfluxDB and Grafana software on a Linux LPAR or VM 2. Installation of InfluxDB and Grafana software
3) Installation and configuration of the HMCi software 3. Installation and configuration of *HMC Insights*
4) Configure Grafana and import example dashboards 4. Configure Grafana and import example dashboards
### 1 - Power HMC Setup Instructions ### 1 - IBM Power HMC Setup Instructions
- Login to your HMC - Login to your HMC
- Navigate to *Console Settings* - Navigate to *Console Settings*
@ -32,24 +32,21 @@ There are few steps in the installation.
- Create a new read-only **hmci** user, which will be used to connect to the REST API. - Create a new read-only **hmci** user, which will be used to connect to the REST API.
- Click *Manage User Profiles and Access*, edit the newly created *hmci* user and click *User Properties*: - Click *Manage User Profiles and Access*, edit the newly created *hmci* user and click *User Properties*:
- **Enable** *Allow remote access via the web* - **Enable** *Allow remote access via the web*
- Set *Session timeout minutes* to **120**
- Set *Verify timeout minutes* to **15**
- Set *Idle timeout minutes* to **15**
- Set *Minimum time in days between password changes* to **0** - Set *Minimum time in days between password changes* to **0**
- Navigate to *HMC Management* and *Console Settings* - Navigate to *HMC Management* and *Console Settings*
- Click *Change Performance Monitoring Settings*: - Click *Change Performance Monitoring Settings*:
- Enable *Performance Monitoring Data Collection for Managed Servers*: **All On** - Enable *Performance Monitoring Data Collection for Managed Servers*: **All On**
- Set *Performance Data Storage* to **1** day or preferable more - Set *Performance Data Storage* to **1** day or preferable more
If you do not enable *Performance Monitoring Data Collection for Managed Servers*, you will see errors such as *Unexpected response: 403*. Use the *hmci* debug flag to get more details about what is going on. If you do not enable *Performance Monitoring Data Collection for Managed Servers*, you will see errors such as *Unexpected response: 403*. Use the HMCi debug option to get more details about what is going on.
### 2 - InfluxDB and Grafana Installation ### 2 - InfluxDB and Grafana Installation
Install InfluxDB (v. **1.8** for best compatibility with Grafana) on an LPAR or VM, which is network accessible by the *HMCi* utility (the default InfluxDB port is 8086). You can install Grafana on the same server or any server which are able to connect to the InfluxDB database. The Grafana installation needs to be accessible from your browser (default on port 3000). The default settings for both InfluxDB and Grafana will work fine as a start. Install InfluxDB (v. **1.8.x** or **1.9.x** for best compatibility with Grafana) on a host which is network accessible by the HMCi utility (the default InfluxDB port is 8086). You can install Grafana on the same server or any server which are able to connect to the InfluxDB database. The Grafana installation needs to be accessible from your browser (default on port 3000). The default settings for both InfluxDB and Grafana will work fine as a start.
- 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. - 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 most likely directly from your Linux distributions repositories. - Binaries for amd64/x86 are available from the [Grafana website](https://grafana.com/grafana/download) and [InfluxDB website](https://portal.influxdata.com/downloads/) and most likely directly from your Linux distributions repositories.
- Create the empty *hmci* database through the **influx** cli command: - Create the empty *hmci* database by using running the **influx** cli command and type:
```text ```text
CREATE DATABASE "hmci" WITH DURATION 365d REPLICATION 1; CREATE DATABASE "hmci" WITH DURATION 365d REPLICATION 1;
@ -59,7 +56,7 @@ See the [Influx documentation](https://docs.influxdata.com/influxdb/v1.8/query_l
### 3 - HMCi Installation & Configuration ### 3 - HMCi Installation & Configuration
Install *HMCi* on a host, which can connect to the Power HMC through HTTPS, and is able to connect to the InfluxDB service. This *can be* the same LPAR/VM as used for the InfluxDB installation. Install *HMCi* on a host, which can connect to the Power HMC (on port 12443), and is also allowed to connect to the InfluxDB service. This *can be* the same LPAR/VM as used for the InfluxDB installation.
- Ensure you have **correct date/time** and NTPd running to keep it accurate! - Ensure you have **correct date/time** and NTPd running to keep it accurate!
- The only requirement for **hmci** is the Java runtime, version 8 (or later) - The only requirement for **hmci** is the Java runtime, version 8 (or later)
@ -74,7 +71,7 @@ Install *HMCi* on a host, which can connect to the Power HMC through HTTPS, and
- Configure Grafana to use InfluxDB as a new datasource - Configure Grafana to use InfluxDB as a new datasource
- **NOTE:** set *Min time interval* to *30s* or *1m* depending on your HMCi *refresh* setting. - **NOTE:** set *Min time interval* to *30s* or *1m* depending on your HMCi *refresh* setting.
- Import example dashboards from the *doc/* folder into Grafana as a starting point and get creative making your own cool dashboards :) - Import example dashboards from [doc/*.json](doc/) into Grafana as a starting point and get creative making your own cool dashboards :)
## Notes ## Notes

1
doc/HMCi.drawio Normal file
View file

@ -0,0 +1 @@
<mxfile host="Electron" modified="2022-05-14T12:28:36.816Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/18.0.1 Chrome/100.0.4896.143 Electron/18.2.0 Safari/537.36" etag="VTeDZyRfgTqFOkUEwK2w" version="18.0.1" type="device"><diagram id="a7nnNqAxPxhrp0sOKCIs" name="Page-1">3VrbcqM4EP0aPybFHfwYx7nNJNnUTk3tvE0JEFgbQIwQvuzXrwQCWyAckglr106lJtBqJNHnnFZLZGZep9s7AvLVEw5hMjO0cDszlzPD0C3DmPEfLdzVFs81a0NMUCic9oZv6B8ojJqwliiEheRIMU4oymVjgLMMBlSyAULwRnaLcCKPmoMY9gzfApD0rX+hkK6EVXfm+4Z7iOKVGNoz3LohBY2zeJNiBUK8OTCZNzPzmmBM66t0ew0THrwmLvVztwOt7cQIzOiYB+DXCwMCA6w3y+/P2cJ6zm7LC0vMje6aF4Yhe39xiwld4RhnILnZWxcEl1kIea86u9v7PGKcC+PfkNKdABOUFDPTiqaJaC1eIQ1W4gZm4RXHid1mOIO15RYl3FnjzhQQ2nj4CQ5eG6Nw4p30YyHCU+CSBPBIABpOARJDesRPsJZH52AAEek7iFNIyY45EJgAitYye4AgYdz67XFiFwKqd8Am+l2DpBQjPWRRUm6Xix6ejHY5vwx2CWKwETbpxWaFKPyWgyoyGyZcGR+/BvjRbw0geI0r2P8oKesGNkDWCOs2u44YGtc4waQa1owi6ARBBRXBr/CgJXTnvqZ1aTCI4BoSCrdHYy5aLUcoTaQa165vN3vdNh6rQ8VqE4Fkn1xbH5eFMVIW+lnJwujJYmY4CZv/IkRrdhnTKii1yW8M909sNO0hKzgniqaZTcDvPsJsUkcDUssJDmBRjBDagK46WoJ6aENXpaW545rA6cLerjRcZXEC+FSqa5ldnyA5w51LkvP6ktMNheacqTRnjmEAK1UikIEhVHv+S1CsfAxIWIx+hP0GKUe7/p9N6SphUUVZ3NKPfJBdIQ7KtILs3Xm8l6MjYyBHO75j93j1CYSx3TdztJIwkyVp9+RJelSB81aV9PFM74zM9MapMn1f0jkLObPohmWZSvgegc+2IVLIQYLijJdBLECQsXzBOYtYnX8lGlIUhjW6kJU1wK/646HNMcpoNX97MbOXymAfo1ZPHO1mRQwi7QdUornQLi3H1CXhNJludLhF7y/8bQ667ujRMuQecBQVjBZduNo5flx4zphM/bB4Gp8ve0+/4A2D2tCqBX5UjpWV/UZ67WTTEEAvUmZTJ/CgH01R8crgNYnzMJnaimTqTpVM56dIpiFbndvnzymzeueeWY/NerQuT63CYbVJxBgU67SS1C1FgTOVJlHyM17nc7h7vvp6m/7are+jX4o90Z9lxgpZDWe8Kn34MeNpo1utPqKs3P4eMMfCH1X/+O6EgBCxaDdtQoJTHw3ojnfZB8YwFcBYUwEzaqvyBazZPkVjouSoMOQoSqEA78PrIsh4aETXRZnzeoohxWLMEkyESXo5hVDPiQ/tfqLlg2LpVO1DbPf32WANFbSe5jnnUc8OBfTdpavVvFFTX3rvrVBNGahO/D+lPrWHADE1TfufAWJrMvOPbazVgOiGIfVwoTsTYOKdopSUCsYm9RzUi5pcLwb8aA0FUsnYL0lCGIGyyqbvP5t1R5aQJ/s60exxDxexgXOrMk2uAooPpVHJ6AUXiCLMJeJjSnGq0A7FncUE1+el1+1Xvyk+KHh6t5hTVQ2qouEzzjfvy2VU0J8L6+4i+PIjAw9o8/00OyxFXDtMe5PIypcZu0Ey/yMyH5vk2TJcsST0sBjNcMUJwifRm93uP3XX68H+DwbMm38B</diagram></mxfile>

BIN
doc/HMCi.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 107 KiB