Skip to content

Commit 0de4ab4

Browse files
committed
feat: regenerate docs and table
1 parent 932fc71 commit 0de4ab4

File tree

3 files changed

+40
-2
lines changed

3 files changed

+40
-2
lines changed

docs/registry/attributes/service.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ port.
5454

5555
`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.
5656

57-
| Value | Description | Stability |
58-
|---|---|---|
57+
| Value | Description | Stability |
58+
| --- | --- | --- |
5959
| `critical` | Service is business-critical; downtime directly impacts revenue, user experience, or core functionality. [5] | ![Development](https://img.shields.io/badge/-development-blue) |
6060
| `high` | Service is important but has degradation tolerance or fallback mechanisms. [6] | ![Development](https://img.shields.io/badge/-development-blue) |
6161
| `low` | Service is non-essential to core operations; used for background tasks or internal tools. [7] | ![Development](https://img.shields.io/badge/-development-blue) |

docs/registry/entities/service.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,23 @@ port.
5656

5757
**[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.
5858

59+
---
60+
61+
`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.
62+
63+
| Value | Description | Stability |
64+
| --- | --- | --- |
65+
| `critical` | Service is business-critical; downtime directly impacts revenue, user experience, or core functionality. [5] | ![Development](https://img.shields.io/badge/-development-blue) |
66+
| `high` | Service is important but has degradation tolerance or fallback mechanisms. [6] | ![Development](https://img.shields.io/badge/-development-blue) |
67+
| `low` | Service is non-essential to core operations; used for background tasks or internal tools. [7] | ![Development](https://img.shields.io/badge/-development-blue) |
68+
| `medium` | Service provides supplementary functionality; degradation has limited user impact. [8] | ![Development](https://img.shields.io/badge/-development-blue) |
69+
70+
**[5]:** Examples include payment processing, authentication, and primary user-facing APIs.
71+
72+
**[6]:** Examples include shopping cart, search, and recommendation engines.
73+
74+
**[7]:** Examples include batch processors, cleanup jobs, and internal dashboards.
75+
76+
**[8]:** Examples include analytics, reporting, and non-essential integrations.
77+
5978
<!-- markdownlint-restore -->

docs/resource/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,25 @@ port.
122122
**[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.
123123

124124
**[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.
125+
126+
---
127+
128+
`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.
129+
130+
| Value | Description | Stability |
131+
| --- | --- | --- |
132+
| `critical` | Service is business-critical; downtime directly impacts revenue, user experience, or core functionality. [5] | ![Development](https://img.shields.io/badge/-development-blue) |
133+
| `high` | Service is important but has degradation tolerance or fallback mechanisms. [6] | ![Development](https://img.shields.io/badge/-development-blue) |
134+
| `low` | Service is non-essential to core operations; used for background tasks or internal tools. [7] | ![Development](https://img.shields.io/badge/-development-blue) |
135+
| `medium` | Service provides supplementary functionality; degradation has limited user impact. [8] | ![Development](https://img.shields.io/badge/-development-blue) |
136+
137+
**[5]:** Examples include payment processing, authentication, and primary user-facing APIs.
138+
139+
**[6]:** Examples include shopping cart, search, and recommendation engines.
140+
141+
**[7]:** Examples include batch processors, cleanup jobs, and internal dashboards.
142+
143+
**[8]:** Examples include analytics, reporting, and non-essential integrations.
125144
<!-- markdownlint-restore -->
126145
<!-- prettier-ignore-end -->
127146
<!-- END AUTOGENERATED TEXT -->

0 commit comments

Comments
 (0)