Defining Datadog Observer jobs

Using the Datadog Observer functionality, you can load monitored hosts and their associated processes, and then visualize this data as a topology view in the Agile Service Manager UI.

Before you begin

Restriction: The Datadog Observer is only available as a technical preview. Use of the technical preview feature is unsupported for production environments.
Important: The Datadog Observer supports the cloud/SaaS Datadog version.

Ensure you have the Datadog server details to hand, such as the data tenant, API server URL, Auth API key and App key.

The observer is installed as part of the core installation procedure.

Remember: Swagger documentation for the observer is available at the following default location: https://<your host>/1.0/datadog-observer/swagger

About this task

A Datadog Observer job extracts host and its associated processes from Datadog via REST API. The Observer loads and updates the resources and their relationships within the Netcool Agile Service Manager core topology service.

datadog_observer_common.sh
The configuration file you use to customize Datadog Observer settings.
The parameters defined here are then used by the datadog_observer_load_start.sh to trigger the Datadog Observer jobs.
Tip: Alternatively, you can set the appropriate environment variables. If an environment variable is set, it takes precedence over the configuration file settings.
You define and start the following job. You must edit the parameters in the configuration file before running this job.
Full Topology Upload job
A transient (one-off) job that loads all requested topology data.
This job is started by the datadog_observer_load_start.sh script.

Procedure

To edit the parameters in the configuration file

  1. Open the datadog_observer_common.sh configuration file and edit (at least) the following parameters:
    Data Tenant
    The data tenant to track the Datadog topology
    API server URL
    The Datadog API base URL
    Auth API key
    The authorized API key to authorize with Datadog
    App key
    The application key to access the Datadog resources

To start the Load job

  1. To start the Datadog Observer Full Topology Upload job, use the following command: 
    $ASM_HOME/bin/datadog_observer_load_start.sh

Results

This job loads all requested topology data, and runs only once. Run this job whenever you need Datadog topology data refreshed.

What to do next

You can also use the following scripts:
datadog_observer_load_stop.sh
Stops the Load job
datadog_observer_job_list.sh
Lists the status of current jobs
datadog_observer_log_level.sh
Sets the log level
Remember: As an alternative to being configured using the Observer Configuration UI, observer jobs have scripts to start and stop all available jobs, to list the status of a current job, and to set its logging levels. These scripts can be run with -h or --help to display help information, and with -v or --verbose to print out the details of the actions performed by the script, including the full cURL command. For the on-prem version of Agile Service Manager, observer scripts are configured for specific jobs by editing the script configuration files.