Manage Automatically Included Entries

이 페이지는 아직 한국어로 제공되지 않으며 번역 작업 중입니다. 번역에 관한 질문이나 의견이 있으시면 언제든지 저희에게 연락해 주십시오.

Automatic service discovery

Datadog Service Catalog includes both eBPF-based autodiscovery with Universal Service Monitoring and distributed tracing based detection with APM. RUM applications are included in the Service Catalog as well. If you are using any of these products, your catalog is pre-populated with entries.

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 via the UI, APIs, or other automation. 2.2 is the recommended version. To try experimental features, you can opt into the beta program for schema 3.0 by submitting a request.

Opt in to the private beta for metadata schema v3.0!

Request Access

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

Automate common workflows

Use Workflow Automation and App Builder to automate end-to-end processes. Integrate them with Datadog’s Service Catalog to enable dynamic and self-service workflows.

Join the Beta!

Software Templates are in private beta. Complete the form to request access.

Request Access

Create software template workflows using Cookiecutter

To use software templates in Datadog, create a git repository with the desired template. Then, navigate to the Workflow Automation page to configure the template in Datadog. A common choice for templating is Cookiecutter, an open source project for project templates and auto-generating new projects. Check out this gist for a quick-start guide, or complete the following steps.

  1. Create a workflow for your template:

    • From the Workflow Automation page, click New Workflow.
    • Enter a name, add relevant tags, and define the input parameters you want to collect from users.
  2. Configure the templating workflow:

    • Use GitHub, Gitlab, or HTTP workflow actions to retrieve your template files.
    • Use Cookiecutter to generate the project files from the template.
    • Use GitHub, Gitlab, or HTTP workflow actions to upload the project files to the repository.
    • Save the workflow.
Workflow for building software template automation
  1. Create your templating app:

    • Navigate to Service Mgmt > App Builder and select New App.
    • Enter a name and description, and use the drag-and-drop editor to create a form that collects the required parameters for your template.
    • Select New Query, and use the Trigger workflow action to call your templating workflow and pass in the relevant parameters.
    • Create a Buttom that submits the form, triggers your workflow, and passes in the parameters for the template.
    • Save and publish the app.
  2. Run your application and workflow:

    • Click View App to view the app on a standalone page, or Add to a Dashboard to place the app in a dashboard.
    • Navigate to Service Mgmt > App Builder, and select your app. Fill out the template form, and click the submit button.
    • Track the success of the workflow templating process in Workflow Automation.
Application for managing software templates through App Builder

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.

Click the service icon to select a different icon color.

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