Skip to content

Commit

Permalink
Merge branch 'main' into reyang/async-counter
Browse files Browse the repository at this point in the history
  • Loading branch information
reyang authored Apr 1, 2021
2 parents 1264dcb + ef4612d commit 1fa59f9
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 28 deletions.
22 changes: 22 additions & 0 deletions semantic_conventions/resource/webengine.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
groups:
- id: webengine_resource
prefix: webengine
brief: >
Resource describing the packaged software running the application code. Web engines are typically executed using process.runtime.
attributes:
- id: name
type: string
required: always
brief: >
The name of the web engine.
examples: ['WildFly']
- id: version
type: string
brief: >
The version of the web engine.
examples: ['21.0.0']
- id: description
type: string
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']
44 changes: 22 additions & 22 deletions spec-compliance-matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ formats is required. Implementing more than one format is optional.
| `null` values documented as invalid/undefined | | + | + | + | + | + | N/A | | | + | | N/A |
| Unicode support for keys and string values | | + | + | + | + | + | + | + | + | + | + | + |
| [Span linking](specification/trace/api.md#specifying-links) | | | | | | | | | | | | |
| Links can be recorded on span creation | | + | | | | | | | | | | |
| Links order is preserved | | + | | | | | | | | | | |
| Links can be recorded on span creation | | + | | | | + | | | | | | |
| Links order is preserved | | + | | | | + | | | | | | |
| [Span events](specification/trace/api.md#add-events) | | | | | | | | | | + | | |
| AddEvent | | + | + | + | + | + | + | + | + | + | + | + |
| Add order preserved | | + | + | + | + | + | + | + | + | + | + | + |
Expand All @@ -77,7 +77,7 @@ formats is required. Implementing more than one format is optional.
| [New Span ID created also for non-recording Spans](specification/trace/sdk.md#sdk-span-creation) | | + | + | | + | + | + | | | | - | + |
| [IdGenerators](specification/trace/sdk.md#id-generators) | | + | + | | | + | | | | | | + |
| [SpanLimits](specification/trace/sdk.md#span-limits) | X | + | + | | | + | | | | | | + |
| [Built-in `SpanProcessor`s implement `ForceFlush` spec](specification/trace/sdk.md#forceflush-1) | | | | | | | | | | | | |
| [Built-in `SpanProcessor`s implement `ForceFlush` spec](specification/trace/sdk.md#forceflush-1) | | | | | | + | | | | | | |

## Baggage

Expand Down Expand Up @@ -116,9 +116,9 @@ formats is required. Implementing more than one format is optional.
| Global Propagator | | + | + | + | + | + | + | | + | | + | + |
| TraceContext Propagator | | + | + | + | + | + | + | | + | + | + | + |
| B3 Propagator | | + | + | + | + | + | + | | + | + | + | + |
| Jaeger Propagator | | + | + | + | + | | + | | + | + | - | - |
| Jaeger Propagator | | + | + | + | + | + | + | | + | + | - | - |
| [TextMapPropagator](specification/context/api-propagators.md#textmap-propagator) | | + | | | | | | | | | | |
| Fields | | + | + | + | + | | + | | + | | + | + |
| Fields | | + | + | + | + | + | + | | + | | + | + |
| Setter argument | X | N/A| + | + | + | + | + | | | + | + | + |
| Getter argument | X | N/A| + | + | + | + | + | | | + | + | + |
| Getter argument returning Keys | X | N/A| + | + | + | + | + | | | + | - | + |
Expand All @@ -135,9 +135,9 @@ Note: Support for environment variables is optional.
|OTEL_BSP_* | - | + | | + | + | + | - | + | - | - | - |
|OTEL_EXPORTER_OTLP_* | [-](https://github.com/open-telemetry/opentelemetry-go/issues/1085) | + | | - | + | - | - | | - | - | - |
|OTEL_EXPORTER_JAEGER_* | - | + | | + | + | - | - | + | - | - | - |
|OTEL_EXPORTER_ZIPKIN_* | - | + | | + | | - | - | | - | - | - |
|OTEL_EXPORTER_ZIPKIN_* | - | + | | + | + | - | - | | - | - | - |
|OTEL_TRACES_EXPORTER | - | + | | + | + | + | | | | | |
|OTEL_METRICS_EXPORTER | - | + | | + | | - | | | | - | - |
|OTEL_METRICS_EXPORTER | - | + | | + | - | - | | | | - | - |
|OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT | - | + | | + | + | - | | | | | |
|OTEL_SPAN_EVENT_COUNT_LIMIT | - | + | | + | + | - | | | | | |
|OTEL_SPAN_LINK_COUNT_LIMIT | - | + | | + | + | - | | | | | |
Expand All @@ -149,7 +149,7 @@ Note: Support for environment variables is optional.
| Feature | Optional | Go | Java | JS | Python | Ruby | Erlang | PHP | Rust | C++ | .Net | Swift |
|-------------------------------------------------------|----------|----|-----------------------------------------------------------------------|----|-------------------------------------------------------------------------|------|--------|-----|------|-----|------|-------|
| [Exporter interface](specification/trace/sdk.md#span-exporter) | | | + | | + | | | | | | + | |
| [Exporter interface has `ForceFlush`](specification/trace/sdk.md#forceflush-2) | | | + | | | | | | | | | |
| [Exporter interface has `ForceFlush`](specification/trace/sdk.md#forceflush-2) | | | + | | | + | | | | | | |
| Standard output (logging) | | + | + | + | + | + | + | - | + | + | + | + |
| In-memory (mock exporter) | | + | + | + | + | + | + | - | - | + | + | + |
| [OTLP](specification/protocol/otlp.md) | | | | | | | | | | | | |
Expand All @@ -163,22 +163,22 @@ Note: Support for environment variables is optional.
| Honors throttling response | X | [-](https://github.com/open-telemetry/opentelemetry-go/issues/1632) | | - | + | + | - | | | | - | - |
| Multi-destination spec compliance | X | + | | | [-](https://github.com/open-telemetry/opentelemetry-python/issues/1109) | | - | | | | - | - |
| [Zipkin](specification/trace/sdk_exporters/zipkin.md) | | | | | | | | | | | | |
| Zipkin V1 JSON | X | | + | | [-](https://github.com/open-telemetry/opentelemetry-python/issues/1173) | | - | - | - | | - | - |
| Zipkin V1 Thrift | X | | + | | [-](https://github.com/open-telemetry/opentelemetry-python/issues/1174) | | - | - | - | | - | - |
| Zipkin V2 JSON | * | + | + | | + | | - | + | + | + | + | + |
| Zipkin V2 Protobuf | * | | + | | + | | + | | - | | - | - |
| Service name mapping | | + | + | + | + | | + | + | + | | + | + |
| SpanKind mapping | | + | + | + | + | | + | + | + | | + | + |
| InstrumentationLibrary mapping | | | + | - | + | | - | - | + | | + | + |
| Boolean attributes | | + | + | + | + | | + | + | + | | + | + |
| Array attributes | | + | + | + | [-](https://github.com/open-telemetry/opentelemetry-python/issues/1110) | | + | + | + | | + | + |
| Status mapping | | + | + | + | + | | + | + | + | | + | + |
| Error Status mapping | | | + | | | | | | | | + | - |
| Event attributes mapping to Annotations | | + | + | + | + | | + | + | + | | + | + |
| Integer microseconds in timestamps | | | + | | + | | | | | | + | + |
| Zipkin V1 JSON | X | | + | | [-](https://github.com/open-telemetry/opentelemetry-python/issues/1173) | - | - | - | - | | - | - |
| Zipkin V1 Thrift | X | | + | | [-](https://github.com/open-telemetry/opentelemetry-python/issues/1174) | - | - | - | - | | - | - |
| Zipkin V2 JSON | * | + | + | | + | + | - | + | + | + | + | + |
| Zipkin V2 Protobuf | * | | + | | + | - | + | | - | | - | - |
| Service name mapping | | + | + | + | + | + | + | + | + | | + | + |
| SpanKind mapping | | + | + | + | + | + | + | + | + | | + | + |
| InstrumentationLibrary mapping | | | + | - | + | + | - | - | + | | + | + |
| Boolean attributes | | + | + | + | + | + | + | + | + | | + | + |
| Array attributes | | + | + | + | [-](https://github.com/open-telemetry/opentelemetry-python/issues/1110) | + | + | + | + | | + | + |
| Status mapping | | + | + | + | + | + | + | + | + | | + | + |
| Error Status mapping | | | + | | | + | | | | | + | - |
| Event attributes mapping to Annotations | | + | + | + | + | + | + | + | + | | + | + |
| Integer microseconds in timestamps | | | + | | + | + | | | | | + | + |
| [Jaeger](specification/trace/sdk_exporters/jaeger.md) | | | | | | | | | | | | |
| Jaeger Thrift over UDP | * | | | | + | + | | | | | + | + |
| Jaeger Protobuf via gRPC | * | | + | | [-](https://github.com/open-telemetry/opentelemetry-python/issues/1437) | | | | | | - | - |
| Jaeger Protobuf via gRPC | * | | + | | [-](https://github.com/open-telemetry/opentelemetry-python/issues/1437) | - | | | | | - | - |
| Jaeger Thrift over HTTP | * | | + | | + | + | | | | | - | - |
| Service name mapping | | | + | | + | + | | | | | + | + |
| Resource to Process mapping | | | + | | [-](https://github.com/open-telemetry/opentelemetry-python/issues/1436) | + | | | | | + | - |
Expand Down
1 change: 1 addition & 0 deletions specification/resource/semantic_conventions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ Attributes defining a compute unit (e.g. Container, Process, Function as a Servi
- [Container](./container.md)
- [Function as a Service](./faas.md)
- [Process](./process.md)
- [Web engine](./webengine.md)

## Compute Instance

Expand Down
22 changes: 22 additions & 0 deletions specification/resource/semantic_conventions/webengine.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Webengine

**type:** `webengine`

**Description:** Resource describing the packaged software running the application code. Web engines are typically executed using process.runtime.

<!-- semconv webengine_resource -->
| Attribute | Type | Description | Examples | Required |
|---|---|---|---|---|
| `webengine.name` | string | The name of the web engine. | `WildFly` | Yes |
| `webengine.version` | string | The version of the web engine. | `21.0.0` | No |
| `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 |
<!-- 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.

A resource can be attributed to at most one web engine.

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:

* Either Apache HTTP Server or `mod_wsgi` MAY be chosen as `webengine`, depending on the decision made by the instrumentation authors.
* 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.
Loading

0 comments on commit 1fa59f9

Please sign in to comment.