Package io.opentelemetry.semconv.incubating

Class FaasIncubatingAttributes

java.lang.Object
io.opentelemetry.semconv.incubating.FaasIncubatingAttributes
public final class FaasIncubatingAttributes extends Object

  • Field Details

    • FAAS_COLDSTART

      public static final io.opentelemetry.api.common.AttributeKey<Boolean> FAAS_COLDSTART
      A boolean that is true if the serverless function is executed for the first time (aka cold-start).

    • FAAS_CRON

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_CRON
      A string containing the schedule period as Cron Expression.

    • FAAS_DOCUMENT_COLLECTION

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_DOCUMENT_COLLECTION
      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.

    • FAAS_DOCUMENT_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_DOCUMENT_NAME
      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.

    • FAAS_DOCUMENT_OPERATION

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_DOCUMENT_OPERATION
      Describes the type of the operation that was performed on the data.

    • FAAS_DOCUMENT_TIME

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_DOCUMENT_TIME
      A string containing the time when the data was accessed in the ISO 8601 format expressed in UTC.

    • FAAS_INSTANCE

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_INSTANCE
      The execution environment ID as a string, that will be potentially reused for other invocations to the same function/function version.

      Notes:

      • AWS Lambda: Use the (full) log stream name.

    • FAAS_INVOCATION_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_INVOCATION_ID
      The invocation ID of the current function invocation.

    • FAAS_INVOKED_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_INVOKED_NAME
      The name of the invoked function.

      Notes:

      SHOULD be equal to the faas.name resource attribute of the invoked function.

    • FAAS_INVOKED_PROVIDER

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_INVOKED_PROVIDER
      The cloud provider of the invoked function.

      Notes:

      SHOULD be equal to the cloud.provider resource attribute of the invoked function.

    • FAAS_INVOKED_REGION

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_INVOKED_REGION
      The cloud region of the invoked function.

      Notes:

      SHOULD be equal to the cloud.region resource attribute of the invoked function.

    • FAAS_MAX_MEMORY

      public static final io.opentelemetry.api.common.AttributeKey<Long> FAAS_MAX_MEMORY
      The amount of memory available to the serverless function converted to Bytes.

      Notes:

      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).

    • FAAS_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_NAME
      The name of the single function that this runtime instance executes.

      Notes:

      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 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).

    • FAAS_TIME

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_TIME
      A string containing the function invocation time in the ISO 8601 format expressed in UTC.

    • FAAS_TRIGGER

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_TRIGGER
      Type of the trigger which caused this function invocation.

    • FAAS_VERSION

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_VERSION
      The immutable version of the function being executed.

      Notes:

      Depending on the cloud provider and platform, use:

      • AWS Lambda: The function version (an integer represented as a decimal string).
      • Google Cloud Run (Services): The revision (i.e., the function name plus the revision suffix).
      • Google Cloud Functions: The value of the K_REVISION environment variable.
      • Azure Functions: Not applicable. Do not set this attribute.