Skip to content

Commit

Permalink
Define FaaS Metric Semantics
Browse files Browse the repository at this point in the history
  • Loading branch information
kolanos committed Oct 14, 2020
1 parent c115d08 commit 960c883
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions specification/metrics/semantic_conventions/faas-metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# General

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 insight into the
operations. By adding FaaS labels to metric events it allows for finely tuned filtering.

**Disclaimer:** These are initial FaaS metric instruments and labels but more may be added in the future.

## 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` | ValueRecorder | milliseconds | Measures the duration of the invocation |
| `faas.init_duration` | ValueRecorder | milliseconds | Measures the duration of the function's initialization, such as a cold start |
| `faas.coldstarts` | Counter | number of cold starts | Number of invocation cold starts. |
| `faas.errors` | Counter | number of errors | Number of invocation errors. |
| `faas.executions` | counter | number of invocations | number of successful invocations. |
| `faas.timeouts` | counter | number of timeouts | number of invocation timeouts. |

## Labels

Below is a table of the labels that SHOULD 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` |

## References

### Metric Reference

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)
* [Azure Functions Metrics](https://docs.microsoft.com/en-us/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/)

0 comments on commit 960c883

Please sign in to comment.