From f731ca75375c0ad5f65c0121fcce649e59a342e7 Mon Sep 17 00:00:00 2001 From: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com> Date: Tue, 9 Apr 2024 13:53:24 +0200 Subject: [PATCH] Move webengine attributes to the registry (#901) Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.yaml | 1 + .github/ISSUE_TEMPLATE/change_proposal.yaml | 1 + .github/ISSUE_TEMPLATE/new-conventions.yaml | 1 + docs/attributes-registry/README.md | 1 + docs/attributes-registry/webengine.md | 14 ++++++++++++ docs/resource/webengine.md | 6 ++--- model/registry/webengine.yaml | 25 +++++++++++++++++++++ model/resource/webengine.yaml | 24 +++++--------------- 8 files changed, 51 insertions(+), 22 deletions(-) create mode 100644 docs/attributes-registry/webengine.md create mode 100644 model/registry/webengine.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 138ec6c59..850464b1c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -64,6 +64,7 @@ body: - area:tls - area:url - area:user-agent + - area:webengine # End semconv area list - type: textarea attributes: diff --git a/.github/ISSUE_TEMPLATE/change_proposal.yaml b/.github/ISSUE_TEMPLATE/change_proposal.yaml index 117491cb4..69dec212c 100644 --- a/.github/ISSUE_TEMPLATE/change_proposal.yaml +++ b/.github/ISSUE_TEMPLATE/change_proposal.yaml @@ -57,6 +57,7 @@ body: - area:tls - area:url - area:user-agent + - area:webengine # End semconv area list - type: textarea attributes: diff --git a/.github/ISSUE_TEMPLATE/new-conventions.yaml b/.github/ISSUE_TEMPLATE/new-conventions.yaml index f663263c5..aa3679844 100644 --- a/.github/ISSUE_TEMPLATE/new-conventions.yaml +++ b/.github/ISSUE_TEMPLATE/new-conventions.yaml @@ -66,6 +66,7 @@ body: - area:tls - area:url - area:user-agent + - area:webengine # End semconv area list - type: textarea attributes: diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md index c9f832ec7..766e390a9 100644 --- a/docs/attributes-registry/README.md +++ b/docs/attributes-registry/README.md @@ -71,5 +71,6 @@ Currently, the following namespaces exist: * [TLS](tls.md) * [URL](url.md) * [User agent](user-agent.md) +* [Webengine](webengine.md) [developers recommendations]: ../general/attribute-naming.md#recommendations-for-application-developers diff --git a/docs/attributes-registry/webengine.md b/docs/attributes-registry/webengine.md new file mode 100644 index 000000000..784d7adc9 --- /dev/null +++ b/docs/attributes-registry/webengine.md @@ -0,0 +1,14 @@ + + +# Webengine + +## Webengine Attributes + + +| Attribute | Type | Description | Examples | Stability | +|---|---|---|---|---| +| `webengine.description` | string | Additional description of the web engine (e.g. detailed version and edition information). | `WildFly Full 21.0.0.Final (WildFly Core 13.0.1.Final) - 2.2.2.Final` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `webengine.name` | string | The name of the web engine. | `WildFly` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `webengine.version` | string | The version of the web engine. | `21.0.0` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + diff --git a/docs/resource/webengine.md b/docs/resource/webengine.md index 0f136433e..4ff192e9b 100644 --- a/docs/resource/webengine.md +++ b/docs/resource/webengine.md @@ -9,9 +9,9 @@ | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | |---|---|---|---|---|---| -| `webengine.name` | string | The name of the web engine. | `WildFly` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `webengine.description` | string | Additional description of the web engine (e.g. detailed version and edition information). | `WildFly Full 21.0.0.Final (WildFly Core 13.0.1.Final) - 2.2.2.Final` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `webengine.version` | string | The version of the web engine. | `21.0.0` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| [`webengine.name`](../attributes-registry/webengine.md) | string | The name of the web engine. | `WildFly` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| [`webengine.description`](../attributes-registry/webengine.md) | string | Additional description of the web engine (e.g. detailed version and edition information). | `WildFly Full 21.0.0.Final (WildFly Core 13.0.1.Final) - 2.2.2.Final` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| [`webengine.version`](../attributes-registry/webengine.md) | string | The version of the web engine. | `21.0.0` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | Information describing the web engine SHOULD be captured using the values acquired from the API provided by the web engine, preferably during runtime, to avoid maintenance burden on engine version upgrades. As an example - Java engines are often but not always packaged as application servers. For Java application servers supporting Servlet API the required information MAY be captured by invoking `ServletContext.getServerInfo()` during runtime and parsing the result. diff --git a/model/registry/webengine.yaml b/model/registry/webengine.yaml new file mode 100644 index 000000000..a1579b7d2 --- /dev/null +++ b/model/registry/webengine.yaml @@ -0,0 +1,25 @@ +groups: + - id: registry.webengine + prefix: webengine + type: attribute_group + brief: > + This document defines the attributes used to describe the packaged software running the application code. + attributes: + - id: name + type: string + stability: experimental + brief: > + The name of the web engine. + examples: ['WildFly'] + - id: version + type: string + stability: experimental + brief: > + The version of the web engine. + examples: ['21.0.0'] + - id: description + type: string + stability: experimental + brief: > + Additional description of the web engine (e.g. detailed version and edition information). + examples: ['WildFly Full 21.0.0.Final (WildFly Core 13.0.1.Final) - 2.2.2.Final'] diff --git a/model/resource/webengine.yaml b/model/resource/webengine.yaml index 10485dcc1..9e8a586b0 100644 --- a/model/resource/webengine.yaml +++ b/model/resource/webengine.yaml @@ -1,26 +1,12 @@ groups: - id: webengine_resource - prefix: webengine type: resource brief: > Resource describing the packaged software running the application code. Web engines are typically executed using process.runtime. attributes: - - id: name - type: string - stability: experimental + - ref: webengine.name requirement_level: required - brief: > - The name of the web engine. - examples: ['WildFly'] - - id: version - type: string - stability: experimental - brief: > - The version of the web engine. - examples: ['21.0.0'] - - id: description - type: string - stability: experimental - brief: > - Additional description of the web engine (e.g. detailed version and edition information). - examples: ['WildFly Full 21.0.0.Final (WildFly Core 13.0.1.Final) - 2.2.2.Final'] + - ref: webengine.version + requirement_level: recommended + - ref: webengine.description + requirement_level: recommended