Create user-defined entries

To manage your own components that are not currently emitting performance metrics through APM, USM, or RUM products with Datadog Software Catalog, you can either manually add them by creating Service Definitions through the API, Terraform, GitHub integration, or import them from existing sources like ServiceNow or Backstage. These services are by default not associated with any Datadog telemetry, but you can link telemetries from Datadog or external sources manually using entity definition YAML files.

To create a user-defined component, name your component in the dd-service (if using schema version v2.2 or prior) or name field (if using schema version v3.0 or later) in a service.datadog.yaml or entity.datadog.yaml file using one of the supported metadata schema versions. Datadog accepts both service.datadog.yaml and entity.datadog.yaml file names. For example:

Example

schema-version: v2.2
dd-service: my-unmonitored-cron-job
team: e-commerce
lifecycle: production
application: shopping-app
description: important cron job for shopist backend
tier: "2"
type: web
contacts:
 - type: slack
   contact: https://datadogincidents.slack.com/archives/XXXXX
links:
 - name: Common Operations
   type: runbook
   url: https://datadoghq.atlassian.net/wiki/
 - name: Disabling Deployments
   type: runbook
   url: https://datadoghq.atlassian.net/wiki/
tags: []
integrations:
 pagerduty:
   service-url: https://datadog.pagerduty.com/service-directory/XXXXXXX
External Resources (Optional)

You can register multiple services in one YAML file by separating each definition with three dashes (---).

Further reading

Additional helpful documentation, links, and articles:

Create and manage service definitions with TerraformEXTERNAL SITE Learn about the Service Definition APIAPI Learn about the GitHub IntegrationDOCUMENTATION Import Backstage YAML files into DatadogBLOG