Dynatrace Metric Exporter

Prometheus exporter for Dynatrace's metrics and entity monitoring.

Scrapes /metrics and /entity endpoints of Dynatrace API v2 and exposes metrics to Prometheus.

This exporter allows you to easily retrieve all Dynatrace metrics and infrastructure heatlth state (healthy/unhealthy applications, hosts and services).

Exporter developped by Apside TOP and sponsored by Harmonie Mutuelle.

  

Grafana visualisations example

Apdex score, active users and errors per application :

Applications health state :

Note: This panel uses Hexmap plugin.

Command line

❯ python3 dynatrace_exporter.py -h
usage: dynatrace_exporter.py [-h] [--config.file CONFIG_FILE] [--web.listen-address LISTEN_ADDRESS] [--debug] [--test] [--output OUTPUT]

Dynatrace data exporter

optional arguments:
  -h, --help            show this help message and exit
  --config.file CONFIG_FILE
                        Path to config file (default: dynatrace_exporter.yml)
  --web.listen-address LISTEN_ADDRESS
                        Listen to this address and port (default: :9126)
  --debug               Enable debug (default: False)
  --test                Test metrics collection once, then stop exporter (default: False)
  --output OUTPUT       Output file when --test option is set (default: None)

Running with docker

1. Create a file dynatrace_exporter.yml with your configuration
2. Build the image
3. Run the image

docker run \
    -v ./dynatrace_exporter.yml:/usr/src/app/dynatrace_exporter.yml \
    <your_image>

Configuration

# General configurations
general:
  api:
    # API base URL. Should end with "/api/v2"
    url: "https://xxxxxxxxxx/api/v2"
    # Dynatrace API key
    apiKey: "Api-Token xxxxxxxxxx"
    # Additional custom headers for HTTP requests
    headers:
      # <header name>: <header value>
  
  # Number of parallel threads to use to fetch metrics. 1 or lower to disable multithreading
  threads: 12 
  # Max number of results to return in one request. Max allowed by dynatrace is 4000
  pageSize: 4000

# Collectors configuration
collectors:
  # Collecting health of Dynatrace entities with type 'service'
  service:
    enabled: true
    # Service's type whitelist. Empty or undefined to allow all types of service
    # service_type:
    #   - "DATABASE_SERVICE"
      
  # Collecting health of Dynatrace entities with type 'application'
  application:
    enabled: true

  # Collecting health of Dynatrace entities with type 'host'
  host:
    enabled: true

  # Collecting Dynatrace metrics
  metrics:
    enabled: true
    # Maximal number of metrics fetched to batch fetch in each requet. Max allowed by dynatrace is 10
    batchSize: 10 
    # Allow deprecated metrics
    deprecated: false
    # Additionnal URL parameters. See full list here: https://www.dynatrace.com/support/help/dynatrace-api/environment-api/metric-v2/get-data-points 
    params:
      # Number of points to retrieve
      resolution: 12 
      # Time range of query
      from: now-6h 
    # Metrics regex whitelist. Empty or undefined to allow all metrics. 
    # Warning: enabling all (or at least a lot of) metrics might slow the exporter down to several seconds, or even minutes. 
    # Be careful to timeouts on Prometheus side.
    whitelist:
      - builtin:apps.+ 
      # - builtin:tech.+ 
      # - builtin:service.+ 
      # - builtin:host.+ 
      # - builtin:cloud.+ 
      # - builtin:pgi.+ 
      # - builtin:containers.+ 
      # - builtin:kubernetes.+ 
      # - builtin:billing.+ 
      # - builtin:synthetic.+ 
      # - builtin:queue.+ 
      # - builtin:security.+ 
      # - builtin:span.+ 
      # - builtin:dashboards.+ 
      # - builtin:process.+ 
      # - builtin:osservice.+ 
      # - calc:.+ 
      # - dsfm:.+ 
      # - ext:.+ 
      # - func:.+ 

# Logging configurations
logging:
  # Minimal log level: DEBUG, INFO, WARNING, ERROR, CRITICAL
  level: INFO 
  # Log format. To see all available attributes: https://docs.python.org/3/library/logging.html#logrecord-attributes 
  format: "%(asctime)s %(levelname)s [%(threadName)s] - (%(filename)s#%(lineno)d) - %(message)s"

Metrics

# HELP dynatrace_metric_<metric_name> <description>
# TYPE dynatrace_metric_<metric_name> <dynatrace_metric_name> gauge
dynatrace_metric_<metric_name>{<labels>}<value>
# HELP dynatrace_entity_service_health service_health
# TYPE dynatrace_entity_service_health gauge 
dynatrace_entity_service_health{<labels>}<value>
# HELP dynatrace_entity_host_health host_health
# TYPE dynatrace_entity_host_health gauge 
dynatrace_entity_host_health{<labels>}<value>
# HELP dynatrace_entity_application_health application_health
# TYPE dynatrace_entity_application_health gauge 
dynatrace_entity_application_health{<labels>}<value>

Sponsors

Harmonie Mutuelle (https://www.harmonie-mutuelle.fr/)

Maintainers

• [Apside TOP] Robin Maréchal (@robinmarechal)

License

Apache License 2.0, see LICENSE.