@microsoft/opentelemetry
    Preparing search index...

    Class OpenTelemetryConstants

    OpenTelemetry constants for A365 observability.

    Attribute keys follow OTel gen-ai semantic conventions plus Microsoft-specific extensions under the microsoft.* namespace.

    Adapted from microsoft/Agent365-nodejs agents-a365-observability/src/tracing/constants.ts

    Index

    Constructors

    constructor

    Properties

    A365_MESSAGES_SCHEMA_VERSION_KEY AGENT_ID_KEY AZ_NAMESPACE_KEY AZURE_RP_NAMESPACE_VALUE CHANNEL_LINK_KEY CHANNEL_NAME_KEY CHAT_OPERATION_NAME CUSTOM_PARENT_SPAN_ID_KEY CUSTOM_SPAN_NAME_KEY ENABLE_A365_OBSERVABILITY ENABLE_A365_OBSERVABILITY_EXPORTER ENABLE_OBSERVABILITY ENABLE_OPENTELEMETRY_SWITCH ERROR_MESSAGE_KEY ERROR_TYPE_CANCELLED ERROR_TYPE_KEY EXECUTE_TOOL_OPERATION_NAME GEN_AI_AGENT_AUID_KEY GEN_AI_AGENT_BLUEPRINT_ID_KEY GEN_AI_AGENT_DESCRIPTION_KEY GEN_AI_AGENT_EMAIL_KEY GEN_AI_AGENT_ID_KEY GEN_AI_AGENT_NAME_KEY GEN_AI_AGENT_PLATFORM_ID_KEY GEN_AI_AGENT_THOUGHT_PROCESS_KEY GEN_AI_AGENT_VERSION_KEY GEN_AI_CALLER_AGENT_APPLICATION_ID_KEY GEN_AI_CALLER_AGENT_EMAIL_KEY GEN_AI_CALLER_AGENT_ID_KEY GEN_AI_CALLER_AGENT_NAME_KEY GEN_AI_CALLER_AGENT_PLATFORM_ID_KEY GEN_AI_CALLER_AGENT_USER_ID_KEY GEN_AI_CALLER_AGENT_VERSION_KEY GEN_AI_CALLER_CLIENT_IP_KEY GEN_AI_CHOICE GEN_AI_CLIENT_OPERATION_DURATION_METRIC_NAME GEN_AI_CLIENT_TOKEN_USAGE_METRIC_NAME GEN_AI_CONVERSATION_ID_KEY GEN_AI_CONVERSATION_ITEM_LINK_KEY GEN_AI_EXECUTION_PAYLOAD_KEY GEN_AI_ICON_URI_KEY GEN_AI_INPUT_MESSAGES_KEY GEN_AI_OPERATION_NAME_KEY GEN_AI_OUTPUT_MESSAGES_KEY GEN_AI_PROVIDER_NAME_KEY GEN_AI_REQUEST_MAX_TOKENS_KEY GEN_AI_REQUEST_MODEL_KEY GEN_AI_REQUEST_TEMPERATURE_KEY GEN_AI_REQUEST_TOP_P_KEY GEN_AI_RESPONSE_FINISH_REASONS_KEY GEN_AI_RESPONSE_MODEL_KEY GEN_AI_SYSTEM_INSTRUCTIONS_KEY GEN_AI_TASK_ID_KEY GEN_AI_TOOL_ARGS_KEY GEN_AI_TOOL_CALL_ID_KEY GEN_AI_TOOL_CALL_RESULT_KEY GEN_AI_TOOL_DESCRIPTION_KEY GEN_AI_TOOL_NAME_KEY GEN_AI_TOOL_TYPE_KEY GEN_AI_USAGE_INPUT_TOKENS_KEY GEN_AI_USAGE_OUTPUT_TOKENS_KEY INVOKE_AGENT_OPERATION_NAME OUTPUT_MESSAGES_OPERATION_NAME SERVER_ADDRESS_KEY SERVER_PORT_KEY SERVICE_NAME_KEY SESSION_DESCRIPTION_KEY SESSION_ID_KEY SOURCE_NAME TELEMETRY_SDK_LANGUAGE_KEY TELEMETRY_SDK_LANGUAGE_VALUE TELEMETRY_SDK_NAME_KEY TELEMETRY_SDK_NAME_VALUE TELEMETRY_SDK_VERSION_KEY TELEMETRY_SDK_VERSION_VALUE TENANT_ID_KEY TRACE_CONTENTS_ENVIRONMENT_VARIABLE TRACE_CONTENTS_SWITCH USER_EMAIL_KEY USER_ID_KEY USER_NAME_KEY

    Constructors

    Properties

    A365_MESSAGES_SCHEMA_VERSION_KEY: "microsoft.a365.messages.schema_version"
    AGENT_ID_KEY: "gen_ai.agent.id"
    AZ_NAMESPACE_KEY: "az.namespace"
    AZURE_RP_NAMESPACE_VALUE: "Microsoft.CognitiveServices"
    CHANNEL_LINK_KEY: "microsoft.channel.link"
    CHANNEL_NAME_KEY: "microsoft.channel.name"
    CHAT_OPERATION_NAME: "chat"
    CUSTOM_PARENT_SPAN_ID_KEY: "custom.parent.span.id"
    CUSTOM_SPAN_NAME_KEY: "custom.span.name"
    ENABLE_A365_OBSERVABILITY: "ENABLE_A365_OBSERVABILITY"
    ENABLE_A365_OBSERVABILITY_EXPORTER: "ENABLE_A365_OBSERVABILITY_EXPORTER"
    ENABLE_OBSERVABILITY: "ENABLE_OBSERVABILITY"
    ENABLE_OPENTELEMETRY_SWITCH: "Azure.Experimental.EnableActivitySource"
    ERROR_MESSAGE_KEY: "error.message"
    ERROR_TYPE_CANCELLED: "TaskCanceledException"
    ERROR_TYPE_KEY: "error.type"
    EXECUTE_TOOL_OPERATION_NAME: "execute_tool"
    GEN_AI_AGENT_AUID_KEY: "microsoft.agent.user.id"
    GEN_AI_AGENT_BLUEPRINT_ID_KEY: "microsoft.a365.agent.blueprint.id"
    GEN_AI_AGENT_DESCRIPTION_KEY: "gen_ai.agent.description"
    GEN_AI_AGENT_EMAIL_KEY: "microsoft.agent.user.email"
    GEN_AI_AGENT_ID_KEY: "gen_ai.agent.id"
    GEN_AI_AGENT_NAME_KEY: "gen_ai.agent.name"
    GEN_AI_AGENT_PLATFORM_ID_KEY: "microsoft.a365.agent.platform.id"
    GEN_AI_AGENT_THOUGHT_PROCESS_KEY: "microsoft.a365.agent.thought.process"
    GEN_AI_AGENT_VERSION_KEY: "gen_ai.agent.version"
    GEN_AI_CALLER_AGENT_APPLICATION_ID_KEY: "microsoft.a365.caller.agent.blueprint.id"
    GEN_AI_CALLER_AGENT_EMAIL_KEY: "microsoft.a365.caller.agent.user.email"
    GEN_AI_CALLER_AGENT_ID_KEY: "microsoft.a365.caller.agent.id"
    GEN_AI_CALLER_AGENT_NAME_KEY: "microsoft.a365.caller.agent.name"
    GEN_AI_CALLER_AGENT_PLATFORM_ID_KEY: "microsoft.a365.caller.agent.platform.id"
    GEN_AI_CALLER_AGENT_USER_ID_KEY: "microsoft.a365.caller.agent.user.id"
    GEN_AI_CALLER_AGENT_VERSION_KEY: "microsoft.a365.caller.agent.version"
    GEN_AI_CALLER_CLIENT_IP_KEY: "client.address"
    GEN_AI_CHOICE: "gen_ai.choice"
    GEN_AI_CLIENT_OPERATION_DURATION_METRIC_NAME: "gen_ai.client.operation.duration"
    GEN_AI_CLIENT_TOKEN_USAGE_METRIC_NAME: "gen_ai.client.token.usage"
    GEN_AI_CONVERSATION_ID_KEY: "gen_ai.conversation.id"
    GEN_AI_CONVERSATION_ITEM_LINK_KEY: "microsoft.conversation.item.link"
    GEN_AI_EXECUTION_PAYLOAD_KEY: "gen_ai.execution.payload"
    GEN_AI_ICON_URI_KEY: "gen_ai.agent365.icon_uri"
    GEN_AI_INPUT_MESSAGES_KEY: "gen_ai.input.messages"
    GEN_AI_OPERATION_NAME_KEY: "gen_ai.operation.name"
    GEN_AI_OUTPUT_MESSAGES_KEY: "gen_ai.output.messages"
    GEN_AI_PROVIDER_NAME_KEY: "gen_ai.provider.name"
    GEN_AI_REQUEST_MAX_TOKENS_KEY: "gen_ai.request.max_tokens"
    GEN_AI_REQUEST_MODEL_KEY: "gen_ai.request.model"
    GEN_AI_REQUEST_TEMPERATURE_KEY: "gen_ai.request.temperature"
    GEN_AI_REQUEST_TOP_P_KEY: "gen_ai.request.top_p"
    GEN_AI_RESPONSE_FINISH_REASONS_KEY: "gen_ai.response.finish_reasons"
    GEN_AI_RESPONSE_MODEL_KEY: "gen_ai.response.model"
    GEN_AI_SYSTEM_INSTRUCTIONS_KEY: "gen_ai.system_instructions"
    GEN_AI_TASK_ID_KEY: "gen_ai.task.id"
    GEN_AI_TOOL_ARGS_KEY: "gen_ai.tool.call.arguments"
    GEN_AI_TOOL_CALL_ID_KEY: "gen_ai.tool.call.id"
    GEN_AI_TOOL_CALL_RESULT_KEY: "gen_ai.tool.call.result"
    GEN_AI_TOOL_DESCRIPTION_KEY: "gen_ai.tool.description"
    GEN_AI_TOOL_NAME_KEY: "gen_ai.tool.name"
    GEN_AI_TOOL_TYPE_KEY: "gen_ai.tool.type"
    GEN_AI_USAGE_INPUT_TOKENS_KEY: "gen_ai.usage.input_tokens"
    GEN_AI_USAGE_OUTPUT_TOKENS_KEY: "gen_ai.usage.output_tokens"
    INVOKE_AGENT_OPERATION_NAME: "invoke_agent"
    OUTPUT_MESSAGES_OPERATION_NAME: "output_messages"
    SERVER_ADDRESS_KEY: "server.address"
    SERVER_PORT_KEY: "server.port"
    SERVICE_NAME_KEY: "service.name"
    SESSION_DESCRIPTION_KEY: "microsoft.session.description"
    SESSION_ID_KEY: "microsoft.session.id"
    SOURCE_NAME: "Agent365Sdk"
    TELEMETRY_SDK_LANGUAGE_KEY: "telemetry.sdk.language"
    TELEMETRY_SDK_LANGUAGE_VALUE: "nodejs"
    TELEMETRY_SDK_NAME_KEY: "telemetry.sdk.name"
    TELEMETRY_SDK_NAME_VALUE: "microsoft-opentelemetry"
    TELEMETRY_SDK_VERSION_KEY: "telemetry.sdk.version"
    TELEMETRY_SDK_VERSION_VALUE: "1.0.2" = MICROSOFT_OPENTELEMETRY_VERSION
    TENANT_ID_KEY: "microsoft.tenant.id"
    TRACE_CONTENTS_ENVIRONMENT_VARIABLE: "AZURE_TRACING_GEN_AI_CONTENT_RECORDING_ENABLED"
    TRACE_CONTENTS_SWITCH: "Azure.Experimental.TraceGenAIMessageContent"
    USER_EMAIL_KEY: "user.email"
    USER_ID_KEY: "user.id"
    USER_NAME_KEY: "user.name"

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    A365_MESSAGES_SCHEMA_VERSION_KEYAGENT_ID_KEYAZ_NAMESPACE_KEYAZURE_RP_NAMESPACE_VALUECHANNEL_LINK_KEYCHANNEL_NAME_KEYCHAT_OPERATION_NAMECUSTOM_PARENT_SPAN_ID_KEYCUSTOM_SPAN_NAME_KEYENABLE_A365_OBSERVABILITYENABLE_A365_OBSERVABILITY_EXPORTERENABLE_OBSERVABILITYENABLE_OPENTELEMETRY_SWITCHERROR_MESSAGE_KEYERROR_TYPE_CANCELLEDERROR_TYPE_KEYEXECUTE_TOOL_OPERATION_NAMEGEN_AI_AGENT_AUID_KEYGEN_AI_AGENT_BLUEPRINT_ID_KEYGEN_AI_AGENT_DESCRIPTION_KEYGEN_AI_AGENT_EMAIL_KEYGEN_AI_AGENT_ID_KEYGEN_AI_AGENT_NAME_KEYGEN_AI_AGENT_PLATFORM_ID_KEYGEN_AI_AGENT_THOUGHT_PROCESS_KEYGEN_AI_AGENT_VERSION_KEYGEN_AI_CALLER_AGENT_APPLICATION_ID_KEYGEN_AI_CALLER_AGENT_EMAIL_KEYGEN_AI_CALLER_AGENT_ID_KEYGEN_AI_CALLER_AGENT_NAME_KEYGEN_AI_CALLER_AGENT_PLATFORM_ID_KEYGEN_AI_CALLER_AGENT_USER_ID_KEYGEN_AI_CALLER_AGENT_VERSION_KEYGEN_AI_CALLER_CLIENT_IP_KEYGEN_AI_CHOICEGEN_AI_CLIENT_OPERATION_DURATION_METRIC_NAMEGEN_AI_CLIENT_TOKEN_USAGE_METRIC_NAMEGEN_AI_CONVERSATION_ID_KEYGEN_AI_CONVERSATION_ITEM_LINK_KEYGEN_AI_EXECUTION_PAYLOAD_KEYGEN_AI_ICON_URI_KEYGEN_AI_INPUT_MESSAGES_KEYGEN_AI_OPERATION_NAME_KEYGEN_AI_OUTPUT_MESSAGES_KEYGEN_AI_PROVIDER_NAME_KEYGEN_AI_REQUEST_MAX_TOKENS_KEYGEN_AI_REQUEST_MODEL_KEYGEN_AI_REQUEST_TEMPERATURE_KEYGEN_AI_REQUEST_TOP_P_KEYGEN_AI_RESPONSE_FINISH_REASONS_KEYGEN_AI_RESPONSE_MODEL_KEYGEN_AI_SYSTEM_INSTRUCTIONS_KEYGEN_AI_TASK_ID_KEYGEN_AI_TOOL_ARGS_KEYGEN_AI_TOOL_CALL_ID_KEYGEN_AI_TOOL_CALL_RESULT_KEYGEN_AI_TOOL_DESCRIPTION_KEYGEN_AI_TOOL_NAME_KEYGEN_AI_TOOL_TYPE_KEYGEN_AI_USAGE_INPUT_TOKENS_KEYGEN_AI_USAGE_OUTPUT_TOKENS_KEYINVOKE_AGENT_OPERATION_NAMEOUTPUT_MESSAGES_OPERATION_NAMESERVER_ADDRESS_KEYSERVER_PORT_KEYSERVICE_NAME_KEYSESSION_DESCRIPTION_KEYSESSION_ID_KEYSOURCE_NAMETELEMETRY_SDK_LANGUAGE_KEYTELEMETRY_SDK_LANGUAGE_VALUETELEMETRY_SDK_NAME_KEYTELEMETRY_SDK_NAME_VALUETELEMETRY_SDK_VERSION_KEYTELEMETRY_SDK_VERSION_VALUETENANT_ID_KEYTRACE_CONTENTS_ENVIRONMENT_VARIABLETRACE_CONTENTS_SWITCHUSER_EMAIL_KEYUSER_ID_KEYUSER_NAME_KEY