For the complete documentation index, see llms.txt. This page is also available as Markdown.

DX

Improve developer experience with the DX plugin.

Plugin details

Created by

DX

Category

Developer Experience

Source

Type

Open-source plugin

Overview

The DX plugin is designed to enhance the overall developer experience and streamline the development process by providing insights, tools, and integrations tailored to support your workflow.

Configuration

Before you begin

Here are the prerequisites required to configure this plugin:

  1. DX_HOST_URL: You can get your DX Host URL from https://app.getdx.com/datacloud/api_keys

  2. DX_API_TOKEN: Token can be found at https://app.getdx.com/datacloud/api_keys

Application configuration YAML

Under the "Plugins" tab in your "Configure" settings, navigate to the app-config.yaml file and click Edit YAML to begin configuring the plugin.

You can use the following YAML snippet as the application configuration for this plugin:

proxy:
  endpoints:
    "/dx-web-api":
      target: https://api.getdx.com
      pathRewrite:
        '/api/proxy/dx-web-api/?': '/'  
      headers:
        Authorization: Bearer ${DX_API_TOKEN}
      allowedHeaders:
        - X-Client-Type
        - X-Client-Version
        
dx: #optional
  appId: staging  #optional

Layout

COMPONENT UPDATE

In the latest update of this plugin, all the individual component cards (EntityChangeFailureRateCard, EntityDeploymentFrequencyCard, EntityDORAMetricsContent, EntityDXDashboardContent, EntityLeadTimeCard, EntityOpenToDeployCard, EntityTimeToRecoveryCard, EntityTopContributorsTable) have been replaced by the more versatile DxDataChartCard component that now covers all this functionality.

This plugin exports:

  • ❌ 0 Page

  • ✅ 3 Cards

  • ✅ 2 Tabs

The following cards can be added to your overview screen

Configure DxDataChartCard

  • Example of Table chart

  • Example of Line chart

Similarly the following tabs can be added to your entity:

Annotations

As of now you do not really need annotations to configure the plugin.

Although make sure that the Entity identifier of DX should match with the Identifier of IDP 2.0.

Support

The plugin is owned by DX and managed in this repository as an open-source project. Create a GitHub issue to report bugs or suggest new features for the plugin.

Last updated

Was this helpful?