Skip to content

Latest commit

 

History

History

ibm_db2

README.md

Agent Check: IBM Db2

default dashboard

Overview

This check monitors IBM Db2 through the Datadog Agent.

Setup

Installation

The IBM Db2 check is included in the Datadog Agent package.

Dependencies

The ibm_db client library is required. To install it, ensure you have a working compiler and run:

Unix
/opt/datadog-agent/embedded/bin/pip install ibm_db==3.0.1
Windows

For Agent versions <= 6.11:

"C:\Program Files\Datadog\Datadog Agent\embedded\python.exe" -m pip install ibm_db==3.0.1

For Agent versions >= 6.12:

"C:\Program Files\Datadog\Datadog Agent\embedded<PYTHON_MAJOR_VERSION>\python.exe" -m pip install ibm_db==3.0.1

On Linux there may be need for XML functionality. If you encounter errors during the build process, install libxslt-dev (or libxslt-devel for RPM).

Privileges

To query metrics from certain tables, specific privileges must be granted to the chosen Db2 user. Switch to the instance master user and run these commands at the db2 prompt:

update dbm cfg using HEALTH_MON on
update dbm cfg using DFT_MON_STMT on
update dbm cfg using DFT_MON_LOCK on
update dbm cfg using DFT_MON_TABLE on
update dbm cfg using DFT_MON_BUFPOOL on

Now if you run get dbm cfg, you should see the following:

 Default database monitor switches
   Buffer pool                         (DFT_MON_BUFPOOL) = ON
   Lock                                   (DFT_MON_LOCK) = ON
   Sort                                   (DFT_MON_SORT) = OFF
   Statement                              (DFT_MON_STMT) = ON
   Table                                 (DFT_MON_TABLE) = ON
   Timestamp                         (DFT_MON_TIMESTAMP) = ON
   Unit of work                            (DFT_MON_UOW) = OFF
 Monitor health of instance and databases   (HEALTH_MON) = ON

Configuration

Host

Follow the instructions below to configure this check for an Agent running on a host. For containerized environments, see the Containerized section.

Metric collection

  1. Edit the ibm_db2.d/conf.yaml file, in the conf.d/ folder at the root of your Agent's configuration directory to start collecting your ibm_db2 performance data. See the sample ibm_db2.d/conf.yaml for all available configuration options.

  2. Restart the Agent.

Log collection

Available for Agent versions >6.0

  1. Collecting logs is disabled by default in the Datadog Agent, enable it in your datadog.yaml file:

    logs_enabled: true

  2. Add this configuration block to your ibm_db2.d/conf.yaml file to start collecting your IBM Db2 logs:

    logs:
  - type: file
    path: /home/db2inst1/sqllib/db2dump/db2diag.log
    source: ibm_db2
    service: db2sysc
    log_processing_rules:
      - type: multi_line
        name: new_log_start_with_date
        pattern: \d{4}\-(0?[1-9]|[12][0-9]|3[01])\-(0?[1-9]|1[012])

  3. Restart the Agent.

Containerized

For containerized environments, see the Autodiscovery Integration Templates for guidance on applying the parameters below.

Metric collection
Parameter Value
<INTEGRATION_NAME> ibm_db2
<INIT_CONFIG> blank or {}
<INSTANCE_CONFIG> {"db": "<DB_NAME>", "username":"<USERNAME>", "password":"<PASSWORD>", "host":"%%host%%", "port":"%%port%%"}
Log collection

Available for Agent versions >6.0

Collecting logs is disabled by default in the Datadog Agent. To enable it, see Kubernetes log collection documentation.

Parameter Value
<LOG_CONFIG> `{"source": "ibm_db2", "service": "<SERVICE_NAME>", "log_processing_rules": {"type":"multi_line","name":"new_log_start_with_date", "pattern":"\d{4}-(0?[1-9]

Validation

Run the Agent's status subcommand and look for ibm_db2 under the Checks section.

Data Collected

Metrics

See metadata.csv for a list of metrics provided by this integration.

Service Checks

ibm_db2.can_connect:
Returns CRITICAL if the Agent is unable to connect to the monitored IBM Db2 database, otherwise returns OK.

ibm_db2.status:
Returns CRITICAL if the monitored IBM Db2 database is quiesced, WARNING for quiesce-pending or rollforwards, otherwise returns OK.

Events

  • ibm_db2.tablespace_state_change is triggered whenever the state of a tablespace changes.

Troubleshooting

Need help? Contact Datadog support.

Further Reading

Additional helpful documentation, links, and articles: