open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

BREAKING: Use seconds as default duration for FaaS duration histograms (#384) 

Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
Co-authored-by: Alexander Wert <AlexanderWert@users.noreply.github.com>
This commit is contained in:
Johannes Tax 2023-10-24 09:42:11 +02:00 committed by GitHub
parent 6a2519baeb
commit 5aa01542b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -26,6 +26,8 @@ release.
([#297](https://github.com/open-telemetry/semantic-conventions/pull/297))
- Fix `server.port` to be not required when `server.address` is not set.
([#429](https://github.com/open-telemetry/semantic-conventions/pull/429))
- Use seconds as default duration for FaaS duration histograms
([#384](https://github.com/open-telemetry/semantic-conventions/pull/384))
### Features

18
docs/faas/faas-metrics.md
View File

@ -45,10 +45,14 @@ The following metrics are recorded by the FaaS instance.
This metric is [recommended][MetricRecommended].
This metric SHOULD be specified with
[`ExplicitBucketBoundaries`](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/metrics/api.md#instrument-advice)
of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 ]`.
<!-- semconv metric.faas.invoke_duration(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `faas.invoke_duration` | Histogram | `ms` | Measures the duration of the function's logic execution |
| `faas.invoke_duration` | Histogram | `s` | Measures the duration of the function's logic execution |
<!-- endsemconv -->
<!-- semconv metric.faas.invoke_duration(full) -->
@ -71,10 +75,14 @@ This metric is [recommended][MetricRecommended].
This metric is [recommended][MetricRecommended].
This metric SHOULD be specified with
[`ExplicitBucketBoundaries`](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/metrics/api.md#instrument-advice)
of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 ]`.
<!-- semconv metric.faas.init_duration(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `faas.init_duration` | Histogram | `ms` | Measures the duration of the function's initialization, such as a cold start |
| `faas.init_duration` | Histogram | `s` | Measures the duration of the function's initialization, such as a cold start |
<!-- endsemconv -->
<!-- semconv metric.faas.init_duration(full) -->
@ -227,10 +235,14 @@ This metric is [recommended][MetricRecommended].
This metric is [recommended][MetricRecommended].
This metric SHOULD be specified with
[`ExplicitBucketBoundaries`](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/metrics/api.md#instrument-advice)
of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 ]`.
<!-- semconv metric.faas.cpu_usage(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `faas.cpu_usage` | Histogram | `ms` | Distribution of CPU usage per invocation |
| `faas.cpu_usage` | Histogram | `s` | Distribution of CPU usage per invocation |
<!-- endsemconv -->
<!-- semconv metric.faas.cpu_usage(full) -->

6
model/metrics/faas-metrics.yaml
View File

@ -4,7 +4,7 @@ groups:
metric_name: faas.invoke_duration
brief: "Measures the duration of the function's logic execution"
instrument: histogram
unit: "ms"
unit: "s"
attributes:
- ref: faas.trigger
@ -13,7 +13,7 @@ groups:
metric_name: faas.init_duration
brief: "Measures the duration of the function's initialization, such as a cold start"
instrument: histogram
unit: "ms"
unit: "s"
attributes:
- ref: faas.trigger
@ -67,7 +67,7 @@ groups:
metric_name: faas.cpu_usage
brief: "Distribution of CPU usage per invocation"
instrument: histogram
unit: "ms"
unit: "s"
attributes:
- ref: faas.trigger