master
md 29 lines 1.56 KB
Rendered Raw
1 # IBM.d Modules Directory
2
3 Each subdirectory under `modules/` contains a fully self-contained IBM.D collector. A module typically includes:
4
5 ```
6 modules/<name>/
7 ├── collector.go # orchestration logic
8 ├── collect_*.go # protocol-specific data fetchers
9 ├── config.go # module configuration
10 ├── contexts/ # declarative metric definitions + generated code
11 ├── module.yaml # metadata for docgen
12 ├── README.md # module-specific documentation
13 ├── metadata.yaml # generated Netdata marketplace entry
14 ├── config_schema.json # generated JSON schema
15 └── ...
16 ```
17
18 Current modules:
19
20 | Module | Monitors | Notes |
21 |--------|----------|-------|
22 | `as400` | IBM i/AS/400 systems | Uses the DB2 ODBC bridge; exports system, job, storage metrics. |
23 | `db2` | IBM DB2 databases (LUW, i, z/OS) | Extensive coverage of buffer pools, locking, tablespaces, memory. |
24 | `mq` | IBM MQ queue managers | Uses MQ PCF protocol for queues, channels, listeners, stats. |
25 | `websphere/jmx` | WebSphere via helper JMX bridge | Requires the Java helper shipped with the plugin. |
26 | `websphere/mp` | WebSphere Liberty / Open Liberty (MicroProfile) | Uses the generic OpenMetrics protocol. |
27 | `websphere/pmi` | WebSphere Traditional PMI PerfServlet | Parses PMI XML snapshots. |
28
29 Common helpers live in [`../framework`](../framework/README.md) and [`../protocols`](../protocols/README.md). When adding a new module, follow the workflow described there and ensure `go generate` keeps metadata in sync.