Skip to content

Commit

Permalink
add general http metrics
Browse files Browse the repository at this point in the history
  • Loading branch information
Shane Schisler committed Mar 6, 2024
1 parent ca80850 commit 1c3c86e
Show file tree
Hide file tree
Showing 5 changed files with 606 additions and 18 deletions.
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Semantic Conventions by signals:
- [Trace](general/trace.md): Semantic Conventions for traces and spans.
- [Metrics](general/metrics.md): Semantic Conventions for metrics.

Semantic Conventions by technology:
Semantic Conventions are defined for the following areas:

- [General](general/README.md): General Semantic Conventions.
- [Actions](actions/README.md): Semantic Conventions for Contrast Actions.
25 changes: 9 additions & 16 deletions docs/actions/action-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,22 +143,15 @@ SHOULD include the [application root](/docs/http/http-spans.md#http-server-defin

**[5]:** `network.protocol.version` refers to the version of the protocol used and might be different from the protocol client's version. If the HTTP client used has a version of `0.27.2`, but sends HTTP version `1.1`, this attribute should be set to `1.1`.

**[6]:** Determined by using the first of the following that applies

- The [primary server name](/docs/http/http-spans.md#http-server-definitions) of the matched virtual host. MUST only
include host identifier.
- Host identifier of the [request target](https://www.rfc-editor.org/rfc/rfc9110.html#target.resource)
if it's sent in absolute-form.
- Host identifier of the `Host` header

SHOULD NOT be set if only IP address is available and capturing name would require a reverse DNS lookup.

**[7]:** Determined by using the first of the following that applies

- Port identifier of the [primary server host](/docs/http/http-spans.md#http-server-definitions) of the matched virtual host.
- Port identifier of the [request target](https://www.rfc-editor.org/rfc/rfc9110.html#target.resource)
if it's sent in absolute-form.
- Port identifier of the `Host` header
**[6]:** See [Setting `server.address` and `server.port` attributes](/docs/http/http-spans.md#setting-serveraddress-and-serverport-attributes).
> **Warning**
> Since this attribute is based on HTTP headers, opting in to it may allow an attacker
> to trigger cardinality limits, degrading the usefulness of the metric.
**[7]:** See [Setting `server.address` and `server.port` attributes](/docs/http/http-spans.md#setting-serveraddress-and-serverport-attributes).
> **Warning**
> Since this attribute is based on HTTP headers, opting in to it may allow an attacker
> to trigger cardinality limits, degrading the usefulness of the metric.
`error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.

Expand Down
4 changes: 3 additions & 1 deletion docs/general/trace.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ as resonable guided by the OTEL specification.

The following semantic conventions for Contrast Spans are defined:

* [Actions](../actions/action-spans.md): For spans describing Contrast Actions.
- [General](attributes.md): General semantic attributes that may be used in describing different kinds of operations.
- [Actions](../actions/action-spans.md): For spans describing Contrast Actions.
- [HTTP](../http/http-spans.md): For HTTP client and server spans.
Loading

0 comments on commit 1c3c86e

Please sign in to comment.