Extensions 2.0 concepts

Familiarize yourself with basic Extensions 2.0 concepts to understand the framework and foundations of Extensions 2.0–based monitoring.

Architecture

Your extensions are executed by the Extension Execution Controller module (EEC), either remotely from the Environment ActiveGate or locally from OneAgent. As of now, only WMI extensions and Prometheus extensions can be run locally. More data sources are coming in later releases.

Watch this Performance Clinic episode to learn more about Extensions 2.0 framework architecture.

Dynatrace Extensions 2.0 Framework

Extension Execution Controller

The Extension Execution Controller (EEC) is the Dynatrace component running your extensions. EEC can query your local data sources when run on OneAgent, or remote data sources when run from an ActiveGate. EEC doesn't need your attention at all; it's automatically installed and managed with each OneAgent and ActiveGate configuration. EEC takes care of translating all the ingested data so that Dynatrace can leverage it for our Davis AI causation analysis. For more information, see Metric ingestion.

To run local extensions, you need to make sure EEC is enabled at the environment, host, or host group level.

  1. Go to Settings and select Preferences > Extension Execution Controller.
  2. Turn on Enable Extension Execution Controller.
  3. Turn on Enable local HTTP Metric, Log and Event Ingest API.
  1. Go to Hosts or Hosts Classic (latest Dynatrace).
  2. Find and select your host to display the host overview page.
  3. In the upper-right corner of the host overview page, select More (…) > Settings.
  1. In the host settings, select Extension Execution Controller.
  2. Turn on Enable Extension Execution Controller.
  1. Go to Deployment Status and then select OneAgents.
  2. On the OneAgent deployment page, turn off Show new OneAgent deployments.
  3. Filter the table by Host group and select the host group you want to configure.

    The Host group property is not displayed when the selected host doesn't belong to any host group.

    This displays the OneAgent deployment page filtered by the selected host group. Each listed host has a Host group: <group name> link, where <group name> is the name of the host group that you want to configure.
  4. Select the host group name in any row.
    As you have filtered by host group, all displayed hosts go to the same host group.
  1. In the host group settings, select Extension Execution Controller.
  2. Turn on Enable Extension Execution Controller.

Performance profile

OneAgent version 1.243+

You can set your limit for resource consumption in the Performance profile option. By default, one data source process takes up to 2% CPU and 100 MB RAM in OneAgent and 5% CPU and 500 MB RAM in ActiveGate.

CPU and RAM limits are applied to the sum of the resources consumed by the EEC and all data source processes. There are two stages:

  • Soft limit—Every incoming test is rejected if consumption exceeds the limit. This stage applies to ActiveGate only.
  • Hard limit—The most recently started task is the first to be stopped and rejected.
    • For OneAgent, tasks are stopped and restarted with a delay. The delay time increases as the process restarts.
    • For ActiveGate, tasks are stopped and rejected until consumption is below the limit.
  1. Go to Settings > Preferences > Extension Execution Controller.
  2. Set Performance profile to Default or High limits.
  1. Go to Hosts or Hosts Classic (latest Dynatrace).
  2. Find and select your host to display the host overview page.
  3. In the upper-right corner of the host overview page, select More (…) > Settings.
  1. In the host settings, select Extension Execution Controller.
  2. Set Performance profile to Default or High limits.

  1. Go to Deployment Status and select ActiveGates.

  2. Expand Expand row the Details of the ActiveGate you want to configure and select Settings.

  3. On the Settings page, go to Extension Execution Controller.

  4. Set Performance profile to Default, High limits, or Dedicated limits.

    You can enable Dedicated limits only after you have configured the ActiveGate as described on Dedicated performance profile configuration.

ActiveGate group

An ActiveGate running an extension must belong to an ActiveGate group, because Dynatrace uses a group to instruct the extension where it should run. If you plan to use a single ActiveGate, assign it to a dedicated group. For more information, see ActiveGate group.

You can run extensions using an Environment ActiveGate installed to route OneAgent traffic to Dynatrace, and to monitor cloud environments and remote technologies using extensions.

Cluster ActiveGates and multi-environment ActiveGates aren't supported for the Extensions 2.0 framework.

Data source type

Data source type is any technology that is generic enough for you to create an extension, but that doesn't conform to the observability standards ingested by Dynatrace out of the box, such as StatsD or Telegraf. Learn more about out-of-the-box Metric ingestion.

