Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mark initial set of HTTP semantic conventions as frozen #105

Merged
merged 4 commits into from
Jun 23, 2023
+18 −2
Merged

Mark initial set of HTTP semantic conventions as frozen #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6c0bb1a
Mark initial set of HTTP semantic conventions as frozen
trask Jun 13, 2023
aaa371d
Merge branch 'main' into http-frozen
trask Jun 14, 2023
3f86385
Merge branch 'main' into http-frozen
reyang Jun 22, 2023
62bcb6a
Merge branch 'main' into http-frozen
reyang Jun 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,5 @@ release.
([#17](https://github.com/open-telemetry/opentelemetry-specification/pull/17))
- Mark service.version as stable.
([#106](https://github.com/open-telemetry/semantic-conventions/pull/106))
- Mark initial set of HTTP semantic conventions as frozen
([#105](https://github.com/open-telemetry/semantic-conventions/pull/105))
16 changes: 15 additions & 1 deletion specification/metrics/semantic_conventions/http-metrics.md
View file
Open in desktop
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]
reyang marked this conversation as resolved.
Show resolved Hide resolved

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 @@ -55,6 +55,8 @@ operations. By adding HTTP attributes to metric events it allows for finely tune

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

**Status**: [Experimental, Feature-freeze][DocumentStatus]
joaopgrassi marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@trask what does it mean for a metric to have both experimental and Feature freeze simultaneously?

Copy link
Member

@reyang reyang Aug 8, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feature-freeze is orthogonal to Experimental/Stable https://github.com/open-telemetry/opentelemetry-specification/blob/ad1537a46eb856eeb915786fd7cf81e07bdeb426/specification/document-status.md?plain=1#L19.

(personally I find it counter intuitive - since only "Experimental", "Experimental + Feature-freeze" and "Stable" would make sense)


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 @@ -137,6 +139,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 @@ -204,6 +208,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 @@ -280,6 +286,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 @@ -358,6 +366,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 @@ -431,6 +441,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 @@ -498,6 +510,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
View file
Open in desktop
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