Customize the Software Catalog

Docs > Software Catalog > Customize the Software Catalog

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

You can customize your engineering team’s landing experience in Software Catalog. Developer Home is a new personalized dashboard experience in beta, designed to help developers access prioritized tasks, pull requests, alerts, and insights all in one place.

Opt in to the private beta for Developer Homepage experience!

Request Access

Automatic discovery

Datadog Software 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 dependency, 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 Software Catalog and Service Map, you can opt in to new inferred entities experience, which allows you to filter Software 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.

For information about discovering endpoints, see Discovering Endpoints from APM.

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. v3 is the recommended version.

Entity Definition Schema (v3) (Recommended)

The Entity Definition Schema is a structure that contains basic information about a software component.

For more details, see the Definition Schema v3.0.

Service Definition Schema (v2.2)

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

Example

service.datadog.yaml

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

Change the service color

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

Click the service icon to select a different icon color.

Update the service type and language

With Software 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.