Skip to content

Commit ef4612d

Browse files
author
ivomagi
authored
Adding webengine definition under resources semantic conventions (#1293)
1 parent cf59c0b commit ef4612d

File tree

3 files changed

+45
-0
lines changed

3 files changed

+45
-0
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
groups:
2+
- id: webengine_resource
3+
prefix: webengine
4+
brief: >
5+
Resource describing the packaged software running the application code. Web engines are typically executed using process.runtime.
6+
attributes:
7+
- id: name
8+
type: string
9+
required: always
10+
brief: >
11+
The name of the web engine.
12+
examples: ['WildFly']
13+
- id: version
14+
type: string
15+
brief: >
16+
The version of the web engine.
17+
examples: ['21.0.0']
18+
- id: description
19+
type: string
20+
brief: >
21+
Additional description of the web engine (e.g. detailed version and edition information).
22+
examples: ['WildFly Full 21.0.0.Final (WildFly Core 13.0.1.Final) - 2.2.2.Final']

specification/resource/semantic_conventions/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ Attributes defining a compute unit (e.g. Container, Process, Function as a Servi
124124
- [Container](./container.md)
125125
- [Function as a Service](./faas.md)
126126
- [Process](./process.md)
127+
- [Web engine](./webengine.md)
127128

128129
## Compute Instance
129130

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Webengine
2+
3+
**type:** `webengine`
4+
5+
**Description:** Resource describing the packaged software running the application code. Web engines are typically executed using process.runtime.
6+
7+
<!-- semconv webengine_resource -->
8+
| Attribute | Type | Description | Examples | Required |
9+
|---|---|---|---|---|
10+
| `webengine.name` | string | The name of the web engine. | `WildFly` | Yes |
11+
| `webengine.version` | string | The version of the web engine. | `21.0.0` | No |
12+
| `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` | No |
13+
<!-- endsemconv -->
14+
15+
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.
16+
17+
A resource can be attributed to at most one web engine.
18+
19+
The situations where there are multiple candidates, it is up to instrumentation library authors to choose the web engine. To illustrate, let's look at a Python application using Apache HTTP Server with mod_wsgi as the server and Django as the web framework. In this situation:
20+
21+
* Either Apache HTTP Server or `mod_wsgi` MAY be chosen as `webengine`, depending on the decision made by the instrumentation authors.
22+
* Django SHOULD NOT be set as an `webengine` as the required information is already available in insrumentation library and setting this into `webengine` would duplicate the information.

0 commit comments

Comments
 (0)