Skip to content

Commit

Permalink
Merge branch 'main' into first-gen-ai
Browse files Browse the repository at this point in the history
  • Loading branch information
nirga committed Apr 1, 2024
2 parents f1fe748 + a04a1f4 commit 0c058cb
Show file tree
Hide file tree
Showing 181 changed files with 4,686 additions and 3,775 deletions.
22 changes: 22 additions & 0 deletions .chloggen/627.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Use this changelog template to create an entry for release notes.
#
# If your change doesn't affect end users you should instead start
# your pull request title with [chore] or use the "Skip Changelog" label.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
component: rpc

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Add link to specification for metrics defined by gRPC community.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: [627]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:
7 changes: 7 additions & 0 deletions .chloggen/698.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
change_type: breaking

component: messaging

note: Remove `network.transport` and `network.type` attributes from messaging semantic conventions, clarify when `network.peer.address|port` should be populated.

issues: [690, 698]
22 changes: 22 additions & 0 deletions .chloggen/738.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Use this changelog template to create an entry for release notes.
#
# If your change doesn't affect end users you should instead start
# your pull request title with [chore] or use the "Skip Changelog" label.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
component: db

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Update Elasticsearch attributes to use db.instance.id instead of db.elasticsearch.node.name

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: [725]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:
4 changes: 4 additions & 0 deletions .chloggen/817.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
change_type: bug_fix
component: network
note: Clarifies that network.protocol.version represents negotiated version
issues: [ 686 ]
4 changes: 4 additions & 0 deletions .chloggen/820.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
change_type: enhancement
component: other
note: Update build-tools version to 0.24.0 and make semantic conventions compatible with this version (add stability on enum members and deprecated attributes).
issues: [ 807 ]
21 changes: 21 additions & 0 deletions .chloggen/add_new_container_metrics.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Use this changelog template to create an entry for release notes.
#
# If your change doesn't affect end users you should instead start
# your pull request title with [chore] or use the "Skip Changelog" label.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: "enhancement"

# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
component: "container"

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: "Add new container metrics for `cpu`, `memory`, `disk` and `network`"

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [282, 72]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:
22 changes: 22 additions & 0 deletions .chloggen/file.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Use this changelog template to create an entry for release notes.
#
# If your change doesn't affect end users you should instead start
# your pull request title with [chore] or use the "Skip Changelog" label.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: new_component

# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
component: file

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Add new file namespace

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: [732]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,23 @@ body:
- area:browser
- area:client
- area:cloud
- area:cloudevents
- area:code
- area:container
- area:db
- area:deployment
- area:destination
- area:device
- area:disk
- area:dns
- area:enduser
- area:error
- area:exception
- area:faas
- area:feature-flag
- area:file
- area:gcp-cloud-run
- area:gcp-gce
- area:gen-ai
- area:host
- area:http
Expand Down
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/change_proposal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,23 @@ body:
- area:browser
- area:client
- area:cloud
- area:cloudevents
- area:code
- area:container
- area:db
- area:deployment
- area:destination
- area:device
- area:disk
- area:dns
- area:enduser
- area:error
- area:exception
- area:faas
- area:feature-flag
- area:file
- area:gcp-cloud-run
- area:gcp-gce
- area:gen-ai
- area:host
- area:http
Expand Down
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/new-conventions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,23 @@ body:
- area:browser
- area:client
- area:cloud
- area:cloudevents
- area:code
- area:container
- area:db
- area:deployment
- area:destination
- area:device
- area:disk
- area:dns
- area:enduser
- area:error
- area:exception
- area:faas
- area:feature-flag
- area:file
- area:gcp-cloud-run
- area:gcp-gce
- area:gen-ai
- area:host
- area:http
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/scripts/generate-registry-area-labels.sh
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ for AREA in ${AREAS}; do
continue
fi
echo "area:${LABEL_NAME}"
gh label create "area:${LABEL_NAME}" -c "#425cc7"
gh label create "area:${LABEL_NAME}" -c "#425cc7" --force
done

