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

move faas to registry (#525) 

Co-authored-by: Joao Grassi <joao.grassi@dynatrace.com>
Co-authored-by: Josh Suereth <joshuasuereth@google.com>
This commit is contained in:
Alexandra Konrad 2024-03-07 18:04:52 +01:00 committed by GitHub
parent 88d66b53e1
commit 3d409a7d4a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 343 additions and 214 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/attributes-registry/README.md
View File

@ -39,6 +39,7 @@ Currently, the following namespaces exist:
* [Disk](disk.md) * [Disk](disk.md)
* [Error](error.md) * [Error](error.md)
* [Exception](exception.md) * [Exception](exception.md)
* [FaaS](faas.md)
* [Host](host.md) * [Host](host.md)
* [HTTP](http.md) * [HTTP](http.md)
* [K8s](k8s.md) * [K8s](k8s.md)

93
docs/attributes-registry/faas.md Normal file
View File

@ -0,0 +1,93 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: FaaS
--->
# FaaS
## FaaS Attributes
<!-- semconv registry.faas(omit_requirement_level) -->
| Attribute | Type | Description | Examples |
|---|---|---|---|
| `faas.coldstart` | boolean | A boolean that is true if the serverless function is executed for the first time (aka cold-start). | |
| `faas.cron` | string | A string containing the schedule period as [Cron Expression](https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm). | `0/5 * * * ? *` |
| `faas.document.collection` | string | The name of the source on which the triggering operation was performed. For example, in Cloud Storage or S3 corresponds to the bucket name, and in Cosmos DB to the database name. | `myBucketName`; `myDbName` |
| `faas.document.name` | string | The document name/table subjected to the operation. For example, in Cloud Storage or S3 is the name of the file, and in Cosmos DB the table name. | `myFile.txt`; `myTableName` |
| `faas.document.operation` | string | Describes the type of the operation that was performed on the data. | `insert` |
| `faas.document.time` | string | A string containing the time when the data was accessed in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime). | `2020-01-23T13:47:06Z` |
| `faas.instance` | string | The execution environment ID as a string, that will be potentially reused for other invocations to the same function/function version. [1] | `2021/06/28/[$LATEST]2f399eb14537447da05ab2a2e39309de` |
| `faas.invocation_id` | string | The invocation ID of the current function invocation. | `af9d5aa4-a685-4c5f-a22b-444f80b3cc28` |
| `faas.invoked_name` | string | The name of the invoked function. [2] | `my-function` |
| `faas.invoked_provider` | string | The cloud provider of the invoked function. [3] | `alibaba_cloud` |
| `faas.invoked_region` | string | The cloud region of the invoked function. [4] | `eu-central-1` |
| `faas.max_memory` | int | The amount of memory available to the serverless function converted to Bytes. [5] | `134217728` |
| `faas.name` | string | The name of the single function that this runtime instance executes. [6] | `my-function`; `myazurefunctionapp/some-function-name` |
| `faas.time` | string | A string containing the function invocation time in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime). | `2020-01-23T13:47:06Z` |
| `faas.trigger` | string | Type of the trigger which caused this function invocation. | `datasource` |
| `faas.version` | string | The immutable version of the function being executed. [7] | `26`; `pinkfroid-00002` |
**[1]:** * **AWS Lambda:** Use the (full) log stream name.
**[2]:** SHOULD be equal to the `faas.name` resource attribute of the invoked function.
**[3]:** SHOULD be equal to the `cloud.provider` resource attribute of the invoked function.
**[4]:** SHOULD be equal to the `cloud.region` resource attribute of the invoked function.
**[5]:** It's recommended to set this attribute since e.g. too little memory can easily stop a Java AWS Lambda function from working correctly. On AWS Lambda, the environment variable `AWS_LAMBDA_FUNCTION_MEMORY_SIZE` provides this information (which must be multiplied by 1,048,576).
**[6]:** This is the name of the function as configured/deployed on the FaaS
platform and is usually different from the name of the callback
function (which may be stored in the
[`code.namespace`/`code.function`](/docs/general/attributes.md#source-code-attributes)
span attributes).
For some cloud providers, the above definition is ambiguous. The following
definition of function name MUST be used for this attribute
(and consequently the span name) for the listed cloud providers/products:
* **Azure:** The full name `<FUNCAPP>/<FUNC>`, i.e., function app name
followed by a forward slash followed by the function name (this form
can also be seen in the resource JSON for the function).
This means that a span attribute MUST be used, as an Azure function
app can host multiple functions that would usually share
a TracerProvider (see also the `cloud.resource_id` attribute).
**[7]:** Depending on the cloud provider and platform, use:
* **AWS Lambda:** The [function version](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html)
(an integer represented as a decimal string).
* **Google Cloud Run (Services):** The [revision](https://cloud.google.com/run/docs/managing/revisions)
(i.e., the function name plus the revision suffix).
* **Google Cloud Functions:** The value of the
[`K_REVISION` environment variable](https://cloud.google.com/functions/docs/env-var#runtime_environment_variables_set_automatically).
* **Azure Functions:** Not applicable. Do not set this attribute.
`faas.document.operation` 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.
| Value | Description |
|---|---|
| `insert` | When a new object is created. |
| `edit` | When an object is modified. |
| `delete` | When an object is deleted. |
`faas.invoked_provider` 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.
| Value | Description |
|---|---|
| `alibaba_cloud` | Alibaba Cloud |
| `aws` | Amazon Web Services |
| `azure` | Microsoft Azure |
| `gcp` | Google Cloud Platform |
| `tencent_cloud` | Tencent Cloud |
`faas.trigger` MUST be one of the following:
| Value | Description |
|---|---|
| `datasource` | A response to some data source operation such as a database or filesystem read/write |
| `http` | To provide an answer to an inbound HTTP request |
| `pubsub` | A function is set to be executed when messages are sent to a messaging system |
| `timer` | A function is scheduled to be executed regularly |
| `other` | If none of the others apply |
<!-- endsemconv -->

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

@ -58,7 +58,7 @@ 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(full) --> <!-- semconv metric.faas.invoke_duration(full) -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| `faas.trigger` | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended | | [`faas.trigger`](../attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended |
`faas.trigger` MUST be one of the following: `faas.trigger` MUST be one of the following:
@ -88,7 +88,7 @@ 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(full) --> <!-- semconv metric.faas.init_duration(full) -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| `faas.trigger` | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended | | [`faas.trigger`](../attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended |
`faas.trigger` MUST be one of the following: `faas.trigger` MUST be one of the following:
@ -114,7 +114,7 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.faas.coldstarts(full) --> <!-- semconv metric.faas.coldstarts(full) -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| `faas.trigger` | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended | | [`faas.trigger`](../attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended |
`faas.trigger` MUST be one of the following: `faas.trigger` MUST be one of the following:
@ -140,7 +140,7 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.faas.errors(full) --> <!-- semconv metric.faas.errors(full) -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| `faas.trigger` | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended | | [`faas.trigger`](../attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended |
`faas.trigger` MUST be one of the following: `faas.trigger` MUST be one of the following:
@ -166,7 +166,7 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.faas.invocations(full) --> <!-- semconv metric.faas.invocations(full) -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| `faas.trigger` | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended | | [`faas.trigger`](../attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended |
`faas.trigger` MUST be one of the following: `faas.trigger` MUST be one of the following:
@ -192,7 +192,7 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.faas.timeouts(full) --> <!-- semconv metric.faas.timeouts(full) -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| `faas.trigger` | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended | | [`faas.trigger`](../attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended |
`faas.trigger` MUST be one of the following: `faas.trigger` MUST be one of the following:
@ -218,7 +218,7 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.faas.mem_usage(full) --> <!-- semconv metric.faas.mem_usage(full) -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| `faas.trigger` | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended | | [`faas.trigger`](../attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended |
`faas.trigger` MUST be one of the following: `faas.trigger` MUST be one of the following:
@ -248,7 +248,7 @@ 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(full) --> <!-- semconv metric.faas.cpu_usage(full) -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| `faas.trigger` | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended | | [`faas.trigger`](../attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended |
`faas.trigger` MUST be one of the following: `faas.trigger` MUST be one of the following:
@ -274,7 +274,7 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.faas.net_io(full) --> <!-- semconv metric.faas.net_io(full) -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| `faas.trigger` | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended | | [`faas.trigger`](../attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource` | Recommended |
`faas.trigger` MUST be one of the following: `faas.trigger` MUST be one of the following:

28
docs/faas/faas-spans.md
View File

@ -42,8 +42,8 @@ If Spans following this convention are produced, a Resource of type `faas` MUST
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| [`cloud.resource_id`](../attributes-registry/cloud.md) | string | Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP) [1] | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` | Recommended | | [`cloud.resource_id`](../attributes-registry/cloud.md) | string | Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP) [1] | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` | Recommended |
| `faas.invocation_id` | string | The invocation ID of the current function invocation. | `af9d5aa4-a685-4c5f-a22b-444f80b3cc28` | Recommended | | [`faas.invocation_id`](../attributes-registry/faas.md) | string | The invocation ID of the current function invocation. | `af9d5aa4-a685-4c5f-a22b-444f80b3cc28` | Recommended |
| `faas.trigger` | string | Type of the trigger which caused this function invocation. [2] | `datasource` | Recommended | | [`faas.trigger`](../attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. [2] | `datasource` | Recommended |
**[1]:** On some cloud providers, it may not be possible to determine the full ID at startup, **[1]:** On some cloud providers, it may not be possible to determine the full ID at startup,
so it may be necessary to set `cloud.resource_id` as a span attribute instead. so it may be necessary to set `cloud.resource_id` as a span attribute instead.
@ -122,8 +122,8 @@ For incoming FaaS spans, the span kind MUST be `Server`.
<!-- semconv faas_span.in --> <!-- semconv faas_span.in -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| `faas.coldstart` | boolean | A boolean that is true if the serverless function is executed for the first time (aka cold-start). | | Recommended | | [`faas.coldstart`](../attributes-registry/faas.md) | boolean | A boolean that is true if the serverless function is executed for the first time (aka cold-start). | | Recommended |
| `faas.trigger` | string | Type of the trigger which caused this function invocation. [1] | `datasource` | Required | | [`faas.trigger`](../attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. [1] | `datasource` | Required |
**[1]:** For the server/consumer span on the incoming side, **[1]:** For the server/consumer span on the incoming side,
`faas.trigger` MUST be set. `faas.trigger` MUST be set.
@ -161,9 +161,9 @@ which the invoked FaaS instance reports about itself, if it's instrumented.
<!-- semconv faas_span.out(full) --> <!-- semconv faas_span.out(full) -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| `faas.invoked_name` | string | The name of the invoked function. [1] | `my-function` | Required | | [`faas.invoked_name`](../attributes-registry/faas.md) | string | The name of the invoked function. [1] | `my-function` | Required |
| `faas.invoked_provider` | string | The cloud provider of the invoked function. [2] | `alibaba_cloud` | Required | | [`faas.invoked_provider`](../attributes-registry/faas.md) | string | The cloud provider of the invoked function. [2] | `alibaba_cloud` | Required |
| `faas.invoked_region` | string | The cloud region of the invoked function. [3] | `eu-central-1` | Conditionally Required: [4] | | [`faas.invoked_region`](../attributes-registry/faas.md) | string | The cloud region of the invoked function. [3] | `eu-central-1` | Conditionally Required: [4] |
**[1]:** SHOULD be equal to the `faas.name` resource attribute of the invoked function. **[1]:** SHOULD be equal to the `faas.name` resource attribute of the invoked function.
@ -196,13 +196,13 @@ This section describes how to handle the span creation and additional attributes
A datasource function is triggered as a response to some data source operation such as a database or filesystem read/write. A datasource function is triggered as a response to some data source operation such as a database or filesystem read/write.
FaaS instrumentations that produce `faas` spans with trigger `datasource`, SHOULD use the following set of attributes. FaaS instrumentations that produce `faas` spans with trigger `datasource`, SHOULD use the following set of attributes.
<!-- semconv faas_span.datasource --> <!-- semconv faas_span.datasource(full) -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| `faas.document.collection` | string | The name of the source on which the triggering operation was performed. For example, in Cloud Storage or S3 corresponds to the bucket name, and in Cosmos DB to the database name. | `myBucketName`; `myDbName` | Required | | [`faas.document.collection`](../attributes-registry/faas.md) | string | The name of the source on which the triggering operation was performed. For example, in Cloud Storage or S3 corresponds to the bucket name, and in Cosmos DB to the database name. | `myBucketName`; `myDbName` | Required |
| `faas.document.name` | string | The document name/table subjected to the operation. For example, in Cloud Storage or S3 is the name of the file, and in Cosmos DB the table name. | `myFile.txt`; `myTableName` | Recommended | | [`faas.document.name`](../attributes-registry/faas.md) | string | The document name/table subjected to the operation. For example, in Cloud Storage or S3 is the name of the file, and in Cosmos DB the table name. | `myFile.txt`; `myTableName` | Recommended |
| `faas.document.operation` | string | Describes the type of the operation that was performed on the data. | `insert` | Required | | [`faas.document.operation`](../attributes-registry/faas.md) | string | Describes the type of the operation that was performed on the data. | `insert` | Required |
| `faas.document.time` | string | A string containing the time when the data was accessed in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime). | `2020-01-23T13:47:06Z` | Recommended | | [`faas.document.time`](../attributes-registry/faas.md) | string | A string containing the time when the data was accessed in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime). | `2020-01-23T13:47:06Z` | Recommended |
`faas.document.operation` 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. `faas.document.operation` 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.
@ -232,8 +232,8 @@ A function is scheduled to be executed regularly. The following additional attri
<!-- semconv faas_span.timer --> <!-- semconv faas_span.timer -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| `faas.cron` | string | A string containing the schedule period as [Cron Expression](https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm). | `0/5 * * * ? *` | Recommended | | [`faas.cron`](../attributes-registry/faas.md) | string | A string containing the schedule period as [Cron Expression](https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm). | `0/5 * * * ? *` | Recommended |
| `faas.time` | string | A string containing the function invocation time in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime). | `2020-01-23T13:47:06Z` | Recommended | | [`faas.time`](../attributes-registry/faas.md) | string | A string containing the function invocation time in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime). | `2020-01-23T13:47:06Z` | Recommended |
<!-- endsemconv --> <!-- endsemconv -->
### Other ### Other

8
docs/resource/faas.md
View File

@ -17,10 +17,10 @@ See also:
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| [`cloud.resource_id`](../attributes-registry/cloud.md) | string | Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP) [1] | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` | Recommended | | [`cloud.resource_id`](../attributes-registry/cloud.md) | string | Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP) [1] | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` | Recommended |
| `faas.instance` | string | The execution environment ID as a string, that will be potentially reused for other invocations to the same function/function version. [2] | `2021/06/28/[$LATEST]2f399eb14537447da05ab2a2e39309de` | Recommended | | [`faas.instance`](../attributes-registry/faas.md) | string | The execution environment ID as a string, that will be potentially reused for other invocations to the same function/function version. [2] | `2021/06/28/[$LATEST]2f399eb14537447da05ab2a2e39309de` | Recommended |
| `faas.max_memory` | int | The amount of memory available to the serverless function converted to Bytes. [3] | `134217728` | Recommended | | [`faas.max_memory`](../attributes-registry/faas.md) | int | The amount of memory available to the serverless function converted to Bytes. [3] | `134217728` | Recommended |
| `faas.name` | string | The name of the single function that this runtime instance executes. [4] | `my-function`; `myazurefunctionapp/some-function-name` | Required | | [`faas.name`](../attributes-registry/faas.md) | string | The name of the single function that this runtime instance executes. [4] | `my-function`; `myazurefunctionapp/some-function-name` | Required |
| `faas.version` | string | The immutable version of the function being executed. [5] | `26`; `pinkfroid-00002` | Recommended | | [`faas.version`](../attributes-registry/faas.md) | string | The immutable version of the function being executed. [5] | `26`; `pinkfroid-00002` | Recommended |
**[1]:** On some cloud providers, it may not be possible to determine the full ID at startup, **[1]:** On some cloud providers, it may not be possible to determine the full ID at startup,
so it may be necessary to set `cloud.resource_id` as a span attribute instead. so it may be necessary to set `cloud.resource_id` as a span attribute instead.

68
model/faas-common.yaml
View File

@ -4,66 +4,12 @@ groups:
brief: "Describes FaaS attributes." brief: "Describes FaaS attributes."
prefix: faas prefix: faas
attributes: attributes:
- id: trigger - ref: faas.trigger
brief: 'Type of the trigger which caused this function invocation.' - ref: faas.invoked_name
type:
allow_custom_values: false
members:
- id: datasource
value: 'datasource'
brief: 'A response to some data source operation such as a database or filesystem read/write'
- id: http
value: 'http'
brief: 'To provide an answer to an inbound HTTP request'
- id: pubsub
value: 'pubsub'
brief: 'A function is set to be executed when messages are sent to a messaging system'
- id: timer
value: 'timer'
brief: 'A function is scheduled to be executed regularly'
- id: other
value: 'other'
brief: 'If none of the others apply'
stability: experimental
- id: invoked_name
type: string
stability: experimental
requirement_level: required requirement_level: required
brief: > - ref: faas.invoked_provider
The name of the invoked function.
note: >
SHOULD be equal to the `faas.name` resource attribute of the
invoked function.
examples: 'my-function'
- id: invoked_provider
type:
allow_custom_values: true
members:
- id: 'alibaba_cloud'
value: 'alibaba_cloud'
brief: 'Alibaba Cloud'
- id: 'aws'
value: 'aws'
brief: 'Amazon Web Services'
- id: 'azure'
value: 'azure'
brief: 'Microsoft Azure'
- id: 'gcp'
value: 'gcp'
brief: 'Google Cloud Platform'
- id: 'tencent_cloud'
value: 'tencent_cloud'
brief: 'Tencent Cloud'
stability: experimental
requirement_level: required requirement_level: required
brief: > - ref: faas.invoked_region
The cloud provider of the invoked function.
note: >
SHOULD be equal to the `cloud.provider` resource attribute of the
invoked function.
- id: invoked_region
type: string
stability: experimental
requirement_level: requirement_level:
conditionally_required: > conditionally_required: >
For some cloud providers, like AWS or GCP, the region in which a For some cloud providers, like AWS or GCP, the region in which a
@ -73,9 +19,3 @@ groups:
`faas.invoked_region` MUST be set accordingly. If the region is `faas.invoked_region` MUST be set accordingly. If the region is
unknown to the client or not required for identifying the invoked unknown to the client or not required for identifying the invoked
function, setting `faas.invoked_region` is optional. function, setting `faas.invoked_region` is optional.
brief: >
The cloud region of the invoked function.
note: >
SHOULD be equal to the `cloud.region` resource attribute of the
invoked function.
examples: 'eu-central-1'

195
model/registry/faas.yaml Normal file
View File

@ -0,0 +1,195 @@
groups:
- id: registry.faas
brief: FaaS attributes
type: attribute_group
prefix: faas
attributes:
- id: name
type: string
stability: experimental
brief: >
The name of the single function that this runtime instance executes.
note: |
This is the name of the function as configured/deployed on the FaaS
platform and is usually different from the name of the callback
function (which may be stored in the
[`code.namespace`/`code.function`](/docs/general/attributes.md#source-code-attributes)
span attributes).
For some cloud providers, the above definition is ambiguous. The following
definition of function name MUST be used for this attribute
(and consequently the span name) for the listed cloud providers/products:
* **Azure:** The full name `<FUNCAPP>/<FUNC>`, i.e., function app name
followed by a forward slash followed by the function name (this form
can also be seen in the resource JSON for the function).
This means that a span attribute MUST be used, as an Azure function
app can host multiple functions that would usually share
a TracerProvider (see also the `cloud.resource_id` attribute).
examples: ['my-function', 'myazurefunctionapp/some-function-name']
- id: version
type: string
stability: experimental
brief: The immutable version of the function being executed.
note: |
Depending on the cloud provider and platform, use:
* **AWS Lambda:** The [function version](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html)
(an integer represented as a decimal string).
* **Google Cloud Run (Services):** The [revision](https://cloud.google.com/run/docs/managing/revisions)
(i.e., the function name plus the revision suffix).
* **Google Cloud Functions:** The value of the
[`K_REVISION` environment variable](https://cloud.google.com/functions/docs/env-var#runtime_environment_variables_set_automatically).
* **Azure Functions:** Not applicable. Do not set this attribute.
examples: ['26', 'pinkfroid-00002']
- id: instance
type: string
stability: experimental
brief: >
The execution environment ID as a string, that will be potentially reused
for other invocations to the same function/function version.
note: >
* **AWS Lambda:** Use the (full) log stream name.
examples: ['2021/06/28/[$LATEST]2f399eb14537447da05ab2a2e39309de']
- id: max_memory
type: int
stability: experimental
brief: >
The amount of memory available to the serverless function converted to Bytes.
note: >
It's recommended to set this attribute since e.g. too little memory can easily
stop a Java AWS Lambda function from working correctly.
On AWS Lambda, the environment variable `AWS_LAMBDA_FUNCTION_MEMORY_SIZE`
provides this information (which must be multiplied by 1,048,576).
examples: 134217728
- id: trigger
stability: experimental
brief: >
Type of the trigger which caused this function invocation.
type:
allow_custom_values: false
members:
- id: datasource
value: 'datasource'
brief: 'A response to some data source operation such as a database or filesystem read/write'
- id: http
value: 'http'
brief: 'To provide an answer to an inbound HTTP request'
- id: pubsub
value: 'pubsub'
brief: 'A function is set to be executed when messages are sent to a messaging system'
- id: timer
value: 'timer'
brief: 'A function is scheduled to be executed regularly'
- id: other
value: 'other'
brief: 'If none of the others apply'
- id: invoked_name
type: string
stability: experimental
brief: >
The name of the invoked function.
note: >
SHOULD be equal to the `faas.name` resource attribute of the
invoked function.
examples: 'my-function'
- id: invoked_provider
stability: experimental
type:
allow_custom_values: true
members:
- id: 'alibaba_cloud'
value: 'alibaba_cloud'
brief: 'Alibaba Cloud'
- id: 'aws'
value: 'aws'
brief: 'Amazon Web Services'
- id: 'azure'
value: 'azure'
brief: 'Microsoft Azure'
- id: 'gcp'
value: 'gcp'
brief: 'Google Cloud Platform'
- id: 'tencent_cloud'
value: 'tencent_cloud'
brief: 'Tencent Cloud'
brief: >
The cloud provider of the invoked function.
note: >
SHOULD be equal to the `cloud.provider` resource attribute of the
invoked function.
- id: invoked_region
type: string
stability: experimental
brief: >
The cloud region of the invoked function.
note: >
SHOULD be equal to the `cloud.region` resource attribute of the
invoked function.
examples: 'eu-central-1'
- id: invocation_id
type: string
stability: experimental
brief: >
The invocation ID of the current function invocation.
examples: 'af9d5aa4-a685-4c5f-a22b-444f80b3cc28'
- id: time
type: string
stability: experimental
brief: >
A string containing the function invocation time in the
[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime).
examples: "2020-01-23T13:47:06Z"
- id: cron
type: string
stability: experimental
brief: >
A string containing the schedule period as
[Cron Expression](https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm).
examples: "0/5 * * * ? *"
- id: coldstart
type: boolean
stability: experimental
brief: >
A boolean that is true if the serverless function is executed for the
first time (aka cold-start).
- id: document.collection
type: string
stability: experimental
brief: >
The name of the source on which the triggering operation was performed.
For example, in Cloud Storage or S3 corresponds to the bucket name,
and in Cosmos DB to the database name.
examples: ['myBucketName', 'myDbName']
- id: document.operation
stability: experimental
type:
allow_custom_values: true
members:
- id: insert
value: 'insert'
brief: 'When a new object is created.'
- id: edit
value: 'edit'
brief: 'When an object is modified.'
- id: delete
value: 'delete'
brief: 'When an object is deleted.'
brief: 'Describes the type of the operation that was performed on the data.'
- id: document.time
type: string
stability: experimental
brief: >
A string containing the time when the data was accessed in the
[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime).
examples: "2020-01-23T13:47:06Z"
- id: document.name
type: string
stability: experimental
brief: >
The document name/table subjected to the operation.
For example, in Cloud Storage or S3 is the name of
the file, and in Cosmos DB the table name.
examples: ["myFile.txt", "myTableName"]

62
model/resource/faas.yaml
View File

@ -5,63 +5,9 @@ groups:
brief: > brief: >
A serverless instance. A serverless instance.
attributes: attributes:
- id: name - ref: faas.name
type: string
stability: experimental
requirement_level: required requirement_level: required
brief: > - ref: faas.version
The name of the single function that this runtime instance executes. - ref: faas.instance
note: | - ref: faas.max_memory
This is the name of the function as configured/deployed on the FaaS
platform and is usually different from the name of the callback
function (which may be stored in the
[`code.namespace`/`code.function`](/docs/general/attributes.md#source-code-attributes)
span attributes).
For some cloud providers, the above definition is ambiguous. The following
definition of function name MUST be used for this attribute
(and consequently the span name) for the listed cloud providers/products:
* **Azure:** The full name `<FUNCAPP>/<FUNC>`, i.e., function app name
followed by a forward slash followed by the function name (this form
can also be seen in the resource JSON for the function).
This means that a span attribute MUST be used, as an Azure function
app can host multiple functions that would usually share
a TracerProvider (see also the `cloud.resource_id` attribute).
examples: ['my-function', 'myazurefunctionapp/some-function-name']
- id: version
type: string
stability: experimental
brief: The immutable version of the function being executed.
note: |
Depending on the cloud provider and platform, use:
* **AWS Lambda:** The [function version](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html)
(an integer represented as a decimal string).
* **Google Cloud Run (Services):** The [revision](https://cloud.google.com/run/docs/managing/revisions)
(i.e., the function name plus the revision suffix).
* **Google Cloud Functions:** The value of the
[`K_REVISION` environment variable](https://cloud.google.com/functions/docs/env-var#runtime_environment_variables_set_automatically).
* **Azure Functions:** Not applicable. Do not set this attribute.
examples: ['26', 'pinkfroid-00002']
- id: instance
type: string
stability: experimental
brief: >
The execution environment ID as a string, that will be potentially reused
for other invocations to the same function/function version.
note: >
* **AWS Lambda:** Use the (full) log stream name.
examples: ['2021/06/28/[$LATEST]2f399eb14537447da05ab2a2e39309de']
- id: max_memory
type: int
stability: experimental
brief: >
The amount of memory available to the serverless function converted to Bytes.
note: >
It's recommended to set this attribute since e.g. too little memory can easily
stop a Java AWS Lambda function from working correctly.
On AWS Lambda, the environment variable `AWS_LAMBDA_FUNCTION_MEMORY_SIZE`
provides this information (which must be multiplied by 1,048,576).
examples: 134217728
- ref: cloud.resource_id - ref: cloud.resource_id

84
model/trace/faas.yaml
View File

@ -18,11 +18,7 @@ groups:
trigger that corresponding incoming would have (i.e., this has trigger that corresponding incoming would have (i.e., this has
nothing to do with the underlying transport used to make the API nothing to do with the underlying transport used to make the API
call to invoke the lambda, which is often HTTP). call to invoke the lambda, which is often HTTP).
- id: invocation_id - ref: faas.invocation_id
type: string
stability: experimental
brief: 'The invocation ID of the current function invocation.'
examples: 'af9d5aa4-a685-4c5f-a22b-444f80b3cc28'
- ref: cloud.resource_id - ref: cloud.resource_id
- id: faas_span.datasource - id: faas_span.datasource
@ -32,47 +28,12 @@ groups:
Semantic Convention for FaaS triggered as a response to some data Semantic Convention for FaaS triggered as a response to some data
source operation such as a database or filesystem read/write. source operation such as a database or filesystem read/write.
attributes: attributes:
- id: collection - ref: faas.document.collection
type: string
stability: experimental
requirement_level: required requirement_level: required
brief: > - ref: faas.document.operation
The name of the source on which the triggering operation was performed.
For example, in Cloud Storage or S3 corresponds to the bucket name,
and in Cosmos DB to the database name.
examples: ['myBucketName', 'myDbName']
- id: operation
stability: experimental
requirement_level: required requirement_level: required
type: - ref: faas.document.time
allow_custom_values: true - ref: faas.document.name
members:
- id: insert
value: 'insert'
brief: 'When a new object is created.'
- id: edit
value: 'edit'
brief: 'When an object is modified.'
- id: delete
value: 'delete'
brief: 'When an object is deleted.'
brief: 'Describes the type of the operation that was performed on the data.'
- id: time
type: string
stability: experimental
brief: >
A string containing the time when the data was accessed in the
[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime).
examples: "2020-01-23T13:47:06Z"
- id: name
type: string
stability: experimental
brief: >
The document name/table subjected to the operation.
For example, in Cloud Storage or S3 is the name of
the file, and in Cosmos DB the table name.
examples: ["myFile.txt", "myTableName"]
- id: faas_span.http - id: faas_span.http
type: span type: span
@ -96,21 +57,8 @@ groups:
brief: > brief: >
Semantic Convention for FaaS scheduled to be executed regularly. Semantic Convention for FaaS scheduled to be executed regularly.
attributes: attributes:
- id: time - ref: faas.time
type: string - ref: faas.cron
stability: experimental
brief: >
A string containing the function invocation time in the
[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime).
examples: "2020-01-23T13:47:06Z"
- id: cron
type: string
stability: experimental
brief: >
A string containing the schedule period as
[Cron Expression](https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm).
examples: "0/5 * * * ? *"
- id: faas_span.in - id: faas_span.in
span_kind: server span_kind: server
@ -119,12 +67,7 @@ groups:
brief: > brief: >
Contains additional attributes for incoming FaaS spans. Contains additional attributes for incoming FaaS spans.
attributes: attributes:
- id: coldstart - ref: faas.coldstart
type: boolean
stability: experimental
brief: >
A boolean that is true if the serverless function is executed for the
first time (aka cold-start).
- ref: faas.trigger - ref: faas.trigger
requirement_level: required requirement_level: required
note: | note: |
@ -146,5 +89,16 @@ groups:
Contains additional attributes for outgoing FaaS spans. Contains additional attributes for outgoing FaaS spans.
attributes: attributes:
- ref: faas.invoked_name - ref: faas.invoked_name
requirement_level: required
- ref: faas.invoked_provider - ref: faas.invoked_provider
requirement_level: required
- ref: faas.invoked_region - ref: faas.invoked_region
requirement_level:
conditionally_required: >
For some cloud providers, like AWS or GCP, the region in which a
function is hosted is essential to uniquely identify the function
and also part of its endpoint. Since it's part of the endpoint
being called, the region is always known to clients. In these cases,
`faas.invoked_region` MUST be set accordingly. If the region is
unknown to the client or not required for identifying the invoked
function, setting `faas.invoked_region` is optional.