feat(semantic-conventions): FaaS specifications (#1670)

packages/opentelemetry-semantic-conventions/src/trace/faas.ts

@@ -0,0 +1,170 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * FaaS (Function as a Service) attribute names defined by the Opetelemetry Semantic Conventions specification
+ * https:/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/faas.md
+ */
+export const FaasAttribute = {
+ // General attributes
+
+ /**
+ * The name of the function being executed.
+ *
+ * @remarks
+ * Required.
+ */
+ FAAS_NAME: 'faas.name',
+
+ /**
+ * The unique ID of the function being executed.
+ * For example, in AWS Lambda this field corresponds to the ARN value, in GCP to the URI of the resource, and in Azure to the FunctionDirectory field.
+ *
+ * @remarks
+ * Required.
+ */
+ FAAS_ID: 'faas.id',
+
+ /**
+ * The version string of the function being executed.
+ *
+ * @remarks
+ * Optional.
+ */
+ FAAS_VERSION: 'faas.version',
+
+ /**
+ * The execution environment ID as a string.
+ *
+ * @remarks
+ * Optional.
+ */
+ FAAS_INSTANCE: 'faas.instance',
+
+ /**
+ * Type of the trigger on which the function is executed.
+ * Possible values: datasource, http, pubsub, timer, other
+ *
+ * @remarks
+ * Required if applicable.
+ */
+ FAAS_TRIGGER: 'faas.trigger',
+
+ /**
+ * The execution ID of the current function execution.
+ *
+ * @remarks
+ * Optional.
+ */
+ FAAS_EXECUTION: 'faas.execution',
+
+ // Incoming Invocations
+
+ /**
+ * A boolean that is true if the serverless function is executed for the first time (aka cold-start).
+ *
+ * @remarks
+ * Optional.
+ */
+ FAAS_COLD_START: 'faas.coldstart',
+
+ // Outgoing Invocations
+ // This section describes outgoing FaaS invocations as they are reported by a client calling a FaaS instance.
+
+ /**
+ * The name of the invoked function.
+ * SHOULD be equal to the faas.name resource attribute of the invoked function.
+ *
+ * @remarks
+ * Optional.
+ */
+ FAAS_INVOKED_NAME: 'faas.invoked_name',
+
+ /**
+ * The cloud provider of the invoked function.
+ * SHOULD be equal to the cloud.provider resource attribute of the invoked function.
+ *
+ * @remarks
+ * Optional.
+ */
+ FAAS_INVOKED_PROVIDER: 'faas.invoked_provider',
+
+ /**
+ * The cloud region of the invoked function.
+ * SHOULD be equal to the cloud.region resource attribute of the invoked function.
+ *
+ * @remarks
+ * Optional.
+ */
+ FAAS_INVOKED_REGION: 'faas.invoked_region',
+
+ // Datesource Trigger
+
+ /**
+ * 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.
+ *
+ * @remarks
+ * Required if applicable.
+ */
+ FAAS_DOC_COLLECTION: 'faas.document.collection',
+
+ /**
+ * Describes the type of the operation that was performed on the data.
+ * MUST be one of the following or, if none of the listed values apply, a custom value: insert, edit, delete
+ *
+ * @remarks
+ * Required if applicable.
+ */
+ FAAS_DOC_OPERATION: 'faas.document.operation',
+
+ /**
+ * A string containing the time when the data was accessed in the ISO 8601 format expressed in UTC.
+ *
+ * @remarks
+ * Required if applicable.
+ */
+ FAAS_DOC_TIME: 'faas.document.time',
+
+ /**
+ * 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.
+ *
+ * @remarks
+ * Optional.
+ */
+ FAAS_DOC_NAME: 'faas.document.name',
+
+ // Timer Trigger
+
+ /**
+ * A string containing the function invocation time in the ISO 8601 format expressed in UTC.
+ * Example: "2020-01-23T13:47:06Z"
+ *
+ * @remarks
+ * Required if applicable.
+ */
+ FAAS_TIME: 'faas.time',
+
+ /**
+ * A string containing the schedule period as Cron Expression.
+ * Example: "0/5 * * * ? *"
+ *
+ * @remarks
+ * Optional.
+ */
+ FAAS_CRON: 'faas.cron',
+};

packages/opentelemetry-semantic-conventions/src/trace/index.ts

@@ -20,3 +20,4 @@ export * from './general';
 export * from './http';
 export * from './os';
 export * from './rpc';
+export * from './faas';