Skip to content

Fix otel urls in documentation for fieldsets with underscores #2486

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jun 5, 2025
Merged

Fix otel urls in documentation for fieldsets with underscores #2486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
39d4b43
Fix otel urls for fieldsets with underscores
mjwolf Jun 3, 2025
48fce79
Update changelog
mjwolf Jun 3, 2025
0801f64
Merge branch 'main' into fix-otel-links
trisch-me Jun 5, 2025
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
2 changes: 2 additions & 0 deletions CHANGELOG.next.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ Thanks, you're awesome :-) -->

#### Bugfixes

* Fix otel urls for fieldsets with underscores. #2486

#### Added

#### Improvements
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/ecs-otel-alignment-details.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,6 @@ The following table gives an overview of mappings between individual ECS fields
| $$$otel-mapping-for-user-name$$$ [user.name](/reference/ecs-user.md#field-user-name) | [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) | [user.name](https://opentelemetry.io/docs/specs/semconv/attributes-registry/user/#user-name) | ![development](https://img.shields.io/badge/✘-fed10c?style=flat) |
| $$$otel-mapping-for-user-roles$$$ [user.roles](/reference/ecs-user.md#field-user-roles) | [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) | [user.roles](https://opentelemetry.io/docs/specs/semconv/attributes-registry/user/#user-roles) | ![development](https://img.shields.io/badge/✘-fed10c?style=flat) |
| **User agent Fields** |
| $$$otel-mapping-for-user-agent-name$$$ [user_agent.name](/reference/ecs-user_agent.md#field-user-agent-name) | [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) | [user_agent.name](https://opentelemetry.io/docs/specs/semconv/attributes-registry/user_agent/#user-agent-name) | ![development](https://img.shields.io/badge/✘-fed10c?style=flat) |
| $$$otel-mapping-for-user-agent-original$$$ [user_agent.original](/reference/ecs-user_agent.md#field-user-agent-original) | [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) | [user_agent.original](https://opentelemetry.io/docs/specs/semconv/attributes-registry/user_agent/#user-agent-original) | ![stable](https://img.shields.io/badge/✔-93c93e?style=flat) |
| $$$otel-mapping-for-user-agent-version$$$ [user_agent.version](/reference/ecs-user_agent.md#field-user-agent-version) | [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) | [user_agent.version](https://opentelemetry.io/docs/specs/semconv/attributes-registry/user_agent/#user-agent-version) | ![development](https://img.shields.io/badge/✘-fed10c?style=flat) |
| $$$otel-mapping-for-user-agent-name$$$ [user_agent.name](/reference/ecs-user_agent.md#field-user-agent-name) | [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) | [user_agent.name](https://opentelemetry.io/docs/specs/semconv/attributes-registry/user-agent/#user-agent-name) | ![development](https://img.shields.io/badge/✘-fed10c?style=flat) |
| $$$otel-mapping-for-user-agent-original$$$ [user_agent.original](/reference/ecs-user_agent.md#field-user-agent-original) | [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) | [user_agent.original](https://opentelemetry.io/docs/specs/semconv/attributes-registry/user-agent/#user-agent-original) | ![stable](https://img.shields.io/badge/✔-93c93e?style=flat) |
| $$$otel-mapping-for-user-agent-version$$$ [user_agent.version](/reference/ecs-user_agent.md#field-user-agent-version) | [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) | [user_agent.version](https://opentelemetry.io/docs/specs/semconv/attributes-registry/user-agent/#user-agent-version) | ![development](https://img.shields.io/badge/✘-fed10c?style=flat) |
6 changes: 3 additions & 3 deletions docs/reference/ecs-user_agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ They often show up in web service logs coming from the parsed user agent string.
| Field | Description | Level |
| --- | --- | --- |
| $$$field-user-agent-device-name$$$ [user_agent.device.name](#field-user-agent-device-name) | Name of the device.<br><br>type: keyword<br><br>example: `iPhone` | extended |
| $$$field-user-agent-name$$$ [user_agent.name](#field-user-agent-name) | Name of the user agent.<br><br>type: keyword<br><br>example: `Safari`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [user_agent.name](https://opentelemetry.io/docs/specs/semconv/attributes-registry/user_agent/#user-agent-name) | extended |
| $$$field-user-agent-original$$$ [user_agent.original](#field-user-agent-original) | Unparsed user_agent string.<br><br>type: keyword<br><br>Multi-fields:<br><br>* user_agent.original.text (type: match_only_text)<br><br>example: `Mozilla/5.0 (iPhone; CPU iPhone OS 12_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.0 Mobile/15E148 Safari/604.1`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [user_agent.original](https://opentelemetry.io/docs/specs/semconv/attributes-registry/user_agent/#user-agent-original) | extended |
| $$$field-user-agent-version$$$ [user_agent.version](#field-user-agent-version) | Version of the user agent.<br><br>type: keyword<br><br>example: `12.0`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [user_agent.version](https://opentelemetry.io/docs/specs/semconv/attributes-registry/user_agent/#user-agent-version) | extended |
| $$$field-user-agent-name$$$ [user_agent.name](#field-user-agent-name) | Name of the user agent.<br><br>type: keyword<br><br>example: `Safari`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [user_agent.name](https://opentelemetry.io/docs/specs/semconv/attributes-registry/user-agent/#user-agent-name) | extended |
| $$$field-user-agent-original$$$ [user_agent.original](#field-user-agent-original) | Unparsed user_agent string.<br><br>type: keyword<br><br>Multi-fields:<br><br>* user_agent.original.text (type: match_only_text)<br><br>example: `Mozilla/5.0 (iPhone; CPU iPhone OS 12_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.0 Mobile/15E148 Safari/604.1`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [user_agent.original](https://opentelemetry.io/docs/specs/semconv/attributes-registry/user-agent/#user-agent-original) | extended |
| $$$field-user-agent-version$$$ [user_agent.version](#field-user-agent-version) | Version of the user agent.<br><br>type: keyword<br><br>example: `12.0`<br><br>![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry) [![match](https://img.shields.io/badge/match-93c93e?style=flat)](/reference/ecs-opentelemetry.md#ecs-opentelemetry-relation) [user_agent.version](https://opentelemetry.io/docs/specs/semconv/attributes-registry/user-agent/#user-agent-version) | extended |


### Field sets that can be nested under User agent [ecs-user_agent-nestings]
Expand Down
4 changes: 2 additions & 2 deletions scripts/templates/macros.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
{# macro - OTel attribute link #}
{%- macro otel_attribute_link(field, otel) -%}
[{{ otel_attribute(field, otel) }}](https://opentelemetry.io/docs/specs/semconv/attributes-registry/
{{- otel_attribute(field, otel).split(".")[0] -}}
{{- otel_attribute(field, otel).split(".")[0] | replace("_", "-") -}}
/#
{{- otel_attribute_dashed_name(field, otel) -}}
)
Expand Down Expand Up @@ -107,4 +107,4 @@ Not applicable.
{%- endmacro -%}

{# OTel badge #}
{%- set otel_badge = "![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry)" -%}
{%- set otel_badge = "![OTel Badge](https://img.shields.io/badge/OpenTelemetry-4a5ca6?style=flat&logo=opentelemetry)" -%}
Loading