Move webengine attributes to the registry (#901)

Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com>
This commit is contained in:
Joao Grassi 2024-04-09 13:53:24 +02:00 committed by GitHub
parent ccb6db6f3d
commit f731ca7537
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 51 additions and 22 deletions

View File

@ -64,6 +64,7 @@ body:
- area:tls - area:tls
- area:url - area:url
- area:user-agent - area:user-agent
- area:webengine
# End semconv area list # End semconv area list
- type: textarea - type: textarea
attributes: attributes:

View File

@ -57,6 +57,7 @@ body:
- area:tls - area:tls
- area:url - area:url
- area:user-agent - area:user-agent
- area:webengine
# End semconv area list # End semconv area list
- type: textarea - type: textarea
attributes: attributes:

View File

@ -66,6 +66,7 @@ body:
- area:tls - area:tls
- area:url - area:url
- area:user-agent - area:user-agent
- area:webengine
# End semconv area list # End semconv area list
- type: textarea - type: textarea
attributes: attributes:

View File

@ -71,5 +71,6 @@ Currently, the following namespaces exist:
* [TLS](tls.md) * [TLS](tls.md)
* [URL](url.md) * [URL](url.md)
* [User agent](user-agent.md) * [User agent](user-agent.md)
* [Webengine](webengine.md)
[developers recommendations]: ../general/attribute-naming.md#recommendations-for-application-developers [developers recommendations]: ../general/attribute-naming.md#recommendations-for-application-developers

View File

@ -0,0 +1,14 @@
<!--- Hugo front matter used to generate the website version of this page:
--->
# Webengine
## Webengine Attributes
<!-- semconv registry.webengine(omit_requirement_level) -->
| 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) |
<!-- endsemconv -->

View File

@ -9,9 +9,9 @@
<!-- semconv webengine_resource --> <!-- semconv webengine_resource -->
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | | 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.name`](../attributes-registry/webengine.md) | 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.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` | string | The version of the web engine. | `21.0.0` | `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) |
<!-- endsemconv --> <!-- endsemconv -->
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. 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.

View File

@ -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']

View File

@ -1,26 +1,12 @@
groups: groups:
- id: webengine_resource - id: webengine_resource
prefix: webengine
type: resource type: resource
brief: > brief: >
Resource describing the packaged software running the application code. Web engines are typically executed using process.runtime. Resource describing the packaged software running the application code. Web engines are typically executed using process.runtime.
attributes: attributes:
- id: name - ref: webengine.name
type: string
stability: experimental
requirement_level: required requirement_level: required
brief: > - ref: webengine.version
The name of the web engine. requirement_level: recommended
examples: ['WildFly'] - ref: webengine.description
- id: version requirement_level: recommended
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']