Skip to content

Commit

Permalink
Mark initial set of HTTP semantic conventions as frozen
Browse files Browse the repository at this point in the history
  • Loading branch information
trask committed Jun 13, 2023
1 parent 8fc3d03 commit 394d746
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 2 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,5 @@ release.
([#69](https://github.com/open-telemetry/semantic-conventions/pull/69))
- Clarify when HTTP client spans should end.
([#70](https://github.com/open-telemetry/semantic-conventions/pull/70))
- Mark initial set of HTTP semantic conventions as frozen
([#999](https://github.com/open-telemetry/semantic-conventions/pull/999))
16 changes: 15 additions & 1 deletion specification/metrics/semantic_conventions/http-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linkTitle: HTTP

# Semantic Conventions for HTTP Metrics

**Status**: [Experimental][DocumentStatus]
**Status**: [Experimental, partial feature-freeze][DocumentStatus]

The conventions described in this section are HTTP specific. When HTTP operations occur,
metric events about those operations will be generated and reported to provide insight into the
Expand Down Expand Up @@ -54,6 +54,8 @@ operations. By adding HTTP attributes to metric events it allows for finely tune

### Metric: `http.server.duration`

**Status**: [Experimental, Feature-freeze][DocumentStatus]

This metric is required.

When this metric is reported alongside an HTTP server span, the metric value SHOULD be the same as the HTTP server span duration.
Expand Down Expand Up @@ -107,6 +109,8 @@ SHOULD NOT be set if only IP address is available and capturing name would requi

### Metric: `http.server.active_requests`

**Status**: [Experimental][DocumentStatus]

This metric is optional.

<!-- semconv metric.http.server.active_requests(metric_table) -->
Expand Down Expand Up @@ -145,6 +149,8 @@ SHOULD NOT be set if only IP address is available and capturing name would requi

### Metric: `http.server.request.size`

**Status**: [Experimental][DocumentStatus]

This metric is optional.

<!-- semconv metric.http.server.request.size(metric_table) -->
Expand Down Expand Up @@ -192,6 +198,8 @@ SHOULD NOT be set if only IP address is available and capturing name would requi

### Metric: `http.server.response.size`

**Status**: [Experimental][DocumentStatus]

This metric is optional.

<!-- semconv metric.http.server.response.size(metric_table) -->
Expand Down Expand Up @@ -241,6 +249,8 @@ SHOULD NOT be set if only IP address is available and capturing name would requi

### Metric: `http.client.duration`

**Status**: [Experimental, Feature-freeze][DocumentStatus]

This metric is required.

When this metric is reported alongside an HTTP client span, the metric value SHOULD be the same as the HTTP client span duration.
Expand Down Expand Up @@ -283,6 +293,8 @@ SHOULD NOT be set if capturing it would require an extra DNS lookup.

### Metric: `http.client.request.size`

**Status**: [Experimental][DocumentStatus]

This metric is optional.

<!-- semconv metric.http.client.request.size(metric_table) -->
Expand Down Expand Up @@ -319,6 +331,8 @@ SHOULD NOT be set if capturing it would require an extra DNS lookup.

### Metric: `http.client.response.size`

**Status**: [Experimental][DocumentStatus]

This metric is optional.

<!-- semconv metric.http.client.response.size(metric_table) -->
Expand Down
2 changes: 1 addition & 1 deletion specification/trace/semantic_conventions/http.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Semantic conventions for HTTP spans

**Status**: [Experimental][DocumentStatus]
**Status**: [Experimental, Feature-freeze][DocumentStatus]

This document defines semantic conventions for HTTP client and server Spans.
They can be used for http and https schemes
Expand Down

0 comments on commit 394d746

Please sign in to comment.