Skip to content

Commit 5f10d08

Browse files
mjwolftrisch-me
andauthored
Fix otel urls in documentation for fieldsets with underscores (#2486)
* Fix otel urls for fieldsets with underscores For fieldsets with underscores, the generated otel field links were not correct, resulting in 404 when trying to follow the link. This generates the correct url for these fields. * Update changelog --------- Co-authored-by: Alexandra Konrad <[email protected]>
1 parent 6b5d16d commit 5f10d08

File tree

4 files changed

+10
-8
lines changed

4 files changed

+10
-8
lines changed

CHANGELOG.next.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ Thanks, you're awesome :-) -->
2727

2828
#### Bugfixes
2929

30+
* Fix otel urls for fieldsets with underscores. #2486
31+
3032
#### Added
3133

3234
#### Improvements

docs/reference/ecs-otel-alignment-details.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,6 @@ The following table gives an overview of mappings between individual ECS fields
213213
| $$$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) |
214214
| $$$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) |
215215
| **User agent Fields** |
216-
| $$$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) |
217-
| $$$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) |
218-
| $$$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) |
216+
| $$$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) |
217+
| $$$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) |
218+
| $$$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) |

docs/reference/ecs-user_agent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ They often show up in web service logs coming from the parsed user agent string.
1818
| Field | Description | Level |
1919
| --- | --- | --- |
2020
| $$$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 |
21-
| $$$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 |
22-
| $$$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 |
23-
| $$$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 |
21+
| $$$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 |
22+
| $$$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 |
23+
| $$$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 |
2424

2525

2626
### Field sets that can be nested under User agent [ecs-user_agent-nestings]

scripts/templates/macros.j2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
{# macro - OTel attribute link #}
2121
{%- macro otel_attribute_link(field, otel) -%}
2222
[{{ otel_attribute(field, otel) }}](https://opentelemetry.io/docs/specs/semconv/attributes-registry/
23-
{{- otel_attribute(field, otel).split(".")[0] -}}
23+
{{- otel_attribute(field, otel).split(".")[0] | replace("_", "-") -}}
2424
/#
2525
{{- otel_attribute_dashed_name(field, otel) -}}
2626
)
@@ -107,4 +107,4 @@ Not applicable.
107107
{%- endmacro -%}
108108

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

0 commit comments

Comments
 (0)