Skip to content

Commit e3f07a5

Browse files
committed
remove terminology from home page since it's now included on entity types page
1 parent 837aab8 commit e3f07a5

File tree

3 files changed

+12
-29
lines changed

3 files changed

+12
-29
lines changed

content/en/internal_developer_portal/_index.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ further_reading:
1616
text: "How Datadog's Infrastructure team manages internal deployments using the Service Catalog and CI/CD Visibility"
1717
---
1818

19+
{{< callout url="https://www.datadoghq.com/product-preview/internal-developer-portal/" d_target="#signupModal" btn_hidden="false" header="Opt in to the preview for Datadog's Internal Developer Portal!" >}}
20+
{{< /callout >}}
21+
1922
TODO: insert image of IDP
2023

2124
## Overview
@@ -29,10 +32,10 @@ Datadog's Internal Developer Portal (IDP) unifies live telemetry, metadata, and
2932
## Common use cases
3033

3134
{{< whatsnext desc=" " >}}
32-
{{< nextlink href="/internal_developer_portal/use_cases/dev_onboarding" >}}Accelerate Developer Onboarding{{< /nextlink >}}
33-
{{< nextlink href="/internal_developer_portal/use_cases/incident_response" >}}Improve Incident Response{{< /nextlink >}}
34-
{{< nextlink href="/internal_developer_portal/use_cases/dependency_management" >}}Manage and Map Dependencies{{< /nextlink >}}
35-
{{< nextlink href="/internal_developer_portal/use_cases/production_readiness" >}}Evaluate Production Readiness{{< /nextlink >}}
35+
{{< nextlink href="/internal_developer_portal/use_cases/dev_onboarding" >}}Accelerate developer onboarding{{< /nextlink >}}
36+
{{< nextlink href="/internal_developer_portal/use_cases/incident_response" >}}Improve incident response{{< /nextlink >}}
37+
{{< nextlink href="/internal_developer_portal/use_cases/dependency_management" >}}Manage and map dependencies{{< /nextlink >}}
38+
{{< nextlink href="/internal_developer_portal/use_cases/production_readiness" >}}Evaluate production readiness{{< /nextlink >}}
3639
{{< /whatsnext >}}
3740

3841
## Main features

content/en/internal_developer_portal/software_catalog/_index.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,6 @@ algolia:
2424

2525
Built on real-time telemetry and automated metadata collection, Software Catalog extends beyond traditional software catalogs by offering integrations with observability, security, and cost management tools. It empowers engineering, SRE, security, and platform teams to maintain visibility, streamline operations, and ensure service reliability at scale.
2626

27-
{{< callout url="https://www.datadoghq.com/product-preview/internal-developer-portal/" d_target="#signupModal" btn_hidden="false" header="Opt in to the preview for our Internal Developer Portal!" >}}
28-
{{< /callout >}}
29-
3027
## What you can do in Software Catalog
3128
<br>
3229
{{< img src="tracing/software_catalog/software_catalog_tabs.mp4" video=true alt="A video overview of the Software Catalog, with the Services component type selected, that scrolls through the Ownership, Reliability, Performance, Security, Costs, and Delivery tabs" style="width:100%;" >}}
@@ -83,31 +80,13 @@ Every entry in Software Catalog is categorized as a component type:
8380

8481
{{< img src="tracing/software_catalog/select-component.png" alt="Software Catalog component selector" style="width:30%;" >}}
8582

86-
Datadog populates Software Catalog entries and determines their associated component type based on collected span attributes for APM ([peer tags][10]), but also based other collected telemetry types (USM, DSM, RUM, etc...).
83+
Datadog populates Software Catalog entries and determines their associated component type based on collected span attributes for APM ([peer tags][10]), but also based other collected telemetry types (for example: USM, DSM, RUM).
8784

8885
**Note**: The component supersedes the `type` filter (derived from the `span.type` span attribute), as it detects more reliably and more granularly the different entity types. For instance, you can filter by datastore technology using the `datastore type` facet.
8986

9087
[10]: /tracing/services/inferred_services#peer-tags
9188
{{< /site-region >}}
9289

93-
## Key terminology
94-
95-
Service
96-
: In APM, a [service][10] is a group of related endpoints, queries, or jobs that perform a piece of work for your application. For example, a service could be a group of endpoints, a group of DB queries, or a group of periodic jobs. Through custom instrumentation in APM, you can create an arbitrary `service`. In practice, microservice-based architecture includes multiple APM services, each measuring the performance of sub-components of the application through [Trace Metrics][2]. In the Software Catalog, you can collect non-instrumented services by declaring them through [metadata][12]. You can also import additional services through external sources like [Backstage][13] or [ServiceNow][14].
97-
98-
System
99-
: In the Software Catalog, a system is a group of components that cooperate to perform a broader function. For example, you can group multiple instrumented APM services into a system because they are operated by the same team. You can also use `system` to represent a full microservice-based architecture, and include components like APIs, datastores, queues, and other common building blocks.
100-
: **Note**: **System** in Datadog has the same meaning as in Backstage's [System Model][15].
101-
102-
Component
103-
: In the Software Catalog, a component represents the smallest building block of modern microservice-based architecture. A component can be an instrumented APM service, an [inferred][16] or manually declared datastore, an API, or a queue.
104-
105-
Endpoint
106-
: An endpoint refers to a specific route or path within a service that handles requests. For example, `/api/v2/messages/send`. Software Catalog contains HTTP endpoints that are automatically discovered by APM. The concept of endpoints correspond to [APM resources][19] for an APM web service. APM provides performance metrics such as request count, latency, and error rate. Users can also add other unmonitored endpoints to Software Catalog through metadata [Definitions][17].
107-
108-
API
109-
: In the Software Catalog, an API refers to a collection of endpoints that belong together logically. APIs offer an alternative way to group endpoints beyond APM services (the mapping between endpoints and services are not modifiable). Users can define team and add additional endpoints (regardless of whether they are monitored by APM) by providing a `kind:API` metadata [Definition][18] in Software Catalog.
110-
11190

11291
## Further reading
11392

@@ -128,7 +107,7 @@ API
128107
[13]: /software_catalog/customize/import_entries_backstage
129108
[14]: /software_catalog/customize/import_entries_servicenow
130109
[15]: https://backstage.io/docs/features/software-catalog/system-model/
131-
[16]: /tracing/services/inferred_services/?tab=agentv7551#naming-inferred-entities
110+
132111
[17]: /software_catalog/service_definitions/v3-0/
133112
[18]: /software_catalog/service_definitions/#add-metadata-to-endpoints
134113
[19]: /tracing/glossary/#resources

content/en/internal_developer_portal/software_catalog/entity_model/entity_types.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ disable_toc: false
55

66
## Overview
77

8-
As of schema v3.0+, Software Catalog supports multiple kinds of entities, such as service, queue, datastore, system, and API. Custom entities are also supported.
8+
In Software Catalog, an entity represents the smallest building block of modern microservice-based architecture. As of [schema definition v3.0][1]+, an entity can be an instrumented APM service, a datastore, a system, an API, a queue, or even a custom-defined entity.
99

1010
See GitHub for [full schema definitions][1].
1111

@@ -230,4 +230,5 @@ Example YAML:
230230
{{< /tabs >}}
231231

232232

233-
[1]: https://github.com/DataDog/schema/tree/main/service-catalog/v3
233+
[1]: https://github.com/DataDog/schema/tree/main/service-catalog/v3
234+
[2]: /tracing/services/inferred_services/?tab=agentv7551#naming-inferred-entities

0 commit comments

Comments
 (0)