Currently, Dynatrace provides you with an interface to collect customized data from:

Extensions 2.0 lifecycle

The Dynatrace API enables you to manage the full lifecycle of your Extensions 2.0 framework. For details and examples, see Manage Extensions 2.0 lifecycle.

Environment configuration

An environment configuration is a universal set of monitoring definitions tailored to the specifics of your data source, such as SNMP. The environment configuration is stored as the extension.yaml file uploaded to Dynatrace as a part of the extension ZIP package. An environment configuration defines:

  • The scope of collected data: which metrics are ingested and which dimensions they are to be assigned to.
  • The source from where the measurements and dimension values are extracted.
  • The data categorization into feature sets that you can select when defining the monitoring configuration.
  • How the metrics are constructed in the context of the metric ingestion protocol.
  • How the data collected by the extension is processed and presented by Dynatrace.

Your environment can store up to 10 extension versions, but only one version can be active at a time. You enable an extension by selecting a particular version of the environment configuration.

Without an environment configuration, an extension is invisible to the Dynatrace platform.

Monitoring configuration

A monitoring configuration is specific to the data source type you want to monitor. It defines:

  • From where the extension runs.
  • For remote extensions, the endpoints that the extension calls to collect data, as well as credentials to access them.
  • Connectivity properties, such as the timeout and number of retries in case of unsuccessful connection.
  • The values of variables that will be passed to the environment configuration when it's necessary to customize the extension for the specifics of your data source instance.

You can create up to 100 monitoring configurations based on a single environment configuration and each of them runs in parallel.

To start monitoring using the extension, you must use an API call to add a monitoring configuration that will instruct Dynatrace on how to collect data from your data source.

Without a monitoring configuration, an extension is visible in the Dynatrace platform, but it doesn't collect any data.

Extension package

Extensions are provided as a ZIP package containing only the extension.zip archive and the extension.zip.sig signature file. Extension packages with different contents are not accepted for upload. The maximum size of an extension package is 25 MB.

bundle.zip
│   extension.zip
│   extension.zip.sig

Extension ZIP archive

The archive contains

For example:

extension.zip
│   extension.yaml
│
└───alerts
│   |   alert.json
│
└───dashboards
    │   dashboard.json

Digital signature

Dynatrace verifies the authenticity of an extension using a digital signature file generated against the root certificate. Using the signature file, Dynatrace checks whether the extension is provided by a trusted source (Dynatrace or a Dynatrace customer). Learn how to sign your extension.

When you receive an extension from Dynatrace, it's already signed.

Dynatrace CLI

The Dynatrace CLI (dt-cli) is a command-line utility that assists you in developing, signing, and building extensions for the Dynatrace Extensions 2.0 framework.

It enables you to:

  • Build and sign extensions from source
  • Generate development certificates for extension signing
  • Generate CA certificates for development

For details, see Sign extension and the dt-cli project on GitHub.

Feature sets

Feature sets are categories into which you organize the data collected by the extension. Imagine an SNMP extension monitoring your network devices and collecting metrics related to NIC status, transport layer, and SNMP traps. This is reflected by metrics organization into related feature sets. Using a single extension, you can now customize your monitoring to limit a particular feature set to selected devices of your choice or identify ActiveGates with connectivity suited to devices capable of providing data specific to a feature set. It's all centrally managed from a single place, using a single API call. All metrics that aren't categorized into any feature set are considered to be default and are always reported.

Limits

Extension

Entity

Limit

Details

Dashboards

10

The maximum number of dashboards you can define for a single extension.

Alerts

Dynatrace version 1.304+ 100 Dynatrace version 1.303 and earlier 10

The maximum number of alerts for a single extension. The alerts limit for a single extension is caused by the definition schema and depends on the chosen minDynatraceVersion.

Metrics (total for the extension)

500

The limit of metrics you can define for the entire extension.

Metrics (per level)

100

The limit of metrics you can define for each level (extension, group, subgroup) of declarative extensions.

ZIP package size

25 MB

The limit for a single extension ZIP package.

Configurations handled by ActiveGate or OneAgent

100

The limit of configurations that can be run simultaneously on ActiveGate or OneAgent. For remote activation, one configuration can be split into buckets, and each bucket is treated as a separate configuration.

