Skip to content

Commit 15c9a01

Browse files
authored
Merge branch 'main' into website-toc
2 parents 727326f + e1821fe commit 15c9a01

32 files changed

+644
-222
lines changed

.chloggen/1757.yaml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
change_type: breaking
2+
component: gen-ai
3+
note: "Introduce `gen_ai.output.type`and deprecate `gen_ai.openai.request.response_format`"
4+
issues: [1757]

.chloggen/add_enduser_pseudo_id.yaml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
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: enduser
11+
12+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
13+
note: Undeprecate 'enduser.id' and introduce new attribute `enduser.pseudo.id`
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: [1104]
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+
The new attribute `enduser.pseudo.id` is intended to provide a unique identifier of a pseudonymous enduser.

.chloggen/fix_k8s_metrics.yaml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
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: breaking
8+
9+
# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
10+
component: k8s
11+
12+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
13+
note: Change k8s.replication_controller metrics to k8s.replicationcontroller
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: [1848]
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:
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
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: cicd
11+
12+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
13+
note: Adds a new attribute `cicd.pipeline.run.url.full` and corrects the attribute description of `cicd.pipeline.task.run.url.full`
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: [1796]
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:

.chloggen/user_agent_os.yaml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
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: user-agent
11+
12+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
13+
note: Add `user_agent.os.name` and `user_agent.os.version` attributes
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: [1433]
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:

.github/ISSUE_TEMPLATE/bug_report.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ body:
4545
- area:dns
4646
- area:dotnet
4747
- area:elasticsearch
48+
- area:enduser
4849
- area:error
4950
- area:exception
5051
- area:faas

.github/ISSUE_TEMPLATE/change_proposal.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ body:
3737
- area:dns
3838
- area:dotnet
3939
- area:elasticsearch
40+
- area:enduser
4041
- area:error
4142
- area:exception
4243
- area:faas

CONTRIBUTING.md

