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

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

Merged
merged 8 commits into from
Oct 24, 2023
Merged

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

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ae47bc3
Use seconds as default duration for FaaS metrics
pyohannes Oct 11, 2023
b2bf1a6
Add changelog entry
pyohannes Oct 11, 2023
de429d6
Linting issues
pyohannes Oct 11, 2023
5a86f60
Fix bucket boundaries
pyohannes Oct 11, 2023
7b82963
Merge branch 'main' into faas-instrument-unit-seconds
trask Oct 12, 2023
932dcd0
Merge branch 'main' into faas-instrument-unit-seconds
pyohannes Oct 13, 2023
9b0359f
Merge branch 'main' into faas-instrument-unit-seconds
AlexanderWert Oct 24, 2023
00add17
Merge branch 'main' into faas-instrument-unit-seconds
AlexanderWert Oct 24, 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 @@ -139,6 +139,8 @@ release.
- BREAKING: Rename/replace `(client|server).socket.(address|port)` attributes
with `network.(peer|local).(address|port)`.
([#342](https://github.com/open-telemetry/semantic-conventions/pull/342))
- BREAKING: Use seconds as default duration for FaaS duration histograms
([#384](https://github.com/open-telemetry/semantic-conventions/pull/384))

## v1.21.0 (2023-07-13)

Expand Down
18 changes: 15 additions & 3 deletions docs/faas/faas-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) -->
Expand All @@ -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) -->
Expand Down Expand Up @@ -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) -->
Expand Down
6 changes: 3 additions & 3 deletions model/metrics/faas-metrics.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
joaopgrassi marked this conversation as resolved.
Show resolved Hide resolved
attributes:
- ref: faas.trigger

Expand All @@ -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

Expand Down Expand Up @@ -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

Expand Down
Loading