Try it free

Distribute custom dashboards with your extensions

  • Latest Dynatrace
  • How-to guide
  • 3-min read

After your extension starts sending data to Dynatrace, you can create a custom dashboard, export its definition to a JSON file, and add the JSON to your extension archive.

Dashboards Dashboards

If you're using Dashboards Dashboards, follow these procedures.

You can export a dashboard definition through the Dynatrace web UI.

Export dashboard JSON

To download (export) a dashboard from the Dashboards Dashboards side panel

  1. Go to Dashboards Dashboards.

  2. In Last opened by you, hover over the name of the dashboard you want to export and select Download from the menu. The dashboard is downloaded to a local JSON file that you can upload.

    If your dashboard isn't listed in Last opened by you, select All dashboards to display a table of all dashboards that you can access (your dashboards or dashboards shared with you). From there, you can find the dashboard and select Download from the menu.

To download (export) the currently displayed dashboard as JSON

  1. At the top of the dashboard, open the menu to the right of the dashboard name.

  2. Select Download from the menu.

    The definition of the current dashboard is downloaded to a local JSON file.

Add your dashboard to the extension package

After you create a dashboard that uses your extension data, and you export the dashboard JSON as described earlier, you can add the dashboard to your extension package.

  1. Rename the dashboard JSON file to match the pattern <string>.dashboard.json. For example, device-health.dashboard.json.

  2. Add the JSON to the extension package.

    For example,

    extension.zip
    │   extension.yaml
    │
    └───documents
        │   device-health.dashboard.json

  3. Declare the JSON in the extension YAML file.

    For example,

    documents:
       dashboards:
          - displayName: "My Dashboard"
            path: "documents/device-health.dashboard.json"

  4. Upload the extension to the Dynatrace environment.

    Your dashboard is now available in Dashboards Dashboards.

You can also access the dashboard from Extensions Extensions.

  1. Go to Extensions Extensions.

  2. Select your extension.

  3. On the Configure tab, select Extension content.

    • Your dashboard is listed as type DOCUMENT_DASHBOARD.
    • You can set Filter By Type to DOCUMENT_DASHBOARD to list only dashboards.
Related tags
Infrastructure ObservabilityExtensionsExtensions