Skip to content

Commit

Permalink
Move webengine attributes to the registry (#901)
Browse files Browse the repository at this point in the history
Co-authored-by: Armin Ruech <[email protected]>
  • Loading branch information
joaopgrassi and arminru authored Apr 9, 2024
1 parent ccb6db6 commit f731ca7
Show file tree
Hide file tree
Showing 8 changed files with 51 additions and 22 deletions.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ body:
- area:tls
- area:url
- area:user-agent
- area:webengine
# End semconv area list
- type: textarea
attributes:
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/change_proposal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ body:
- area:tls
- area:url
- area:user-agent
- area:webengine
# End semconv area list
- type: textarea
attributes:
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/new-conventions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ body:
- area:tls
- area:url
- area:user-agent
- area:webengine
# End semconv area list
- type: textarea
attributes:
Expand Down
1 change: 1 addition & 0 deletions docs/attributes-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
14 changes: 14 additions & 0 deletions docs/attributes-registry/webengine.md
Original file line number Diff line number Diff line change
@@ -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 -->
6 changes: 3 additions & 3 deletions docs/resource/webengine.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
<!-- semconv webengine_resource -->
| 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) |
<!-- 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.
Expand Down
25 changes: 25 additions & 0 deletions model/registry/webengine.yaml
Original file line number Diff line number Diff line change
@@ -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']
24 changes: 5 additions & 19 deletions model/resource/webengine.yaml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit f731ca7

Please sign in to comment.