Overview

Software Catalog uses service definition schemas to store and display metadata about your services. These schemas follow the JSON Schema specification, so you can validate your metadata as you edit it. This validation is important, because a mistake in a service definition file could cause you to create a service with invalid data or introduce an error into the metadata of an existing service.

To prevent this, there are two ways for you to validate your service definition files:

Create the service definition in-app

To validate your service definition file in-app:

1. Navigate to the Software Catalog Setup & Config page.
2. Click Create a New Entry.
3. Select the Code tab.
4. Paste the schema content.

Validate with an IDE extension

Built-in validation mechanisms prevent you from sending incorrect metadata into Software Catalog.

Validate with Datadog Event Management and Github Integration

To validate your service definitions ingested by Datadog’s Github integration, you can view events when services or updated or when there is an error. You can view validation errors in Event Management by filtering by source:software_catalog and status:error. Adjust the timeframe as needed.

Further reading

Documentation, liens et articles supplémentaires utiles:

Datadog Software CatalogDOCUMENTATION Service Definition APIDOCUMENTATION Service Definition SchemaSOURCE CODE Manage Service Catalog entries with the Service Definition JSON SchemaBLOG