Package Documentation

Storm Package: synapse-datadog

The following Commands are available from this package. This documentation is generated for version 1.2.1 of the package.

Storm Commands

This package implements the following Storm Commands.

datadog.logs.search

Retrieve Datadog log entries and create it:log:event nodes for them.

For details on the Datadog search syntax see - https://docs.datadoghq.com/logs/search_syntax/

NOTE: The --size argument only applies when --dryrun is not specified.

Examples:

  // Query the Datadog API and yield it:log:event nodes
  datadog.logs.search service:web* --yield

  // Limit the number of results based on created it:log:event nodes
  datadog.logs.search service:web* --yield --size 100


Usage: datadog.logs.search [options]

Options:

  --help                      : Display the command usage.
  --query <query>             : The query string.
  --min-time <min_time>       : Specify the minimum time to limit log search queries (default: -24 hours)
  --max-time <max_time>       : Specify the maximum time to limit log search queries (default: now)
  --debug                     : Show verbose debug output.
  --size <size>               : Limit the number of results ingested to the given size.
  --yield                     : Yield the newly created nodes.
  --dryrun                    : Print out log entries but do not construct nodes.

The command is accessible to users with one or more of the following permissions:

power-ups.datadog.user

datadog.setup.apikey

Set the Datadog API key.

Usage: datadog.setup.apikey [options] <apikey>

Options:

  --help                      : Display the command usage.
  --self                      : Set the key as a user variable. If not used, the key is set globally.

Arguments:

  <apikey>                    : The Datadog API key string.

The command is accessible to users with one or more of the following permissions:

power-ups.datadog.user

datadog.setup.appkey

Set the Datadog application key.

Usage: datadog.setup.appkey [options] <appkey>

Options:

  --help                      : Display the command usage.
  --self                      : Set the key as a user variable. If not used, the key is set globally.

Arguments:

  <appkey>                    : The Datadog application key string.

The command is accessible to users with one or more of the following permissions:

power-ups.datadog.user

Storm Modules

This package does not export any Storm APIs.