Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add instructions for containerized environments #17408

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add instructions for containerized environments #17408

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a31cd19
Add instructions for containerized environments
stzou Apr 17, 2024
c8b0a99
Merge branch 'master' into stzou-IBM-ACE-doc-update
stzou May 1, 2024
ad99a84
Merge branch 'master' into stzou-IBM-ACE-doc-update
stzou May 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 22 additions & 2 deletions ibm_ace/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
<!-- xxx tabs xxx -->
<!-- xxx tab "Host" xxx -->

#### 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].

<!-- xxz tab xxx -->
<!-- xxx tab "Containerized" xxx -->

#### Containerized

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

| Parameter | Value |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `<INTEGRATION_NAME>` | `ibm_ace` |
| `<INIT_CONFIG>` | blank or `{}` |
| `<INSTANCE_CONFIG>` | `{"channel": "<CHANNEL>", "queue_manager": "<QUEUE_MANAGER>", "mq_server":"<MQ_SERVER>", "port":"%%port%%"}` |

<!-- xxz tab xxx -->
<!-- xxz tabs xxx -->

### Validation

[Run the Agent's status subcommand][6] and look for `ibm_ace` under the Checks section.
Expand Down