forked from open-telemetry/opentelemetry-specification
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add FaaS metrics semantic conventions (open-telemetry#1736)
* Define FaaS Metric Semantics Closes open-telemetry#1013 * adjust faas metrics * fixes * docs * updates * fixes * update instruments * use attributes Co-authored-by: Michael Lavers <[email protected]> Co-authored-by: Carlos Alberto Cortez <[email protected]>
- Loading branch information
1 parent
3c720c1
commit c31c58e
Showing
3 changed files
with
79 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
77 changes: 77 additions & 0 deletions
77
specification/metrics/semantic_conventions/faas-metrics.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
# General | ||
|
||
**Status**: [Experimental](../../document-status.md) | ||
|
||
This document defines how to describe an instance of a function that runs without provisioning | ||
or managing of servers (also known as serverless functions or Function as a Service (FaaS)) with metrics. | ||
|
||
The conventions described in this section are FaaS (function as a service) specific. When FaaS operations occur, | ||
metric events about those operations will be generated and reported to provide insights into the | ||
operations. By adding FaaS attributes to metric events it allows for finely tuned filtering. | ||
|
||
**Disclaimer:** These are initial FaaS metric instruments and attributes but more may be added in the future. | ||
|
||
<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` --> | ||
|
||
<!-- toc --> | ||
- [Metric Instruments](#metric-instruments) | ||
* [FaaS Invocations](#faas-invocations) | ||
- [Attributes](#attributes) | ||
- [References](#references) | ||
* [Metric References](#metric-references) | ||
<!-- tocstop --> | ||
|
||
## Metric Instruments | ||
|
||
The following metric instruments MUST be used to describe FaaS operations. They MUST be of the specified | ||
type and units. | ||
|
||
### FaaS Invocations | ||
|
||
Below is a table of FaaS invocation metric instruments. | ||
|
||
| Name | Instrument | Units | Description | | ||
|------|------------|----|-------------| | ||
| `faas.invoke_duration` | Histogram | milliseconds | Measures the duration of the invocation | | ||
| `faas.init_duration` | Histogram | milliseconds | Measures the duration of the function's initialization, such as a cold start | | ||
| `faas.coldstarts` | Counter | default unit | Number of invocation cold starts. | | ||
| `faas.errors` | Counter | default unit | Number of invocation errors. | | ||
| `faas.executions` | Counter | default unit | Number of successful invocations. | | ||
| `faas.timeouts` | Counter | default unit | Number of invocation timeouts. | | ||
|
||
Optionally, when applicable: | ||
|
||
| Name | Instrument | Units | Description | | ||
|------|------------|----|-------------| | ||
| `faas.mem_usage` | Histogram | bytes | Distribution of max memory usage per invocation | | ||
| `faas.cpu_usage` | Histogram | milliseconds | Distribution of cpu usage per invocation | | ||
| `faas.net_io` | Histogram | bytes | Distribution of net I/O usage per invocation | | ||
|
||
## Attributes | ||
|
||
Below is a table of the attributes to be included on FaaS metric events. | ||
|
||
| Name | Recommended | Notes and examples | | ||
|------|-------------|--------------------| | ||
| `faas.trigger` | Yes | Type of the trigger on which the function is invoked. SHOULD be one of: `datasource`, `http`, `pubsub`, `timer`, `other` | | ||
| `faas.invoked_name` | Yes | Name of the invoked function. Example: `my-function` | | ||
| `faas.invoked_provider` | Yes | Cloud provider of the invoked function. Corresponds to the resource `cloud.provider`. Example: `aws` | | ||
| `faas.invoked_region` | Yes | Cloud provider region of invoked function. Corresponds to resource `cloud.region`. Example: `us-east-1` | | ||
|
||
More details on these attributes, the function name and the difference compared to the faas.invoked_name can be found at the related [FaaS tracing specification](../../trace/semantic_conventions/faas.md). | ||
For incoming FaaS executions, the function for which metrics are reported is already described by its [FaaS resource attributes](../../resource/semantic_conventions/faas.md). | ||
Outgoing FaaS executions are identified using the `faas.invoked_*` attributes above. | ||
`faas.trigger` SHOULD be included in all metric events while `faas.invoked_*` attributes apply on outgoing FaaS execution events only. | ||
|
||
## References | ||
|
||
### Metric References | ||
|
||
Below are links to documentation regarding metrics that are available with different | ||
FaaS providers. This list is not exhaustive. | ||
|
||
* [AWS Lambda Metrics](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-metrics.html) | ||
* [AWS Lambda Insight Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-metrics.html) | ||
* [Azure Functions Metrics](https://docs.microsoft.com/azure/azure-monitor/platform/metrics-supported) | ||
* [Google CloudFunctions Metrics](https://cloud.google.com/monitoring/api/metrics_gcp#gcp-cloudfunctions) | ||
* [OpenFaas Metrics](https://docs.openfaas.com/architecture/metrics/) |