echo -e "\nLabels created successfully"
Expand Down
4 changes: 2 additions & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
"MD040": false,
},
"yaml.schemas": {
"https://raw.githubusercontent.com/open-telemetry/build-tools/v0.21.0/semantic-conventions/semconv.schema.json": [
"semantic_conventions/**/*.yaml"
"https://raw.githubusercontent.com/open-telemetry/build-tools/v0.24.0/semantic-conventions/semconv.schema.json": [
"model/**/*.yaml",
]
},
"json.schemaDownload.enable": true
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ environment configured:
### 1. Modify the YAML model

Refer to the
[Semantic Convention YAML Language](https://github.com/open-telemetry/build-tools/blob/v0.23.0/semantic-conventions/syntax.md)
[Semantic Convention YAML Language](https://github.com/open-telemetry/build-tools/blob/v0.24.0/semantic-conventions/syntax.md)
to learn how to make changes to the YAML files.

#### Schema files
Expand Down
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ CHLOGGEN_CONFIG := .chloggen/config.yaml

# see https://github.com/open-telemetry/build-tools/releases for semconvgen updates
# Keep links in model/README.md and .vscode/settings.json in sync!
SEMCONVGEN_VERSION=0.23.0
SEMCONVGEN_VERSION=0.24.0

# TODO: add `yamllint` step to `all` after making sure it works on Mac.
.PHONY: all
Expand Down Expand Up @@ -95,13 +95,13 @@ yamllint:
.PHONY: table-generation
table-generation:
docker run --rm -v $(PWD)/model:/source -v $(PWD)/docs:/spec \
otel/semconvgen:$(SEMCONVGEN_VERSION) -f /source markdown -md /spec --md-use-badges --md-stable
otel/semconvgen:$(SEMCONVGEN_VERSION) -f /source markdown

# Check if current markdown tables differ from the ones that would be generated from YAML definitions
.PHONY: table-check
table-check:
docker run --rm -v $(PWD)/model:/source -v $(PWD)/docs:/spec \
otel/semconvgen:$(SEMCONVGEN_VERSION) -f /source markdown -md /spec --md-check --md-use-badges --md-stable
otel/semconvgen:$(SEMCONVGEN_VERSION) -f /source markdown -md /spec

.PHONY: schema-check
schema-check:
Expand Down
7 changes: 7 additions & 0 deletions docs/attributes-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,22 @@ Currently, the following namespaces exist:
* [Browser](browser.md)
* [Client](client.md)
* [Cloud](cloud.md)
* [CloudEvents](cloudevents.md)
* [Code](code.md)
* [Container](container.md)
* [DB](db.md) (database)
* [Deployment](deployment.md)
* [Destination](destination.md)
* [Device](device.md)
* [Disk](disk.md)
* [End user](enduser.md)
* [Error](error.md)
* [Exception](exception.md)
* [FaaS](faas.md)
* [Feature Flag](feature-flag.md)
* [File](file.md)
* [Google Cloud Run](gcp-cloud-run.md)
* [Google Compute Engine](gcp-gce.md)
* [Host](host.md)
* [HTTP](http.md)
* [K8s](k8s.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/attributes-registry/android.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Android Attributes
<!-- semconv registry.android(omit_requirement_level) -->
| Attribute | Type | Description | Examples |
|---|---|---|---|
| `android.os.api_level` | string | Uniquely identifies the framework API revision offered by a version (`os.version`) of the android operating system. More information can be found [here](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels). | `33`; `32` |
| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| `android.os.api_level` | string | Uniquely identifies the framework API revision offered by a version (`os.version`) of the android operating system. More information can be found [here](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels). | `33`; `32` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
<!-- endsemconv -->
12 changes: 6 additions & 6 deletions docs/attributes-registry/browser.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
## Browser Attributes

<!-- semconv registry.browser(omit_requirement_level) -->
| Attribute | Type | Description | Examples |
|---|---|---|---|
| `browser.brands` | string[] | Array of brand name and version separated by a space [1] | `[ Not A;Brand 99, Chromium 99, Chrome 99]` |
| `browser.language` | string | Preferred language of the user using the browser [2] | `en`; `en-US`; `fr`; `fr-FR` |
| `browser.mobile` | boolean | A boolean that is true if the browser is running on a mobile device [3] | |
| `browser.platform` | string | The platform on which the browser is running [4] | `Windows`; `macOS`; `Android` |
| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| `browser.brands` | string[] | Array of brand name and version separated by a space [1] | `[ Not A;Brand 99, Chromium 99, Chrome 99]` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `browser.language` | string | Preferred language of the user using the browser [2] | `en`; `en-US`; `fr`; `fr-FR` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `browser.mobile` | boolean | A boolean that is true if the browser is running on a mobile device [3] | | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `browser.platform` | string | The platform on which the browser is running [4] | `Windows`; `macOS`; `Android` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

**[1]:** This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.brands`).

Expand Down
8 changes: 4 additions & 4 deletions docs/attributes-registry/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ protocol / API does not expose a clear notion of client and server).
This also covers UDP network interactions where one side initiates the interaction, e.g. QUIC (HTTP/3) and DNS.

<!-- semconv client(omit_requirement_level) -->
| Attribute | Type | Description | Examples |
|---|---|---|---|
| `client.address` | string | ![Stable](https://img.shields.io/badge/-stable-lightgreen)<br>Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `client.example.com`; `10.1.2.80`; `/tmp/my.sock` |
| `client.port` | int | ![Stable](https://img.shields.io/badge/-stable-lightgreen)<br>Client port number. [2] | `65123` |
| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| `client.address` | string | Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `client.example.com`; `10.1.2.80`; `/tmp/my.sock` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| `client.port` | int | Client port number. [2] | `65123` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |

**[1]:** When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries, for example proxies, if it's available.

Expand Down
Loading

0 comments on commit 0c058cb

Please sign in to comment.