This product is not supported for your selected Datadog site. ().
Overview
If you already have data or services registered in Backstage or ServiceNow, you can import these services into Datadog directly.
Entities from Backstage
Sync Backstage entities into Datadog Software Catalog
Use the Datadog Backstage plugin to automatically sync your Backstage catalog entities to the Datadog Software Catalog entity model on a configurable schedule. The plugin runs as a Backstage backend service and supports entity filtering (for example, you can sync only entities with a specific Backstage component type, such as services or repositories).
You need a Datadog API key, application key, and Datadog site parameter (for example, datadoghq.com) to configure the plugin. For installation and configuration instructions, see the plugin README.
Import entity descriptor files from Backstage
To import Backstage definitions:
API or Terraform: Replace the YAMLs in your requests with Backstage YAMLs.
GitHub integration: Save your Backstage YAMLs in a repository with Datadog read permissions. Datadog scans for files named catalog-info.yaml in your repositories.
During import, Datadog maps Backstage data to Datadog data:
Backstage Field
Datadog Mapping
kind:component and kind:system
Datadog recognizes these; kind:component is recognized as a service
metadata.name
dd-service
metadata.namespace
Custom tag with format namespace:${metadata.namespace}
spec.lifecycle
lifecycle
spec.owner
team
metadata.links
links
Annotation github.com/project-slug
Link with type=repo and url=https://www.github.com/${github.com/project-slug}
Annotations pagerduty.com/service-id and pagerduty.com/account
Combined and mapped to integration.pagerduty
metadata.description
description
spec.system
application
spec.dependsOn
dependsOn
Other spec values
Mapped to custom tags
The Software Catalog processes the entire YAML file as a whole. If any section of the YAML file does not have kind:component or kind:system, the entire catalog-info.yaml file is rejected. Schema version v3.0 is required to use kind:system and the dependsOn field.
Example YAML for catalog-info.yaml
catalog-info.yaml
apiVersion:backstage.io/v1alpha1kind:Componentmetadata:name:artist-webdescription:The place to be, for great artistsspec:type:servicelifecycle:productionowner:artist-relations-teamsystem:artist-engagement-portaldependsOn:- service:email-service
Import from ServiceNow
To populate your Datadog Software Catalog with services from your ServiceNow Configuration Management Database (CMDB), use the Service Ingestion feature in the Datadog-ServiceNow integration.
Further reading
Additional helpful documentation, links, and articles: