Skip to content

Commit eff768d

Browse files
committed
feat: introduce new service.criticality attribute (#2986)
1 parent 25d0aa3 commit eff768d

File tree

6 files changed

+103
-6
lines changed

6 files changed

+103
-6
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Use this changelog template to create an entry for release notes.
2+
#
3+
# If your change doesn't affect end users you should instead start
4+
# your pull request title with [chore] or use the "Skip Changelog" label.
5+
6+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
7+
change_type: "enhancement"
8+
9+
# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
10+
component: "service"
11+
12+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
13+
note: "Add `service.criticality` attribute to classify services based on operational importance"
14+
15+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
16+
# The values here must be integers.
17+
issues: [2986]
18+
19+
# (Optional) One or more lines of additional information to render under the primary note.
20+
# These lines will be padded with 2 spaces and then inserted directly into the document.
21+
# Use pipe (|) for multiline entries.
22+
subtext: |
23+
This attribute enables observability platforms to implement criticality-aware tracing, monitoring,
24+
and sampling strategies. Supports four levels: critical, high, medium, and low.
25+

docs/registry/attributes/service.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,15 @@ A service instance.
1111

1212
| Key | Stability | Value Type | Description | Example Values |
1313
|---|---|---|---|---|
14-
| <a id="service-instance-id" href="#service-instance-id">`service.instance.id`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | The string ID of the service instance. [1] | `627cc493-f310-47de-96bd-71410b7dec09` |
15-
| <a id="service-name" href="#service-name">`service.name`</a> | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Logical name of the service. [2] | `shoppingcart` |
16-
| <a id="service-namespace" href="#service-namespace">`service.namespace`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | A namespace for `service.name`. [3] | `Shop` |
14+
| <a id="service-criticality" href="#service-criticality">`service.criticality`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | The operational criticality of the service. [1] | `critical`; `high`; `medium`; `low` |
15+
| <a id="service-instance-id" href="#service-instance-id">`service.instance.id`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | The string ID of the service instance. [2] | `627cc493-f310-47de-96bd-71410b7dec09` |
16+
| <a id="service-name" href="#service-name">`service.name`</a> | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | Logical name of the service. [3] | `shoppingcart` |
17+
| <a id="service-namespace" href="#service-namespace">`service.namespace`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | A namespace for `service.name`. [4] | `Shop` |
1718
| <a id="service-version" href="#service-version">`service.version`</a> | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | string | The version string of the service API or implementation. The format is not defined by these conventions. | `2.0.0`; `a01dbef8a` |
1819

19-
**[1] `service.instance.id`:** MUST be unique for each instance of the same `service.namespace,service.name` pair (in other words
20+
**[1] `service.criticality`:** This attribute enables classification of services based on their operational importance, allowing observability platforms to implement criticality-aware tracing, monitoring, and sampling strategies. By standardizing service criticality, organizations can implement adaptive sampling rates (e.g., 100% for critical, 10% for low-priority services), optimize telemetry costs by reducing data from non-critical services, improve incident response by surfacing critical service traces first, and enable better capacity planning and resource allocation.
21+
22+
**[2] `service.instance.id`:** MUST be unique for each instance of the same `service.namespace,service.name` pair (in other words
2023
`service.namespace,service.name,service.instance.id` triplet MUST be globally unique). The ID helps to
2124
distinguish instances of the same service that exist at the same time (e.g. instances of a horizontally scaled
2225
service).
@@ -43,6 +46,25 @@ However, Collectors can set the `service.instance.id` if they can unambiguously
4346
for that telemetry. This is typically the case for scraping receivers, as they know the target address and
4447
port.
4548

46-
**[2] `service.name`:** MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to `unknown_service:` concatenated with [`process.executable.name`](process.md), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service`.
49+
**[3] `service.name`:** MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to `unknown_service:` concatenated with [`process.executable.name`](process.md), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service`.
50+
51+
**[4] `service.namespace`:** A string value having a meaning that helps to distinguish a group of services, for example the team name that owns a group of services. `service.name` is expected to be unique within the same namespace. If `service.namespace` is not specified in the Resource then `service.name` is expected to be unique for all services that have no explicit namespace defined (so the empty/unspecified namespace is simply one more valid namespace). Zero-length namespace string is assumed equal to unspecified namespace.
52+
53+
---
54+
55+
`service.criticality` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
56+
57+
| Value | Description | Stability |
58+
|---|---|---|
59+
| `critical` | Service is business-critical; downtime directly impacts revenue, user experience, or core functionality. [5] | ![Development](https://img.shields.io/badge/-development-blue) |
60+
| `high` | Service is important but has degradation tolerance or fallback mechanisms. [6] | ![Development](https://img.shields.io/badge/-development-blue) |
61+
| `low` | Service is non-essential to core operations; used for background tasks or internal tools. [7] | ![Development](https://img.shields.io/badge/-development-blue) |
62+
| `medium` | Service provides supplementary functionality; degradation has limited user impact. [8] | ![Development](https://img.shields.io/badge/-development-blue) |
63+
64+
**[5]:** Examples include payment processing, authentication, and primary user-facing APIs.
65+
66+
**[6]:** Examples include shopping cart, search, and recommendation engines.
67+
68+
**[7]:** Examples include batch processors, cleanup jobs, and internal dashboards.
4769

48-
**[3] `service.namespace`:** A string value having a meaning that helps to distinguish a group of services, for example the team name that owns a group of services. `service.name` is expected to be unique within the same namespace. If `service.namespace` is not specified in the Resource then `service.name` is expected to be unique for all services that have no explicit namespace defined (so the empty/unspecified namespace is simply one more valid namespace). Zero-length namespace string is assumed equal to unspecified namespace.
70+
**[8]:** Examples include analytics, reporting, and non-essential integrations.

docs/registry/entities/service.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
| Identity | [`service.name`](/docs/registry/attributes/service.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Required` | string | Logical name of the service. [1] | `shoppingcart` |
1919
| Identity | [`service.instance.id`](/docs/registry/attributes/service.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The string ID of the service instance. [2] | `627cc493-f310-47de-96bd-71410b7dec09` |
2020
| Identity | [`service.namespace`](/docs/registry/attributes/service.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | A namespace for `service.name`. [3] | `Shop` |
21+
| Description | [`service.criticality`](/docs/registry/attributes/service.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The operational criticality of the service. [4] | `critical`; `high`; `medium`; `low` |
2122
| Description | [`service.version`](/docs/registry/attributes/service.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | The version string of the service API or implementation. The format is not defined by these conventions. | `2.0.0`; `a01dbef8a` |
2223

2324
**[1] `service.name`:** MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to `unknown_service:` concatenated with [`process.executable.name`](process.md), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service`.
@@ -51,4 +52,6 @@ port.
5152

5253
**[3] `service.namespace`:** A string value having a meaning that helps to distinguish a group of services, for example the team name that owns a group of services. `service.name` is expected to be unique within the same namespace. If `service.namespace` is not specified in the Resource then `service.name` is expected to be unique for all services that have no explicit namespace defined (so the empty/unspecified namespace is simply one more valid namespace). Zero-length namespace string is assumed equal to unspecified namespace.
5354

55+
**[4] `service.criticality`:** This attribute enables classification of services based on their operational importance, allowing observability platforms to implement criticality-aware tracing, monitoring, and sampling strategies. By standardizing service criticality, organizations can implement adaptive sampling rates (e.g., 100% for critical, 10% for low-priority services), optimize telemetry costs by reducing data from non-critical services, improve incident response by surfacing critical service traces first, and enable better capacity planning and resource allocation.
56+
5457
<!-- markdownlint-restore -->

docs/resource/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ as specified in the [Resource SDK specification](https://github.com/open-telemet
8484
| Identity | [`service.name`](/docs/registry/attributes/service.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Required` | string | Logical name of the service. [1] | `shoppingcart` |
8585
| Identity | [`service.instance.id`](/docs/registry/attributes/service.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The string ID of the service instance. [2] | `627cc493-f310-47de-96bd-71410b7dec09` |
8686
| Identity | [`service.namespace`](/docs/registry/attributes/service.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | A namespace for `service.name`. [3] | `Shop` |
87+
| Description | [`service.criticality`](/docs/registry/attributes/service.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The operational criticality of the service. [4] | `critical`; `high`; `medium`; `low` |
8788
| Description | [`service.version`](/docs/registry/attributes/service.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | The version string of the service API or implementation. The format is not defined by these conventions. | `2.0.0`; `a01dbef8a` |
8889

8990
**[1] `service.name`:** MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to `unknown_service:` concatenated with [`process.executable.name`](process.md), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service`.
@@ -116,6 +117,8 @@ for that telemetry. This is typically the case for scraping receivers, as they k
116117
port.
117118

118119
**[3] `service.namespace`:** A string value having a meaning that helps to distinguish a group of services, for example the team name that owns a group of services. `service.name` is expected to be unique within the same namespace. If `service.namespace` is not specified in the Resource then `service.name` is expected to be unique for all services that have no explicit namespace defined (so the empty/unspecified namespace is simply one more valid namespace). Zero-length namespace string is assumed equal to unspecified namespace.
120+
121+
**[4] `service.criticality`:** This attribute enables classification of services based on their operational importance, allowing observability platforms to implement criticality-aware tracing, monitoring, and sampling strategies. By standardizing service criticality, organizations can implement adaptive sampling rates (e.g., 100% for critical, 10% for low-priority services), optimize telemetry costs by reducing data from non-critical services, improve incident response by surfacing critical service traces first, and enable better capacity planning and resource allocation.
119122
<!-- markdownlint-restore -->
120123
<!-- prettier-ignore-end -->
121124
<!-- END AUTOGENERATED TEXT -->

model/service/entities.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,5 @@ groups:
1515
role: identifying
1616
- ref: service.instance.id
1717
role: identifying
18+
- ref: service.criticality
19+
role: descriptive

model/service/registry.yaml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,3 +69,45 @@ groups:
6969
for that telemetry. This is typically the case for scraping receivers, as they know the target address and
7070
port.
7171
examples: ["627cc493-f310-47de-96bd-71410b7dec09"]
72+
- id: service.criticality
73+
type:
74+
members:
75+
- id: critical
76+
value: 'critical'
77+
brief: >
78+
Service is business-critical; downtime directly impacts revenue, user experience, or core functionality.
79+
note: >
80+
Examples include payment processing, authentication, and primary user-facing APIs.
81+
stability: development
82+
- id: high
83+
value: 'high'
84+
brief: >
85+
Service is important but has degradation tolerance or fallback mechanisms.
86+
note: >
87+
Examples include shopping cart, search, and recommendation engines.
88+
stability: development
89+
- id: medium
90+
value: 'medium'
91+
brief: >
92+
Service provides supplementary functionality; degradation has limited user impact.
93+
note: >
94+
Examples include analytics, reporting, and non-essential integrations.
95+
stability: development
96+
- id: low
97+
value: 'low'
98+
brief: >
99+
Service is non-essential to core operations; used for background tasks or internal tools.
100+
note: >
101+
Examples include batch processors, cleanup jobs, and internal dashboards.
102+
stability: development
103+
stability: development
104+
brief: >
105+
The operational criticality of the service.
106+
note: >
107+
This attribute enables classification of services based on their operational importance,
108+
allowing observability platforms to implement criticality-aware tracing, monitoring,
109+
and sampling strategies. By standardizing service criticality, organizations can implement
110+
adaptive sampling rates (e.g., 100% for critical, 10% for low-priority services), optimize
111+
telemetry costs by reducing data from non-critical services, improve incident response by
112+
surfacing critical service traces first, and enable better capacity planning and resource allocation.
113+
examples: ["critical", "high", "medium", "low"]

0 commit comments

Comments
 (0)