Skip to content

Commit

Permalink
dgreen15/Update create_entries.md (#27051)
Browse files Browse the repository at this point in the history
* dgreen15/Update create_entries.md

* Update _index.md

* Update create_entries.md
  • Loading branch information
dgreen15 authored Feb 5, 2025
1 parent f98349d commit 284cd4b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions content/en/service_catalog/customize/create_entries.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ further_reading:

## Create user-defined entries

To manage your own components that are not currently emitting performance metrics through APM, USM, or RUM products with Datadog Service Catalog, you can either manually add them by creating Service Definitions through the API or GitHub integration or [import](#import-data-from-other-sources) 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 `service.datadog.yaml` files.
To manage your own components that are not currently emitting performance metrics through APM, USM, or RUM products with Datadog Service Catalog, you can either manually add them by creating Service Definitions through the API, Terraform, GitHub integration, or [import](#import-data-from-other-sources) 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 service, name your service in the `dd-service` field in a `service.datadog.yaml` file at the root of the repository, using one of the supported metadata schema versions. For example:
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
{{< code-block lang="yaml" filename="service.datadog.yaml" collapsible="true" >}}
Expand Down
2 changes: 1 addition & 1 deletion content/en/service_catalog/service_definitions/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ For detailed information about each version, including full schemas and example

#### Store and edit definitions in GitHub

Configure the [GitHub integration][6] to directly link from where you view the service's definition in the Service Catalog to where it's stored and editable in GitHub. Datadog scans for the `service.datadog.yaml` file at the root of each repository with read permissions.
Configure the [GitHub integration][6] to directly link from where you view the service's definition in the Service Catalog to where it's stored and editable in GitHub. Datadog scans for the `service.datadog.yaml` and `entity.datadog.yaml` files throughout each repository with read permissions.

To install the GitHub integration:
1. Navigate to the [integration tile][7].
Expand Down

0 comments on commit 284cd4b

Please sign in to comment.