+13
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ requirements and recommendations.
1414
- [Sign the CLA](#sign-the-cla)
1515
- [How to Contribute](#how-to-contribute)
1616
- [Which semantic conventions belong in this repo](#which-semantic-conventions-belong-in-this-repo)
17+
- [Suggesting conventions for a new area](#suggesting-conventions-for-a-new-area)
1718
- [Prerequisites](#prerequisites)
1819
- [1. Modify the YAML model](#1-modify-the-yaml-model)
1920
- [Code structure](#code-structure)
@@ -81,6 +82,18 @@ and helps to keep conventions consistent and backward compatible.
8182
Want to define your own conventions outside this repo while building on OTel’s?
8283
Come help us [decentralize semantic conventions](https://github.com/open-telemetry/weaver/issues/215).
8384

85+
### Suggesting conventions for a new area
86+
87+
Defining semantic conventions requires a group of people who are familiar with the domain,
88+
are involved with instrumentation efforts, and are committed to be the point of contact for
89+
pull requests, issues, and questions in this area.
90+
91+
Check out [project management](https://github.com/open-telemetry/community/blob/main/project-management.md)
92+
for the details on how to start.
93+
94+
Refer to the [How to define new conventions](/docs/general/how-to-define-semantic-conventions.md)
95+
document for guidance.
96+
8497
### Prerequisites
8598

8699
The Specification uses several tools to check things like style,

dependencies.Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
FROM otel/weaver:v0.12.0 AS weaver
77

88
# OPA is used to test policies enforced by weaver.
9-
FROM openpolicyagent/opa:1.0.1 AS opa
9+
FROM openpolicyagent/opa:1.1.0 AS opa
1010

1111
# Semconv gen is used for backwards compatibility checks.
1212
# TODO(jsuereth): Remove this when no longer used.

docs/attributes-registry/cicd.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,10 @@ This group describes attributes specific to pipelines within a Continuous Integr
1313
| <a id="cicd-pipeline-result" href="#cicd-pipeline-result">`cicd.pipeline.result`</a> | string | The result of a pipeline run. | `success`; `failure`; `timeout`; `skipped` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
1414
| <a id="cicd-pipeline-run-id" href="#cicd-pipeline-run-id">`cicd.pipeline.run.id`</a> | string | The unique identifier of a pipeline run within a CI/CD system. | `120912` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
1515
| <a id="cicd-pipeline-run-state" href="#cicd-pipeline-run-state">`cicd.pipeline.run.state`</a> | string | The pipeline run goes through these states during its lifecycle. | `pending`; `executing`; `finalizing` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
16+
| <a id="cicd-pipeline-run-url-full" href="#cicd-pipeline-run-url-full">`cicd.pipeline.run.url.full`</a> | string | The [URL](https://wikipedia.org/wiki/URL) of the pipeline run, providing the complete address in order to locate and identify the pipeline run. | `https://github.com/open-telemetry/semantic-conventions/actions/runs/9753949763?pr=1075` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
1617
| <a id="cicd-pipeline-task-name" href="#cicd-pipeline-task-name">`cicd.pipeline.task.name`</a> | string | The human readable name of a task within a pipeline. Task here most closely aligns with a [computing process](https://wikipedia.org/wiki/Pipeline_(computing)) in a pipeline. Other terms for tasks include commands, steps, and procedures. | `Run GoLang Linter`; `Go Build`; `go-test`; `deploy_binary` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
1718
| <a id="cicd-pipeline-task-run-id" href="#cicd-pipeline-task-run-id">`cicd.pipeline.task.run.id`</a> | string | The unique identifier of a task run within a pipeline. | `12097` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
18-
| <a id="cicd-pipeline-task-run-url-full" href="#cicd-pipeline-task-run-url-full">`cicd.pipeline.task.run.url.full`</a> | string | The [URL](https://wikipedia.org/wiki/URL) of the pipeline run providing the complete address in order to locate and identify the pipeline run. | `https://github.com/open-telemetry/semantic-conventions/actions/runs/9753949763/job/26920038674?pr=1075` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
19+
| <a id="cicd-pipeline-task-run-url-full" href="#cicd-pipeline-task-run-url-full">`cicd.pipeline.task.run.url.full`</a> | string | The [URL](https://wikipedia.org/wiki/URL) of the pipeline task run, providing the complete address in order to locate and identify the pipeline task run. | `https://github.com/open-telemetry/semantic-conventions/actions/runs/9753949763/job/26920038674?pr=1075` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
1920
| <a id="cicd-pipeline-task-type" href="#cicd-pipeline-task-type">`cicd.pipeline.task.type`</a> | string | The type of the task within a pipeline. | `build`; `test`; `deploy` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
2021
| <a id="cicd-system-component" href="#cicd-system-component">`cicd.system.component`</a> | string | The name of a component of the CICD system. | `controller`; `scheduler`; `agent` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
2122
| <a id="cicd-worker-state" href="#cicd-worker-state">`cicd.worker.state`</a> | string | The state of a CICD worker / agent. | `idle`; `busy`; `down` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

docs/attributes-registry/enduser.md

+23-2
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,33 @@
33

44
# Enduser
55

6+
- [End User Attributes](#end-user-attributes)
7+
- [Deprecated End User Attributes](#deprecated-end-user-attributes)
8+
9+
## End User Attributes
10+
11+
Describes the end user.
12+
13+
| Attribute | Type | Description | Examples | Stability |
14+
|---|---|---|---|---|
15+
| <a id="enduser-id" href="#enduser-id">`enduser.id`</a> | string | Unique identifier of an end user in the system. It maybe a username, email address, or other identifier. [1] | `username` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
16+
| <a id="enduser-pseudo-id" href="#enduser-pseudo-id">`enduser.pseudo.id`</a> | string | Pseudonymous identifier of an end user. This identifier should be a random value that is not directly linked or associated with the end user's actual identity. [2] | `QdH5CAWJgqVT4rOr0qtumf` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
17+
18+
**[1] `enduser.id`:** Unique identifier of an end user in the system.
19+
20+
> [!Warning]
21+
> This field contains sensitive (PII) information.
22+
23+
**[2] `enduser.pseudo.id`:** Pseudonymous identifier of an end user.
24+
25+
> [!Warning]
26+
> This field contains sensitive (linkable PII) information.
27+
628
## Deprecated End User Attributes
729

8-
Describes deprecated enduser attributes. Complete enduser namespace has been deprecated
30+
Describes deprecated enduser attributes.
931

1032
| Attribute | Type | Description | Examples | Stability |
1133
|---|---|---|---|---|
12-
| <a id="enduser-id" href="#enduser-id">`enduser.id`</a> | string | Deprecated, use `user.id` instead. | `username` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `user.id` attribute. |
1334
| <a id="enduser-role" href="#enduser-role">`enduser.role`</a> | string | Deprecated, use `user.roles` instead. | `admin` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `user.roles` attribute. |
1435
| <a id="enduser-scope" href="#enduser-scope">`enduser.scope`</a> | string | Deprecated, no replacement at this time. | `read:message, write:files` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Removed. |

0 commit comments

Comments
 (0)