DX

Plugin details
Created by	DX
Category	Developer Experience
Source	GitHub
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

Prerequisites

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":
      target: <DX_HOST_URL>
      headers:
        Authorization: Bearer ${DX_API_TOKEN}
dx: #optional
  schedule:  #optional
    frequency:
      hours: 1
    timeout:
      minutes: 2
    initialDelay:
      seconds: 3
  catalogSyncAllowedKinds: [API, Component, User, Group]  #optional
  disableCatalogSync: true  #optional

Application Configuration YAML Details:

The followingproxy snippet in the YAML configures a proxy endpoint with your DX Host and Token:

proxy:
  endpoints:
    "/dx":
      target: <DX_HOST_URL>
      headers:
        Authorization: Bearer ${DX_API_TOKEN}

Optional Parameters:

1. Schedule: You can optionally configure schedule for the tasks using the following format and definition:

schedule:  
    frequency:
      hours: 1
    timeout:
      minutes: 2
    initialDelay:
      seconds: 3

2. Entity Filter: You can optionally set catalogSyncAllowedKinds to only send specific kinds of entities to DX using the following definition:

catalogSyncAllowedKinds: [API, Component, User, Group]

3. Disable Catalog Sync: You can optionally set disableCatalogSync to disable running the software catalog sync scheduled task.

disableCatalogSync: true

Layout

The following configuration is the default config for Layout for this plugin:

       - component: EntityDORAMetricsContent
          specs:
            props:
              variant: gridItem
              item: 400
            gridProps:
              md: 6
        - component: EntityDXDashboardContent
          specs:
            props:
              variant: gridItem
              item: 400
            gridProps:
              md: 6
        - component: EntityChangeFailureRateCard
          specs:
            props:
              variant: gridItem
              item: 400
            gridProps:
              md: 6
        - component: EntityDeploymentFrequencyCard
          specs:
            props:
              variant: gridItem
              item: 400
            gridProps:
              md: 6
        - component: EntityOpenToDeployCard
          specs:
            props:
              variant: gridItem
              item: 400
            gridProps:
              md: 6
        - component: EntityTimeToRecoveryCard
          specs:
            props:
              variant: gridItem
              item: 400
            gridProps:
              md: 6
        - component: EntityTopContributorsTable
          specs:
            props:
              variant: gridItem
              item: 400
            gridProps:
              md: 6

Annotations

To configure the plugin for a service in the software catalog, add the following annotation to its catalog-info.yaml definition file:

metadata:
  annotations:
    github.com/project-slug: 'project-slug'

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.