diff --git a/ibm_ace/README.md b/ibm_ace/README.md index f64e9f9897576..b3ee273680d87 100644 --- a/ibm_ace/README.md +++ b/ibm_ace/README.md @@ -6,8 +6,6 @@ This check monitors [IBM ACE][1] 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][3] for guidance on applying these instructions. - ### IBM MQ An [IBM MQ][10] server is required for consuming metric messages from IBM ACE. @@ -72,11 +70,33 @@ The IBM ACE check is included in the [Datadog Agent][2] package. No additional installation is needed on your server. ### Configuration + + + +#### Host + +To configure this check for an Agent running on a host: 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][4] for all available configuration options. 2. [Restart the Agent][5]. + + + +#### Containerized + +For containerized environments, see the [Autodiscovery Integration Templates][3] for guidance on applying the parameters below. + +| Parameter | Value | +| -------------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| `` | `ibm_ace` | +| `` | blank or `{}` | +| `` | `{"channel": "", "queue_manager": "", "mq_server":"", "port":"%%port%%"}` | + + + + ### Validation [Run the Agent's status subcommand][6] and look for `ibm_ace` under the Checks section.