Extensions 2.0 hands-on exercise

Learn how to create a minimal extension that will let you centrally manage a set of complementary custom dashboards and custom events for alerting in your environment or distribute it among many environments with monitoring data that suits your definitions.

Export assets

You can add a maximum of 10 dashboards and 10 custom events for alerting definitions to the extension environment configuration. Learn how to export extension assets.

Create extension YAML file

The extension must contain a YAML file providing basic information about the extension and optional references to assets. The example below presents a minimal file limited to referencing the assets, which are a dashboard and custom events for alerting definitions.

extension.yaml
Download
name: custom:my.company.extension
version: 1.0.0
minDynatraceVersion: "1.213"
author:
  name: "My Company"
dashboards:
    - path: "dashboards/dashboard.json"
  
alerts:
    - path: "alerts/alert.json"
  • name—the name of your extension. A custom extension name (an extension not developed by Dynatrace) must start with custom:. The string must comply with the metric ingestion protocol requirements for dimensions.
  • version—the version of your extension in major.minor.build format, such as 1.0.0. Your Dynatrace environment can store 10 extension versions, but only one can be active at the time.
  • minDynatraceVersion—the earliest Dynatrace version supported by the extension enclosed in quotes ("), such as "1.213".
  • author—the extension developer or company.
  • dashboards—the path to the dashboard definitions in the extension.zip archive relative to the extension YAML file. You can add up to 10 definitions.
  • alerts—the path to the custom events for alerting definitions in the extension.zip archive relative to the extension YAML file. You can add up to 10 definitions.

The YAML file also defines the scope of your monitoring: the metrics and dimensions that you want to ingest into Dynatrace. For more information on the structure and capabilities of the extension YAML file, see Create Extension 2.0.

Create extension ZIP archive

Using the YAML from the example above, the files in the extension.zip archive should be organized as follows:

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

Sign extension

Each extension uploaded to a Dynatrace environment must be signed so that Dynatrace can verify the authenticity of the extension. Learn how to sign your extension package.

Add your extension to Dynatrace

To add the extension to Dynatrace

  1. Upload the extension. This registers the extension in the Dynatrace environment.
  2. Enable the extension.

After you enable the extension, a selected environment configuration version is activated and your dashboards and custom events for alerting are instantly available in your Dynatrace environment.

Learn how to manage the extension lifycecle.