Limits per data source type

For more details on data sources, refer to Data source type.

Entity
SNMP
SNMP traps
WMI
Prometheus
SQL
Groups
10
10
10
10
20
Subgroups1
10
N/A
25
10
20
Dimensions2
25
5
25
25
25
1

The number of subgroups each group can contain. For some data sources, adding subgroups is not available.

2

In the extension YAML file, you can define the number of dimensions for each level (extension, group, subgroup).

Environment

Entity

Limit

Description

Extensions

250

Your environment can manage up to 250 extensions.

Extension versions

10

Your environment can manage 10 versions of a single extension.

Device monitoring configuration per data source

Remote activation

You can define up to 20,000 devices for a single monitoring configuration. Configurations are split into buckets, with a default size of 100 devices per bucket. Each bucket of devices is polled independently as a separate process on one of the ActiveGates in a group. This feature is automatically enabled for WMI, Prometheus, SNMP, and SQL extensions, while for other types of extensions, its activation depends on the specific extension.

Entity
SNMP
SNMP traps
WMI
Prometheus
SQL
Devices
20,000
100
20,000
20,000
20,000
Remote WMI monitoring limits

While it's possible to enter up to 20,000 devices in a single configuration, remote WMI monitoring is limited by the number of simultaneous WMI queries that can be executed on the internal Windows service that handles them.

Currently, the limit is 100 queries. For example, if your extension uses 5 queries, configuring more than 20 devices may cause performance issues and gaps in the monitoring data.

We are working on ways to get around this Windows limitation in future versions of the WMI data source.

Local activation

Entity
WMI
Prometheus
Devices
20,000
100

Metric ingestion

Entity
Limit
Description
Metric key length, characters
250
The total length of the metric key, including the prefix.
Dimension key length, characters
100
The total length of the dimension key.
Dimension value length, characters
250
The total length of the dimension value.
Number of dimensions per line
50
The number of dimensions in a single line of the payload.
Total number of possible metric keys per environment
20,000
The maximum number of metric keys that can be registered in Dynatrace.
Number of tuples per month per metric
1,000,000
The maximum number of tuples (unique metric-dimension key-dimension value-payload type combinations) for each metric key for the last 30 days.
Number of tuples per month for all custom metrics
50,000,000
The maximum number of tuples (unique metric-dimension key-dimension value-payload type combinations) for all custom metrics for the last 30 days.
Length of line, characters
50,000
The maximum length of a single line of the payload.

There's also a limit to the number of metrics that Dynatrace can ingest.

Channel

Limit

Per minute per OneAgent instance:

OneAgent version 1.213 and earlier 1,000
OneAgent version 1.215+ 100,000

There's no limit to the metric number, but API throttling applies.

Resource consumption

In the following table:

  • Per configuration shows the consumption volume for one data source in OneAgent and ActiveGate.
  • For all data source processes refers to the sum of the resources consumed by the EEC and all data source processes in OneAgent and ActiveGate. Each data source process represents a single extension activation assigned to a given host or an ActiveGate group.

OneAgent

Performance profileCPURAMCPU (Soft limit)RAM (Soft limit)CPU (Hard limit)RAM (Hard limit)

Per instance

For all data source processes

Default

2%

100 MB

N/A

N/A

5%

15%

High limits

5%

200 MB

N/A

N/A

15%

25%

ActiveGate

Performance profileCPURAMCPU (Soft limit)RAM (Soft limit)CPU (Hard limit)RAM (Hard limit)

Per configuration

For all data source processes

Default

5%

500 MB

10%

20%

20%

30%

High limits

15%

700 MB

45%

30%

60%

40%

Dedicated

30%

1500 MB

70%

50%

85%

70%

Generic types and relationship

Managing multiple extensions in Dynatrace can lead to encountering limits related to generic types and relationship settings. To prevent these potential issues, see the table below.

Value count limits
Default value
Soft limit
Hard limit
builtin:monitoredentities.generic.relation
100
500
500
builtin:monitoredentities.generic.type
100
500

Access control

  • If you use Dynatrace Hub, you need the classic Manage monitoring settings permission in your group to modify the monitoring configuration.
  • If you authenticate the API with the tenant token, your token needs extensions.read and extensions.write permissions.