Automatic discovery

Datadog Service Catalog is pre-populated with entries detected through APM, eBPF-based autodiscovery with Universal Service Monitoring, and RUM applications.

With APM, Datadog can automatically discover the dependencies for an instrumented service, such as a database, a queue, or a third-party dependencies, even if that dependency hasn’t been instrumented yet. These uninstrumented dependencies are categorized as separate services. Datadog changed service names of client spans (span.kind:client) to represent dependencies of your instrumented services. For example, a span representing a client call from a service auth-dotnet to a PostgreSQL database would be tagged with service:auth-dotnet-postgres.

If you are using APM and would like to remove the automatically named services from your Service Catalog and Service Map, you can opt in to new inferred entities experience, which allows you to filter Service Catalog entries by entity type, such as database, queue, or third-party dependencies. You can optionally remove any service overrides like service:my-service-http-client from your catalog or map.

Enrich auto-detected services with metadata

To specify on-call, source code, or documentation for your services, you can add metadata to any existing services using the UI, APIs, or other automation. 2.2 is the recommended version. To try experimental features like enhanced relationship mapping and precise code location, opt in to the beta program for schema 3.0 by submitting a request.

Service Definition Schema (v2.2) (Recommended)

The Service Definition Schema is a structure that contains basic information about a service. See the full schema on GitHub.

Example

schema-version: v2.2
dd-service: shopping-cart
team: e-commerce
application: shopping-app
tier: "1"
type: web
languages:
  - go
  - python
contacts:
  - type: slack
    contact: https://yourorg.slack.com/archives/e-commerce
  - type: email
    contact: ecommerce@example.com
  - type: microsoft-teams
    contact: https://teams.microsoft.com/example
links:
  - name: Runbook
    type: runbook
    url: http://runbook/shopping-cart
  - name: Source
    type: repo
    provider: github
    url: https://github.com/shopping-cart
  - name: Deployment
    type: repo
    provider: github
    url: https://github.com/shopping-cart
  - name: Config
    type: repo
    provider: github
    url: https://github.com/consul-config/shopping-cart
  - name: E-Commerce Team
    type: doc
    provider: wiki
    url: https://wiki/ecommerce
  - name: Shopping Cart Architecture
    type: doc
    provider: wiki
    url: https://wiki/ecommerce/shopping-cart
  - name: Shopping Cart RFC
    type: doc
    provider: google doc
    url: https://doc.google.com/shopping-cart
tags:
  - business-unit:retail
  - cost-center:engineering
integrations:
  pagerduty:
    service-url: https://www.pagerduty.com/service-directory/PSHOPPINGCART
  opsgenie:
    service-url: "https://www.opsgenie.com/service/uuid"
    region: "US"
ci-pipeline-fingerprints:
  - id1
  - id2
extensions:
  additionalProperties:
    customField1: customValue1
    customField2: customValue2

Find Service Catalog actions

To explore the complete set of actions specifically related to Service Catalog, navigate to the Datadog Action Catalog. Filter for the actions you need:

1. Access the Action Catalog: Look for the Action Catalog within your Datadog Workflow Automation environment.
2. Search Functionality: Use the search bar to search for keywords like “Service Catalog” or more specific terms related to desired actions (for example, “get service dependencies”).

Available Service Catalog Actions

Below is a comprehensive list of actions available for Service Catalog in Datadog Workflow Automation. Note that this list may evolve as new actions are added.

• Retrieve Service Information
  • “Get service definition” for a single service
  • “List service definitions” to get all definitions from Datadog Service Catalog
  • “Get service dependencies” to get a service’s immediate upstream and downstream services
• Incident Triage
  • “Get service PagerDuty on call”
  • When integrated with other actions, you can trigger workflows based on critical events (for example, execute runbooks).

Change the service color

The service color is used in trace visualizations. Click the service type icon to change it.

Update the service type and language

With Service Catalog metadata schema 2.2, you can specify the type and language for user-defined services or overwrite the auto-detected type and language for instrumented services. Correctly label the service type and language to help other teams further understand what your services do and how to interact with them.

Further reading

Documentation, liens et articles supplémentaires utiles:

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