Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dotnet8 metrics in otel format #1

Closed
wants to merge 73 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
73 commits
Select commit Hold shift + click to select a range
007a4a8
HTTP version should be 2 and 3 instead of 2.0 and 3.0 (#228)
lmolkova Aug 6, 2023
9d45283
Generate FaaS metrics semconv from YAML (#88)
joaopgrassi Aug 7, 2023
6c0c6a0
Re-introduce namespace to describe the original destination (#156)
joaopgrassi Aug 7, 2023
761ddca
Move Joao Grassi from approver to maintainer (#239)
reyang Aug 8, 2023
313092c
Update destination attribute briefs (#243)
trask Aug 10, 2023
d5b8de4
Rename all JVM metrics from process.runtime.jvm.* to jvm.* (#241)
trask Aug 10, 2023
a0143da
Improve symmetry in client/server address/port text (#244)
trask Aug 14, 2023
2927d58
add namespace to jvm metric attributes (#20)
zeitlinger Aug 14, 2023
2cfb136
Remove unnecessary portion of http.request.method note (#248)
trask Aug 14, 2023
728c3ca
`http/dup` has higher precedence than `http` in `OTEL_SEMCONV_STABILI…
trask Aug 14, 2023
c83a10a
Move network attributes out of trace folder (#256)
trask Aug 15, 2023
0669ca5
Add `jvm.cpu.count` metric (#52)
trask Aug 16, 2023
3bd1c39
Rename `jvm.classes.current_loaded` to `jvm.classes.count` (#60)
trask Aug 16, 2023
a42aecc
Rename jvm.buffer.(usage|limit) to jvm.buffer.memory.(usage|limit) (#…
trask Aug 17, 2023
098db1c
Remove pluralization from JVM metric namespaces (#252)
trask Aug 17, 2023
99f3f9d
Move JVM metrics to their own page (#271)
trask Aug 21, 2023
4bbb8c9
Simplify HTTP metric briefs (#276)
trask Aug 22, 2023
4fcf4df
Clarify stabilization plan does not just apply to attributes (#278)
alanwest Aug 30, 2023
6c20838
Update CODEOWNERS jvm paths (#301)
trask Sep 6, 2023
fcad0aa
Add host cpu info (#209)
ChrsMark Sep 7, 2023
ff20082
Fix unit for hw.network.bandwidth.limit metric (#91)
bertysentry Sep 7, 2023
9e3ac90
Add oci.manifest.digest, container.image.repo_digests and make contai…
ChrsMark Sep 11, 2023
58b08c9
Add `cluster.name` and `node.name` attributes to Elasticsearch semant…
stevejgordon Sep 11, 2023
d7930d3
Move RPC streaming notes from metric brief section to notes section (…
trask Sep 11, 2023
3e16365
chore: fix doc reference to docs (#305)
karmingc Sep 11, 2023
5f6558d
Use `HTTP` instead of `_OTHER` in HTTP span names (if method is unkno…
lmolkova Sep 11, 2023
2bad9af
Introduce request error type attribute (#205)
lmolkova Sep 11, 2023
db3a9aa
[.github/CODEOWNERS] Add semconv system approvers (#309)
mx-psi Sep 11, 2023
d80c8e3
BREAKING: Generate System metrics semconv from YAML + move attributes…
joaopgrassi Sep 12, 2023
48dc44c
Bump semantic conventions tooling to v0.21.0 (#310)
ChrsMark Sep 12, 2023
58c52c5
Update client address to be consistent with server address (#302)
trask Sep 12, 2023
e880bdd
Fix System metrics yaml warning (#322)
joaopgrassi Sep 13, 2023
875cfef
Reduce restrictions on which metrics may be named utilization (#280)
TylerHelmuth Sep 18, 2023
a5979b0
Make messaging payload attributes consistent with other conventions (…
pyohannes Sep 19, 2023
203691d
Improve `error.type` wording in HTTP semconv (#331)
trask Sep 20, 2023
9db3c5f
Rename http body size metrics to match attribute names (#247)
trask Sep 21, 2023
6166960
Remove experimental Kafka metrics (#338)
pyohannes Sep 21, 2023
a89f573
Session.id semantic convention (#215)
bryce-b Sep 22, 2023
650be8f
Add system.linux.memory.available metric (#323)
ItsLastDay Sep 22, 2023
e4b6728
Move non-`network.*` attributes out of network.yaml (#296)
trask Sep 22, 2023
65eed24
Add android.yaml and android.os.api.level resource attribute (#328)
surbhiia Sep 22, 2023
c7b094d
Remove service.version from list of attributes with dedicated env var…
anuraaga Sep 25, 2023
1d3d63b
Update span name recommendation for HTTP Server (#287)
gouthamve Sep 25, 2023
984079e
Adding os.build_id resource attribute and discussion why os.sdk.versi…
surbhiia Sep 25, 2023
2ef85e6
Moved template attributes to yaml model files (#315)
AlexanderWert Sep 26, 2023
2bcee3c
Add container labels field from ECS (#125)
ChrsMark Sep 26, 2023
9790d8f
Remove the zero bucket boundary from `http.server.request.duration` a…
trask Sep 26, 2023
50c5424
Port, address clarifications (#289)
Oberon00 Sep 29, 2023
fe1797e
Add url.scheme to http client metrics (#357)
lmolkova Oct 2, 2023
5628684
BREAKING: Remove `server.socket.address` attribute from http and rpc …
trask Oct 2, 2023
3286326
Improve network briefs (#352)
trask Oct 2, 2023
590aff7
Document the difference between host and system metrics (#324)
ChrsMark Oct 2, 2023
2c065be
Editorial: Update build-tools to 0.22.0 and sort attributes alphabeti…
lmolkova Oct 3, 2023
5181f04
Move Alexander Wert from approver to maintainer (#363)
reyang Oct 4, 2023
b33f2fc
telemetry.distro.name and telemetry.distro.version (#178)
zeitlinger Oct 5, 2023
2c30cf6
Add semconv-mobile-approvers (#368)
breedx-splk Oct 5, 2023
5436da4
Improve HTTP metric briefs (#366)
trask Oct 6, 2023
0af7e0e
[resource/host] Add semantic convention for IP addresses of a host (#…
mx-psi Oct 9, 2023
4efa49f
Require two approvals from different companies before merging the PR …
reyang Oct 9, 2023
559bf8b
Move runtime semconv to its own folder (#371)
joaopgrassi Oct 9, 2023
4040095
Separation of attribute definitions from attribute usages: HTTP (#208)
AlexanderWert Oct 9, 2023
0b5a2f3
Rename/replace `(client|server).socket.(address|port)` attributes wit…
trask Oct 10, 2023
7311eb1
Fix schema transformation added in #229 (#375)
trask Oct 11, 2023
b127e12
Bump to latest specification version. (#379)
jsuereth Oct 11, 2023
f07ad81
Increase markdown-link-check timeout (#393)
joaopgrassi Oct 12, 2023
4c7e85d
Add missing maintainers to auto_assign_issue.yml and auto_assign_pr.y…
arminru Oct 12, 2023
ec3a4cf
Remove repetitive notes, briefs, etc on ref attributes (#367)
lmolkova Oct 12, 2023
cadfe53
Stage 1.22.0 release for review. (#380)
jsuereth Oct 12, 2023
ea50a0d
Add sections to changelog for easier user consumption on release. (#397)
jsuereth Oct 12, 2023
f214f12
dotnet http metrics
lmolkova Jul 24, 2023
d3eaa69
asp.net core switch to error.type and rebase
lmolkova Oct 3, 2023
bae9a8d
update according to .net changes
lmolkova Oct 12, 2023
795dbf1
nits
lmolkova Oct 12, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
#
# Learn about membership in OpenTelemetry community:
# https://github.com/open-telemetry/community/blob/main/community-membership.md
#
#
# Learn about CODEOWNERS file format:
#
# Learn about CODEOWNERS file format:
# https://help.github.com/en/articles/about-code-owners
#

# Global owners, will be the owners for everything in the repo. Membership is tracked via https://github.com/open-telemetry/community/blob/main/community-members.md
# Global owners, will be the owners for everything in the repo. Membership is tracked via https://github.com/open-telemetry/community/blob/main/community-members.md

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Global owners, will be the owners for everything in the repo. Membership is tracked via https://github.com/open-telemetry/community/blob/main/community-members.md
# Global owners are the owners for everything in the repo. Membership is tracked via https://github.com/open-telemetry/community/blob/main/community-members.md

* @open-telemetry/specs-semconv-maintainers @open-telemetry/specs-semconv-approvers

# Schemas and schema file tooling
Expand All @@ -28,11 +28,25 @@
/docs/logs/ @open-telemetry/specs-semconv-approvers @tigrannajaryan

# JVM semantic conventions approvers
/model/metrics/process-runtime-jvm-metrics.yaml @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-jvm-approvers
/model/metrics/process-runtime-jvm-metrics-experimental.yaml @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-jvm-approvers
/model/metrics/jvm-* @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-jvm-approvers
/docs/jvm/ @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-jvm-approvers

# HTTP semantic conventions approvers
/model/metrics/http.yaml @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-http-approvers
/model/trace/http.yaml @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-http-approvers

# System semantic conventions approvers
/docs/system/ @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-system-approvers
/model/metrics/system-* @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-system-approvers
/docs/resource/host.md @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-system-approvers
/model/resource/host.yaml @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-system-approvers

# Mobile semantic conventions approvers
/docs/mobile/ @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-mobile-approvers
/model/logs/mobile* @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-mobile-approvers

# .NET semantic conventions approvers
/model/metrics/dotnet/ @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-dotnet-approvers
/docs/dotnet/ @open-telemetry/specs-semconv-approvers @open-telemetry/semconv-dotnet-approvers

# TODO - Add semconv area experts
2 changes: 2 additions & 0 deletions .github/auto_assign_issue.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ addAssignees: true

# A list of assignees, overrides reviewers if set
assignees:
- AlexanderWert
- arminru
- joaopgrassi
- jsuereth
- reyang

Expand Down
2 changes: 2 additions & 0 deletions .github/auto_assign_pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ useAssigneeGroups: true
# A list of assignees, split into different groups, to be added to pull requests (GitHub user name)
assigneeGroups:
maintainers:
- AlexanderWert
- arminru
- joaopgrassi
- jsuereth
- reyang

Expand Down
1 change: 1 addition & 0 deletions .markdown_link_check_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@
}
],
"retryOn429": true,
"timeout": "30s",
"aliveStatusCodes": [200, 403]
}
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"MD040": false,
},
"yaml.schemas": {
"https://raw.githubusercontent.com/open-telemetry/build-tools/v0.20.0/semantic-conventions/semconv.schema.json": [
"https://raw.githubusercontent.com/open-telemetry/build-tools/v0.21.0/semantic-conventions/semconv.schema.json": [
"semantic_conventions/**/*.yaml"
]
},
Expand Down
141 changes: 141 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,155 @@ release.

## Unreleased

### Breaking

### Features

- Add .NET 8.0 metrics for HTTP client, ASP.NET Core, SignalR server and Kestrel.
([#283](https://github.com/open-telemetry/semantic-conventions/pull/283))

### Fixes

## v1.22.0 (2023-10-12)

- Remove experimental Kafka metrics ([#338](https://github.com/open-telemetry/semantic-conventions/pull/338))
- Adds `session.id` and session.md to general docs and model
([#215](https://github.com/open-telemetry/semantic-conventions/pull/215))
- Add `container.labels.<key>` attributes.
([#125](https://github.com/open-telemetry/semantic-conventions/pull/125))
- Add `cluster.name` and `node.name` attributes to Elasticsearch semantic conventions.
([#285](https://github.com/open-telemetry/semantic-conventions/pull/285))
- Fix the unit of metric.process.runtime.jvm.system.cpu.load_1m to be {run_queue_item}
([#95](https://github.com/open-telemetry/semantic-conventions/pull/95))
- Update `.count` metric naming convention so that it only applies to UpDownCounters,
and add that `.total` should not be used by either Counters or UpDownCounters
([#107](https://github.com/open-telemetry/semantic-conventions/pull/107))
- Add `oci.manifest.digest`, `container.image.repo_digests` attributes. Make `container.image.tag` array and in plural form.
([#159](https://github.com/open-telemetry/semantic-conventions/pull/159))
- BREAKING: Rename `http.client.duration` and `http.server.duration` metrics to
`http.client.request.duration` and `http.server.request.duration` respectively.
([#224](https://github.com/open-telemetry/semantic-conventions/pull/224))
- Update HTTP `network.protocol.version` examples to match HTTP RFCs.
([#228](https://github.com/open-telemetry/semantic-conventions/pull/228))
- Re-introduce namespace and attributes to describe the original destination messages were
published to (`messaging.destination_publish.*`).
([#156](https://github.com/open-telemetry/semantic-conventions/pull/156))
- Generate FaaS metric semantic conventions from YAML.
([#88](https://github.com/open-telemetry/semantic-conventions/pull/88))
The conventions cover metrics that are recorded by the FaaS itself and not by
clients invoking them.
- BREAKING: Rename all JVM metrics from `process.runtime.jvm.*` to `jvm.*`
([#241](https://github.com/open-telemetry/semantic-conventions/pull/241))
- BREAKING: Add namespaces to JVM metric attributes ([#20](https://github.com/open-telemetry/semantic-conventions/pull/20)).
- Rename attributes `type` to `jvm.memory.type`, `pool` to `jvm.memory.pool.name`
- Applies to metrics:
- `jvm.memory.usage`
- `jvm.memory.init`
- `jvm.memory.committed`
- `jvm.memory.limit`
- `jvm.memory.usage_after_last_gc`
- Rename attributes `gc` to `jvm.gc.name`, `action` to `jvm.gc.action`
- Applies to metrics:
- `jvm.gc.duration`
- Rename attribute `daemon` to `thread.daemon`
- Applies to metrics:
- `jvm.threads.count`
- Rename attribute `pool` to `jvm.buffer.pool.name`
- Applies to metrics:
- `jvm.buffer.usage`
- `jvm.buffer.limit`
- `jvm.buffer.count`
- Clarify that `http/dup` has higher precedence than `http` in case both values are present
in `OTEL_SEMCONV_STABILITY_OPT_IN`
([#249](https://github.com/open-telemetry/semantic-conventions/pull/249))
- Add `jvm.cpu.count` metric.
([#52](https://github.com/open-telemetry/semantic-conventions/pull/52))
- BREAKING: Rename metrics `jvm.buffer.usage` to `jvm.buffer.memory.usage`
and `jvm.buffer.limit` to `jvm.buffer.memory.limit`.
([#253](https://github.com/open-telemetry/semantic-conventions/pull/253))
- BREAKING: Rename `jvm.classes.current_loaded` metrics to `jvm.classes.count`
([#60](https://github.com/open-telemetry/semantic-conventions/pull/60))
- BREAKING: Remove pluralization from JVM metric namespaces.
([#252](https://github.com/open-telemetry/semantic-conventions/pull/252))
- Simplify HTTP metric briefs.
([#276](https://github.com/open-telemetry/semantic-conventions/pull/276))
- Add host cpu resource attributes.
([#209](https://github.com/open-telemetry/semantic-conventions/pull/209))
- Introduce `error.type` attribute and use it in HTTP conventions
([#205](https://github.com/open-telemetry/semantic-conventions/pull/205))
- BREAKING: Change HTTP span name when method is unknown (use `HTTP` instead of `_OTHER`)
([#270](https://github.com/open-telemetry/semantic-conventions/pull/270))
- Moved RPC streaming notes from metric brief section to notes section.
([#275](https://github.com/open-telemetry/semantic-conventions/pull/275))
- Updates `client.address` to allow domain names for consistency with `server.address`.
([#302](https://github.com/open-telemetry/semantic-conventions/pull/302))
- BREAKING: Generate System metrics semconv from YAML.
([#89](https://github.com/open-telemetry/semantic-conventions/pull/89))
- Rename attributes for `system.cpu.*` metrics:
- `state` to `system.cpu.state`
- `cpu` to `system.cpu.logical_number`
- Rename attributes for `system.memory.*` metrics:
- `state` to `system.memory.state`
- Rename attributes for `system.paging.*` metrics:
- `state` to `system.paging.state`
- `type` to `system.paging.type`
- `direction` to `system.paging.direction`
- Rename attributes for `system.disk.*` metrics:
- `device` to `system.device`
- `direction` to `system.disk.direction`
- Rename attributes for `system.filesystem.*` metrics:
- `device` to `system.device`
- `state` to `system.filesystem.state`
- `type` to `system.filesystem.type`
- `mode` to `system.filesystem.mode`
- `mountpoint` to `system.filesystem.mountpoint`
- Rename attributes for `system.network.*` metrics:
- `device` to `system.device`
- `direction` to `system.network.direction`
- `protocol` to `network.protocol`
- `state` to `system.network.state`
- Rename attributes for `system.processes.*` metrics:
- `status` to `system.processes.status`
- BREAKING: Rename `messaging.message.payload_size_bytes` to `messaging.message.body.size`,
remove `messaging.message.payload_compressed_size_bytes`.
([#229](https://github.com/open-telemetry/semantic-conventions/pull/229))
- Add `system.linux.memory.available` metric.
([#323](https://github.com/open-telemetry/semantic-conventions/pull/323))
- BREAKING: Rename `http.server.request.size` metric to `http.server.request.body.size`
and `http.server.response.size` metric to `http.server.response.body.size`
([#247](https://github.com/open-telemetry/semantic-conventions/pull/247))
- Move non-`network.*` attributes out of network.yaml.
([#296](https://github.com/open-telemetry/semantic-conventions/pull/296))
- Introducing Android `android.os.api_level` resource attribute.
([#328](https://github.com/open-telemetry/semantic-conventions/pull/328))
- Added `os.build_id` resource attribute.
([#293](https://github.com/open-telemetry/semantic-conventions/pull/293))
- BREAKING: Remove the zero bucket boundary from `http.server.request.duration`
and `http.client.request.duration`.
([#318](https://github.com/open-telemetry/semantic-conventions/pull/318))
- Encourage setting `network.transport` when reporting port numbers
([#289](https://github.com/open-telemetry/semantic-conventions/pull/289))
- BREAKING: Add `url.scheme` to `http.client.*` metrics
([#357](https://github.com/open-telemetry/semantic-conventions/pull/357))
- BREAKING: Remove `server.socket.address` from HTTP and RPC client metrics.
([#350](https://github.com/open-telemetry/semantic-conventions/pull/350))
- Improve network attribute briefs.
([#352](https://github.com/open-telemetry/semantic-conventions/pull/352))
- Document the difference between host and system metrics
([#324](https://github.com/open-telemetry/semantic-conventions/pull/324))
- BREAKING: Rename `telemetry.auto.version` resource attribute to `telemetry.distro.version`
and add `telemetry.distro.name` resource attribute
([#178](https://github.com/open-telemetry/semantic-conventions/pull/178))
- Improve HTTP metric briefs.
([#366](https://github.com/open-telemetry/semantic-conventions/pull/366))
- Add `host.ip` resource attribute convention.
([#203](https://github.com/open-telemetry/semantic-conventions/pull/203))
- BREAKING: Rename/replace `(client|server).socket.(address|port)` attributes
with `network.(peer|local).(address|port)`.
([#342](https://github.com/open-telemetry/semantic-conventions/pull/342))
- Make `network.protocol.name|version` description consistent between HTTP
spans and metrics.
([#367](https://github.com/open-telemetry/semantic-conventions/pull/367))

## v1.21.0 (2023-07-13)

Expand Down
28 changes: 23 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,18 @@ key, but non-obvious, aspects:
- All descriptions, normative language are defined in the `docs/`
directory.
- We provide tooling to generate Markdown documentation from the formal
YAML definitons. See [Yaml to Markdown](#yaml-to-markdown).
YAML definitons. See [Yaml to Markdown](#yaml-to-markdown).
- We use Hugo to render [semantic conventions on our website](https://opentelemetry.io/docs/specs/semconv/).
You will see `<!--- Hugo front matter used to generate ...` sections
in markdown. See [Hugo frontmatter](#hugo-frontmatter) for details.
in markdown. See [Hugo frontmatter](#hugo-frontmatter) for details.
- All changes to existing attributes, metrics, etc. MUST be allowed as
per our [stability guarantees](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/versioning-and-stability.md#semantic-conventions-stability) and
defined in a schema file. As part of any contribution, you should
per our [stability guarantees][stability guarantees] and
defined in a schema file. As part of any contribution, you should
include attribute changes defined in the `schema-next.yaml` file.
For details, please read [the schema specification](https://opentelemetry.io/docs/specs/otel/schemas/).
- After creating a pull request, please update the [CHANGELOG](CHANGELOG.md) file with
a description of your changes.

Please make sure all Pull Requests are compliant with these rules!

### Hugo frontmatter
Expand Down Expand Up @@ -157,6 +157,23 @@ To quickly fix typos, use
make misspell-correction
```

### How to get your PR merged

A PR (pull request) is considered to be **ready to merge** when:

* It has received at least two approvals from the [code
owners](./.github/CODEOWNERS) (if approvals are from only one company, they
won't count).
* There is no `request changes` from the [code owners](./.github/CODEOWNERS).
* It has been at least two working days since the last modification (except for
the trivial updates, such like typo, cosmetic, rebase, etc.). This gives
people reasonable time to review.
* Trivial changes (typos, cosmetic changes, CI improvements, etc.) don't have to
wait for two days.

Any [maintainer](./README.md#contributing) can merge the PR once it is **ready
to merge**.

## Updating the referenced specification version

1. Open the `./internal/tools/update_specification_version.sh` script.
Expand All @@ -181,3 +198,4 @@ make misspell-correction
- Create a tag `v{version}` on the merged PR and push remote.

[nvm]: https://github.com/nvm-sh/nvm/blob/master/README.md#installing-and-updating
[stability guarantees]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.26.0/specification/versioning-and-stability.md#semantic-conventions-stability
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ MISSPELL = $(TOOLS_DIR)/$(MISSPELL_BINARY)

# 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.20.0
SEMCONVGEN_VERSION=0.22.0

# TODO: add `yamllint` step to `all` after making sure it works on Mac.
.PHONY: all
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,16 @@ This repository is currently using [this specification version][SpecificationVer

## Read the docs

The documentation currently resides in the [doc](docs/README.md) folder.
The documentation currently resides in the [docs](docs/README.md) folder.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

Approvers ([@open-telemetry/specs-semconv-approvers](https://github.com/orgs/open-telemetry/teams/specs-semconv-approvers)):

- [Alexander Wert](https://github.com/AlexanderWert), Elastic
- [Christian Neumüller](https://github.com/Oberon00), Dynatrace
- [James Moessis](https://github.com/jamesmoessis), Atlassian
- [Joao Grassi](https://github.com/joaopgrassi), Dynatrace
- [Johannes Tax](https://github.com/pyohannes), Grafana Labs
- [Liudmila Molkova](https://github.com/lmolkova), Microsoft
- [Sean Marciniak](https://github.com/MovieStoreGuy), Atlassian
Expand All @@ -30,10 +28,12 @@ _Find more about the approver role in [community repository](https://github.com/

Maintainers ([@open-telemetry/specs-semconv-maintainers](https://github.com/orgs/open-telemetry/teams/specs-semconv-maintainers)):

- [Armin Ruech](https://github.com/arminru)
- [Josh Suereth](https://github.com/jsuereth)
- [Reiley Yang](https://github.com/reyang)
- [Alexander Wert](https://github.com/AlexanderWert), Elastic
- [Armin Ruech](https://github.com/arminru), Dynatrace
- [Joao Grassi](https://github.com/joaopgrassi), Dynatrace
- [Josh Suereth](https://github.com/jsuereth), Google
- [Reiley Yang](https://github.com/reyang), Microsoft

_Find more about the maintainer role in [community repository](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer)._

[SpecificationVersion]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.22.0
[SpecificationVersion]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0
32 changes: 32 additions & 0 deletions docs/attributes-registry/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Registry
weight: -2
--->

# Attributes Registry

The attributes registry is the place where attributes are defined. An attribute definition covers the following properties of an attribute:

- the `id` (the fully qualified name) of the attribute
- the `type` of the attribute
- a `brief` description of the attribute and optionally a longer `note`
- example values

Attributes defined in the registry can be used in different semantic conventions. Attributes should be included in this registry before they are used in semantic conventions. Semantic conventions may override all the properties of an attribute except for the `id` and `type` in case it's required for a particular context. In addition, semantic conventions specify the requirement level of an attribute in the corresponding context.

A definition of an attribute in the registry does not necessarily imply that the attribute is used in any of the semantic conventions.

If applicable, application developers are encouraged to use existing attributes from this registry. See also [these recommendations][developers recommendations] regarding attribute selection and attribute naming for custom use cases.

All registered attributes are listed by namespace in this registry.

> **Warning**
> The following registry overview is a work in progress.
>
> Further attribute namespaces are currently being migrated and will appear in this registry soon.

Currently, the following namespaces exist:

* [HTTP](http.md)

[developers recommendations]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/common/attribute-naming.md#recommendations-for-application-developers
Loading
Loading