Overview

This check monitors IBM ACE through the Datadog Agent.

Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.

IBM MQ

An IBM MQ server is required for consuming metric messages from IBM ACE.

IBM ACE

1. Ensure at least version 12.0.2.0 is installed.
2. Apply an MQEndpoint policy file named in the form <MQ_POLICY_NAME>.policyxml that would look like this:

   <?xml version="1.0" encoding="UTF-8"?>
   <policies>
       <policy policyType="MQEndpoint" policyName="<MQ_POLICY_NAME>" policyTemplate="MQEndpoint">
           <connection>CLIENT</connection>
           <destinationQueueManagerName>...</destinationQueueManagerName>
           <queueManagerHostname>...</queueManagerHostname>
           <listenerPortNumber>1414</listenerPortNumber>
           <channelName>...</channelName>
           <securityIdentity><MQ_SECURITY_IDENTITY></securityIdentity>
       </policy>
   </policies>
   

3. Set the credentials by running: mqsisetdbparms -n mq::<MQ_SECURITY_IDENTITY> -u <user> -p <password>
4. Update your server.conf.yaml file with the following config:

   remoteDefaultQueueManager: '{DefaultPolicies}:<MQ_POLICY_NAME>'
   Events:
     OperationalEvents:
       MQ:
         enabled: true
     BusinessEvents:
       MQ:
         enabled: true
         outputFormat: json
   Statistics:
     Resource:
       reportingOn: true
     Snapshot:
       publicationOn: active
       outputFormat: json
       accountingOrigin: basic
       nodeDataLevel: advanced
       threadDataLevel: basic
   Monitoring:
     MessageFlow:
       publicationOn: active
       eventFormat: MonitoringEventV2
   AdminLog:
     enabled: true
     fileLog: true
     consoleLog: true
     consoleLogFormat: ibmjson
   

5. Restart IBM ACE.

Installation

The IBM ACE check is included in the Datadog Agent package. No additional installation is needed on your server.

Configuration

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

2. Restart the Agent.

Validation

Run the Agent’s status subcommand and look for ibm_ace under the Checks section.

Data Collected

Metrics

Events

The IBM ACE integration does not include any events.

Service Checks

ibm_ace.mq.subscription
Returns CRITICAL if the subscription encounters an error, WARNING if no messages are available, or OK otherwise.
Statuses: ok, warning, critical

Log collection

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

   logs_enabled: true
   

2. To start collecting your IBM ACE logs, add this configuration block to your ibm_ace.d/conf.yaml file:

   logs:
     - type: file
       path: /home/aceuser/ace-server/log/integration_server.txt
       source: ibm_ace
   

   Change the path parameter value based on your environment. See the sample ibm_ace.d/conf.yaml file for all available configuration options.

Troubleshooting

Need help? Contact Datadog support.