Back to Netdata

IBM.d Modules Directory

src/go/plugin/ibm.d/modules/README.md

2.10.31.6 KB
Original Source

IBM.d Modules Directory

Each subdirectory under modules/ contains a fully self-contained IBM.D collector. A module typically includes:

modules/<name>/
├── collector.go          # orchestration logic
├── collect_*.go          # protocol-specific data fetchers
├── config.go             # module configuration
├── contexts/             # declarative metric definitions + generated code
├── module.yaml           # metadata for docgen
├── README.md             # module-specific documentation
├── metadata.yaml         # generated Netdata marketplace entry
├── config_schema.json    # generated JSON schema
└── ...

Current modules:

ModuleMonitorsNotes
as400IBM i/AS/400 systemsUses the DB2 ODBC bridge; exports system, job, storage metrics.
db2IBM DB2 databases (LUW, i, z/OS)Extensive coverage of buffer pools, locking, tablespaces, memory.
mqIBM MQ queue managersUses MQ PCF protocol for queues, channels, listeners, stats.
websphere/jmxWebSphere via helper JMX bridgeRequires the Java helper shipped with the plugin.
websphere/mpWebSphere Liberty / Open Liberty (MicroProfile)Uses the generic OpenMetrics protocol.
websphere/pmiWebSphere Traditional PMI PerfServletParses PMI XML snapshots.

Common helpers live in ../framework and ../protocols. When adding a new module, follow the workflow described there and ensure go generate keeps metadata in sync.