Overview

This check monitors TIBCO Enterprise Message Service 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.

Installation

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

Configuration

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

2. Restart the Agent.

Metric collection

Create your Tibco EMS command script

The Tibco EMS integration utilizes the tibemsadmin CLI tool provided by Tibco EMS. To reduce the number of calls to the $sys.admin queue, Datadog uses a script to batch the queries made to Tibco. To collect your Tibco EMS metrics, pass the the script path and the absolute path of the tibemsadmin binary to the integration configuration.

Note: The dd-agent user needs execute permissions on the tibemsadmin binary.

1. Create a file named show_commands with the following contents:

    show server
    show queues
    show topics
    show stat consumers
    show stat producers
    show connections full

2. Add this configuration block to your tibco_ems.d/conf.yaml file to start gathering Tibco EMS metrics:

init_config:
instances:
    ## @param script_path - string - optional
    ## The path to the script that will be executed to collect metrics. Since the script is executed by a subprocess,
    ## we need to know the path to the script. This must be the absolute path to the script.
    #
    script_path: <SCRIPT_PATH>

    ## @param tibemsadmin - string - optional
    ## The command or path to tibemsadmin (for example /usr/bin/tibemsadmin or docker exec <container> tibemsadmin)
    ## , which can be overwritten on an instance.
    ##
    ## This overrides `tibemsadmin` defined in `init_config`.
    #
    tibemsadmin: <TIBEMSADMIN>

3. Restart the Agent to begin sending Tibco EMS metrics to Datadog.

Log collection

Available for Agent versions >6.0

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

   logs_enabled: true
   

2. Add this configuration block to your tibco_ems.d/conf.yaml file to start collecting your Tibco EMS logs:

   logs:
     - type: file
       path: <PATH_TO_LOG_FILE>
       service: <MY_SERVICE>
       source: tibco_ems
   

   Change the service and path parameter values and configure them for your environment. See the sample tibco_ems.yaml for all available configuration options.

3. Restart the Agent.

Validation

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

Data Collected

Metrics

Events

The TIBCO EMS integration does not include any events.

Service Checks

Troubleshooting

Need help? Contact Datadog support.