Update IBM plugin documentation. (#21122)
Austin S. Hemmelgarn committed
Oct 9, 2025 at 10:25 UTC
17e5149a61c77aae8a9e6d3c8396646ea316070d
1 file changed
+12
-47
src/go/plugin/ibm.d/README.md
+12
-47
@@ -47,44 +47,23 @@ The IBM monitoring plugin requires specific libraries depending on which systems
47
|--------|-------------------|-----------------|
48
| IBM i (AS/400) | unixODBC + IBM i Access ODBC Driver | IBM i 7.2+ |
49
| IBM DB2 | unixODBC + IBM DB2 ODBC Driver | DB2 10.5+ |
50
-| IBM MQ | IBM MQ Redistributable Client | MQ 8.0+ |
51
-| WebSphere | IBM MQ Client (for JMX bridge) | WAS 8.5+ |
50
51
## Installation
52
55
-### Step 1: Install unixODBC (for Database Monitoring)
53
+### Using native DEB/RPM packages
54
57
-**Ubuntu/Debian:**
58
-```bash
59
-sudo apt-get update
60
-sudo apt-get install unixodbc unixodbc-dev
61
-```
55
+After installing Netdata normally, use your system package manager to
56
+install the `netdata-plugin-ibm` package.
57
63
-**RHEL/CentOS/Fedora:**
64
-```bash
65
-sudo yum install unixODBC unixODBC-devel
66
-# or for newer versions:
67
-sudo dnf install unixODBC unixODBC-devel
68
-```
58
+### Using a local build
59
70
-**SUSE/openSUSE:**
71
-```bash
72
-sudo zypper install unixODBC unixODBC-devel
73
-```
74
-
75
-### Step 2: Install IBM Libraries
60
+1. Ensure that unixODBC development files are installed (depending on
61
+ your platform the required package will usually be either `unixodbc-dev`
62
+ or `unixODBC-devel`).
63
+2. Add `--local-build-options "--enable-plugin-ibm"` to the options you
64
+ pass to the `kickstart.sh` script for the install.
65
77
-#### For IBM MQ Monitoring
78
-
79
-The IBM MQ client libraries are automatically installed when you build Netdata with IBM support:
80
-
81
-```bash
82
-sudo /usr/libexec/netdata/install-ibm-libs.sh
83
-```
84
-
85
-This downloads and installs the IBM MQ Redistributable Client (version 9.4.1.0) from IBM's public repository.
86
-
87
-#### For IBM i (AS/400) Monitoring
66
+### IBM i (AS/400) Monitoring Additional Setup
67
68
1. **Download IBM i Access Client Solutions** from IBM:
69
- Go to [IBM i Access Client Solutions](https://www.ibm.com/support/pages/ibm-i-access-client-solutions)
@@ -123,7 +102,7 @@ This downloads and installs the IBM MQ Redistributable Client (version 9.4.1.0)
102
Trace = 0
103
```
104
126
-#### For IBM DB2 Monitoring
105
+#### IBM DB2 Monitoring Additional Setup
106
107
1. **Download IBM Data Server Driver Package** from IBM:
108
- Visit [IBM Data Server Driver Downloads](https://www.ibm.com/support/pages/download-initial-version-115-clients-and-drivers)
@@ -153,20 +132,6 @@ This downloads and installs the IBM MQ Redistributable Client (version 9.4.1.0)
132
PWD = your_password
133
```
134
156
-### Step 3: Build and Install Netdata with IBM Support
157
-
158
-```bash
159
-# Clone Netdata repository
160
-git clone https://github.com/netdata/netdata.git
161
-cd netdata
162
-
163
-# Build with IBM plugin support
164
-mkdir build-ibm && cd build-ibm
165
-cmake -DENABLE_PLUGIN_IBM=On ..
166
-make ibm-plugin
167
-sudo make install
168
-```
169
-
135
## Configuration
136
137
Configuration files are located in `/etc/netdata/ibm.d/`. Each collector has its own configuration file:
@@ -382,4 +347,4 @@ curl http://localhost:19999/api/v1/alarms | jq '.alarms'
347
348
## License
349
385
-The IBM monitoring plugin is part of Netdata and is released under the GPL v3+ license. IBM client libraries are subject to IBM's licensing terms.
\ No newline at end of file
350
+The IBM monitoring plugin is part of Netdata and is released under the GPL v3+ license. IBM client libraries are subject to IBM's licensing terms.