Tibco EMS

Supported OS Linux Mac OS

Integration version2.0.0

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
  1. 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>
  1. 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

tibco_ems.connection.consumers
(gauge)
The number of consumers on the connection.
tibco_ems.connection.producers
(gauge)
The number of producers on the connectio.
tibco_ems.connection.sessions
(gauge)
The number of sessions on the connection.
tibco_ems.connection.temporary_queues
(gauge)
The number of temporary queues created by the connection.
tibco_ems.connection.temporary_topics
(gauge)
The number of temporary topics created by the connection.
tibco_ems.connection.uncommitted_transactions
(gauge)
The number of messages in uncommitted transactions on the connection.
tibco_ems.connection.uncommitted_transactions_size
(gauge)
The combined size of messages in uncommitted transactions on the connection.
Shown as byte
tibco_ems.consumer.messages_rate
(gauge)
The rate, per second, at which messages are being consumed.
tibco_ems.consumer.messages_rate_size
(gauge)
The rate, per second, at which the size of messages is being consumed.
Shown as byte
tibco_ems.consumer.total_messages
(gauge)
The total number of messages consumed by the consumer.
tibco_ems.consumer.total_messages_size
(gauge)
The total size of messages consumed by the consumer.
Shown as byte
tibco_ems.durable.pending_messages
(gauge)
The number of pending messages on the durable.
tibco_ems.durable.pending_messages_size
(gauge)
The total size of pending messages on the durable.
Shown as byte
tibco_ems.producer.messages_rate
(gauge)
The rate, per second, at which messages are being produced.
tibco_ems.producer.messages_rate_size
(gauge)
The rate, per second, at which the size of messages is being produced.
Shown as byte
tibco_ems.producer.total_messages
(gauge)
The total number of messages produced by the producer.
tibco_ems.producer.total_messages_size
(gauge)
The total size of messages produced by the producer.
Shown as byte
tibco_ems.queue.pending_messages
(gauge)
The number of pending messages on the queue.
tibco_ems.queue.pending_messages_size
(gauge)
The total size of pending messages on the queue.
Shown as byte
tibco_ems.queue.pending_persistent_messages
(gauge)
The total number of pending persistent messages on the queue.
tibco_ems.queue.pending_persistent_messages_size
(gauge)
The total size of pending persistent messages on the queue.
Shown as byte
tibco_ems.queue.receivers
(gauge)
The number of currently active receivers
tibco_ems.server.admin_connections
(gauge)
The number of admin connections on the server.
tibco_ems.server.asynchronous_storage
(gauge)
The amount of storage used for asynchronous message storage.
tibco_ems.server.client_connections
(gauge)
The number of client connectons on the server.
tibco_ems.server.consumers
(gauge)
The number of message consumers on the server.
tibco_ems.server.durables
(gauge)
The number of durables on the server.
tibco_ems.server.inbound_message_rate
(gauge)
The rate of total inbound messages.
tibco_ems.server.inbound_message_rate_size
(gauge)
The size of the rate of total inbound messages.
Shown as byte
tibco_ems.server.message_memory_pooled
(gauge)
The amount of memory pooled for message storage.
tibco_ems.server.outbound_message_rate
(gauge)
The rate of outbound messages on the server.
tibco_ems.server.outbound_message_rate_size
(gauge)
The size of the rate of outbound messages on the server
Shown as byte
tibco_ems.server.pending_message_size
(gauge)
The total size of messages pending delivery.
Shown as byte
tibco_ems.server.pending_messages
(gauge)
The total number of messages pending delivery.
tibco_ems.server.producers
(gauge)
The number of message producers on the server.
tibco_ems.server.queues
(gauge)
The total number of queues, including the count of dynamic and temporary topics.
tibco_ems.server.sessions
(gauge)
The number of sessions currently active on the server.
tibco_ems.server.storage_read_rate
(gauge)
The number of storage reads on the server
tibco_ems.server.storage_read_rate_size
(gauge)
The size of the rate of storage reads on the server
Shown as byte
tibco_ems.server.storage_write_rate
(gauge)
The number of storage writes on the server
tibco_ems.server.storage_write_rate_size
(gauge)
The size of the rate of storage writes on the server.
Shown as byte
tibco_ems.server.synchronous_storage
(gauge)
The amount of storage used for synchronous message storage.
tibco_ems.server.topics
(gauge)
The total number of topics, including the count of dynamic and temporary topics.
tibco_ems.server.uptime
(gauge)
The total time the server has been running since it was last started.
Shown as second
tibco_ems.topic.durable_subscriptions
(gauge)
The number of current subscriptions on the topic, including durable subscriptions.
tibco_ems.topic.pending_messages
(gauge)
The number of pending messages on the topic.
tibco_ems.topic.pending_messages_size
(gauge)
The total size of pending messages on the topic.
Shown as byte
tibco_ems.topic.pending_persistent_messages
(gauge)
The number of pending persistent messages on the topic.
tibco_ems.topic.pending_persistent_messages_size
(gauge)
The total size of pending persistent messages on the topic.
Shown as byte
tibco_ems.topic.subsciptions
(gauge)
The number of durable subscriptions on the topic.

Events

The TIBCO EMS integration does not include any events.

Service Checks

Troubleshooting

Need help? Contact Datadog support.