Share via


OpenTelemetryConstants class

OpenTelemetry constants for Agent 365

Properties

A365_MESSAGES_SCHEMA_VERSION_KEY
AGENT_ID_KEY
AZURE_RP_NAMESPACE_VALUE
AZ_NAMESPACE_KEY
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_A365_OBSERVABILITY_PER_REQUEST_EXPORT
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_TOKEN_TYPE_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

Property Details

A365_MESSAGES_SCHEMA_VERSION_KEY

static A365_MESSAGES_SCHEMA_VERSION_KEY: "microsoft.a365.messages.schema_version" = "microsoft.a365.messages.schema_version"

Property Value

string

AGENT_ID_KEY

static AGENT_ID_KEY: "gen_ai.agent.id" = "gen_ai.agent.id"

Property Value

string

AZURE_RP_NAMESPACE_VALUE

static AZURE_RP_NAMESPACE_VALUE: "Microsoft.CognitiveServices" = "Microsoft.CognitiveServices"

Property Value

string

AZ_NAMESPACE_KEY

static AZ_NAMESPACE_KEY: "az.namespace" = "az.namespace"

Property Value

string

static CHANNEL_LINK_KEY: "microsoft.channel.link" = "microsoft.channel.link"

Property Value

string

CHANNEL_NAME_KEY

static CHANNEL_NAME_KEY: "microsoft.channel.name" = "microsoft.channel.name"

Property Value

string

CHAT_OPERATION_NAME

static CHAT_OPERATION_NAME: "chat" = "chat"

Property Value

"chat"

CUSTOM_PARENT_SPAN_ID_KEY

static CUSTOM_PARENT_SPAN_ID_KEY: "custom.parent.span.id" = "custom.parent.span.id"

Property Value

string

CUSTOM_SPAN_NAME_KEY

static CUSTOM_SPAN_NAME_KEY: "custom.span.name" = "custom.span.name"

Property Value

string

ENABLE_A365_OBSERVABILITY

static ENABLE_A365_OBSERVABILITY: "ENABLE_A365_OBSERVABILITY" = "ENABLE_A365_OBSERVABILITY"

Property Value

string

ENABLE_A365_OBSERVABILITY_EXPORTER

static ENABLE_A365_OBSERVABILITY_EXPORTER: "ENABLE_A365_OBSERVABILITY_EXPORTER" = "ENABLE_A365_OBSERVABILITY_EXPORTER"

Property Value

"ENABLE_A365_OBSERVABILITY_EXPORTER"

ENABLE_A365_OBSERVABILITY_PER_REQUEST_EXPORT

static ENABLE_A365_OBSERVABILITY_PER_REQUEST_EXPORT: "ENABLE_A365_OBSERVABILITY_PER_REQUEST_EXPORT" = "ENABLE_A365_OBSERVABILITY_PER_REQUEST_EXPORT"

Property Value

"ENABLE_A365_OBSERVABILITY_PER_REQUEST_EXPORT"

ENABLE_OBSERVABILITY

static ENABLE_OBSERVABILITY: "ENABLE_OBSERVABILITY" = "ENABLE_OBSERVABILITY"

Property Value

"ENABLE_OBSERVABILITY"

ENABLE_OPENTELEMETRY_SWITCH

static ENABLE_OPENTELEMETRY_SWITCH: "Azure.Experimental.EnableActivitySource" = "Azure.Experimental.EnableActivitySource"

Property Value

string

ERROR_MESSAGE_KEY

static ERROR_MESSAGE_KEY: "error.message" = "error.message"

Property Value

string

ERROR_TYPE_CANCELLED

static ERROR_TYPE_CANCELLED: "TaskCanceledException" = "TaskCanceledException"

Property Value

"TaskCanceledException"

ERROR_TYPE_KEY

static ERROR_TYPE_KEY: "error.type" = "error.type"

Property Value

string

EXECUTE_TOOL_OPERATION_NAME

static EXECUTE_TOOL_OPERATION_NAME: "execute_tool" = "execute_tool"

Property Value

"execute_tool"

GEN_AI_AGENT_AUID_KEY

static GEN_AI_AGENT_AUID_KEY: "microsoft.agent.user.id" = "microsoft.agent.user.id"

Property Value

string

GEN_AI_AGENT_BLUEPRINT_ID_KEY

static GEN_AI_AGENT_BLUEPRINT_ID_KEY: "microsoft.a365.agent.blueprint.id" = "microsoft.a365.agent.blueprint.id"

Property Value

string

GEN_AI_AGENT_DESCRIPTION_KEY

static GEN_AI_AGENT_DESCRIPTION_KEY: "gen_ai.agent.description" = "gen_ai.agent.description"

Property Value

string

GEN_AI_AGENT_EMAIL_KEY

static GEN_AI_AGENT_EMAIL_KEY: "microsoft.agent.user.email" = "microsoft.agent.user.email"

Property Value

string

GEN_AI_AGENT_ID_KEY

static GEN_AI_AGENT_ID_KEY: "gen_ai.agent.id" = "gen_ai.agent.id"

Property Value

string

GEN_AI_AGENT_NAME_KEY

static GEN_AI_AGENT_NAME_KEY: "gen_ai.agent.name" = "gen_ai.agent.name"

Property Value

string

GEN_AI_AGENT_PLATFORM_ID_KEY

static GEN_AI_AGENT_PLATFORM_ID_KEY: "microsoft.a365.agent.platform.id" = "microsoft.a365.agent.platform.id"

Property Value

string

GEN_AI_AGENT_THOUGHT_PROCESS_KEY

static GEN_AI_AGENT_THOUGHT_PROCESS_KEY: "microsoft.a365.agent.thought.process" = "microsoft.a365.agent.thought.process"

Property Value

string

GEN_AI_AGENT_VERSION_KEY

static GEN_AI_AGENT_VERSION_KEY: "gen_ai.agent.version" = "gen_ai.agent.version"

Property Value

string

GEN_AI_CALLER_AGENT_APPLICATION_ID_KEY

static GEN_AI_CALLER_AGENT_APPLICATION_ID_KEY: "microsoft.a365.caller.agent.blueprint.id" = "microsoft.a365.caller.agent.blueprint.id"

Property Value

string

GEN_AI_CALLER_AGENT_EMAIL_KEY

static GEN_AI_CALLER_AGENT_EMAIL_KEY: "microsoft.a365.caller.agent.user.email" = "microsoft.a365.caller.agent.user.email"

Property Value

string

GEN_AI_CALLER_AGENT_ID_KEY

static GEN_AI_CALLER_AGENT_ID_KEY: "microsoft.a365.caller.agent.id" = "microsoft.a365.caller.agent.id"

Property Value

string

GEN_AI_CALLER_AGENT_NAME_KEY

static GEN_AI_CALLER_AGENT_NAME_KEY: "microsoft.a365.caller.agent.name" = "microsoft.a365.caller.agent.name"

Property Value

string

GEN_AI_CALLER_AGENT_PLATFORM_ID_KEY

static GEN_AI_CALLER_AGENT_PLATFORM_ID_KEY: "microsoft.a365.caller.agent.platform.id" = "microsoft.a365.caller.agent.platform.id"

Property Value

string

GEN_AI_CALLER_AGENT_USER_ID_KEY

static GEN_AI_CALLER_AGENT_USER_ID_KEY: "microsoft.a365.caller.agent.user.id" = "microsoft.a365.caller.agent.user.id"

Property Value

string

GEN_AI_CALLER_AGENT_VERSION_KEY

static GEN_AI_CALLER_AGENT_VERSION_KEY: "microsoft.a365.caller.agent.version" = "microsoft.a365.caller.agent.version"

Property Value

string

GEN_AI_CALLER_CLIENT_IP_KEY

static GEN_AI_CALLER_CLIENT_IP_KEY: "client.address" = "client.address"

Property Value

string

GEN_AI_CHOICE

static GEN_AI_CHOICE: "gen_ai.choice" = "gen_ai.choice"

Property Value

string

GEN_AI_CLIENT_OPERATION_DURATION_METRIC_NAME

static GEN_AI_CLIENT_OPERATION_DURATION_METRIC_NAME: "gen_ai.client.operation.duration" = "gen_ai.client.operation.duration"

Property Value

string

GEN_AI_CLIENT_TOKEN_USAGE_METRIC_NAME

static GEN_AI_CLIENT_TOKEN_USAGE_METRIC_NAME: "gen_ai.client.token.usage" = "gen_ai.client.token.usage"

Property Value

string

GEN_AI_CONVERSATION_ID_KEY

static GEN_AI_CONVERSATION_ID_KEY: "gen_ai.conversation.id" = "gen_ai.conversation.id"

Property Value

string

static GEN_AI_CONVERSATION_ITEM_LINK_KEY: "microsoft.conversation.item.link" = "microsoft.conversation.item.link"

Property Value

string

GEN_AI_EXECUTION_PAYLOAD_KEY

static GEN_AI_EXECUTION_PAYLOAD_KEY: "gen_ai.execution.payload" = "gen_ai.execution.payload"

Property Value

string

GEN_AI_ICON_URI_KEY

static GEN_AI_ICON_URI_KEY: "gen_ai.agent365.icon_uri" = "gen_ai.agent365.icon_uri"

Property Value

string

GEN_AI_INPUT_MESSAGES_KEY

static GEN_AI_INPUT_MESSAGES_KEY: "gen_ai.input.messages" = "gen_ai.input.messages"

Property Value

string

GEN_AI_OPERATION_NAME_KEY

static GEN_AI_OPERATION_NAME_KEY: "gen_ai.operation.name" = "gen_ai.operation.name"

Property Value

string

GEN_AI_OUTPUT_MESSAGES_KEY

static GEN_AI_OUTPUT_MESSAGES_KEY: "gen_ai.output.messages" = "gen_ai.output.messages"

Property Value

string

GEN_AI_PROVIDER_NAME_KEY

static GEN_AI_PROVIDER_NAME_KEY: "gen_ai.provider.name" = "gen_ai.provider.name"

Property Value

string

GEN_AI_REQUEST_MAX_TOKENS_KEY

static GEN_AI_REQUEST_MAX_TOKENS_KEY: "gen_ai.request.max_tokens" = "gen_ai.request.max_tokens"

Property Value

string

GEN_AI_REQUEST_MODEL_KEY

static GEN_AI_REQUEST_MODEL_KEY: "gen_ai.request.model" = "gen_ai.request.model"

Property Value

string

GEN_AI_REQUEST_TEMPERATURE_KEY

static GEN_AI_REQUEST_TEMPERATURE_KEY: "gen_ai.request.temperature" = "gen_ai.request.temperature"

Property Value

string

GEN_AI_REQUEST_TOP_P_KEY

static GEN_AI_REQUEST_TOP_P_KEY: "gen_ai.request.top_p" = "gen_ai.request.top_p"

Property Value

string

GEN_AI_RESPONSE_FINISH_REASONS_KEY

static GEN_AI_RESPONSE_FINISH_REASONS_KEY: "gen_ai.response.finish_reasons" = "gen_ai.response.finish_reasons"

Property Value

string

GEN_AI_RESPONSE_MODEL_KEY

static GEN_AI_RESPONSE_MODEL_KEY: "gen_ai.response.model" = "gen_ai.response.model"

Property Value

string

GEN_AI_SYSTEM_INSTRUCTIONS_KEY

static GEN_AI_SYSTEM_INSTRUCTIONS_KEY: "gen_ai.system_instructions" = "gen_ai.system_instructions"

Property Value

string

GEN_AI_TASK_ID_KEY

static GEN_AI_TASK_ID_KEY: "gen_ai.task.id" = "gen_ai.task.id"

Property Value

string

GEN_AI_TOKEN_TYPE_KEY

static GEN_AI_TOKEN_TYPE_KEY: "gen_ai.token.type" = "gen_ai.token.type"

Property Value

string

GEN_AI_TOOL_ARGS_KEY

static GEN_AI_TOOL_ARGS_KEY: "gen_ai.tool.call.arguments" = "gen_ai.tool.call.arguments"

Property Value

string

GEN_AI_TOOL_CALL_ID_KEY

static GEN_AI_TOOL_CALL_ID_KEY: "gen_ai.tool.call.id" = "gen_ai.tool.call.id"

Property Value

string

GEN_AI_TOOL_CALL_RESULT_KEY

static GEN_AI_TOOL_CALL_RESULT_KEY: "gen_ai.tool.call.result" = "gen_ai.tool.call.result"

Property Value

string

GEN_AI_TOOL_DESCRIPTION_KEY

static GEN_AI_TOOL_DESCRIPTION_KEY: "gen_ai.tool.description" = "gen_ai.tool.description"

Property Value

string

GEN_AI_TOOL_NAME_KEY

static GEN_AI_TOOL_NAME_KEY: "gen_ai.tool.name" = "gen_ai.tool.name"

Property Value

string

GEN_AI_TOOL_TYPE_KEY

static GEN_AI_TOOL_TYPE_KEY: "gen_ai.tool.type" = "gen_ai.tool.type"

Property Value

string

GEN_AI_USAGE_INPUT_TOKENS_KEY

static GEN_AI_USAGE_INPUT_TOKENS_KEY: "gen_ai.usage.input_tokens" = "gen_ai.usage.input_tokens"

Property Value

string

GEN_AI_USAGE_OUTPUT_TOKENS_KEY

static GEN_AI_USAGE_OUTPUT_TOKENS_KEY: "gen_ai.usage.output_tokens" = "gen_ai.usage.output_tokens"

Property Value

string

INVOKE_AGENT_OPERATION_NAME

static INVOKE_AGENT_OPERATION_NAME: "invoke_agent" = "invoke_agent"

Property Value

"invoke_agent"

OUTPUT_MESSAGES_OPERATION_NAME

static OUTPUT_MESSAGES_OPERATION_NAME: "output_messages" = "output_messages"

Property Value

"output_messages"

SERVER_ADDRESS_KEY

static SERVER_ADDRESS_KEY: "server.address" = "server.address"

Property Value

string

SERVER_PORT_KEY

static SERVER_PORT_KEY: "server.port" = "server.port"

Property Value

string

SERVICE_NAME_KEY

static SERVICE_NAME_KEY: "service.name" = "service.name"

Property Value

string

SESSION_DESCRIPTION_KEY

static SESSION_DESCRIPTION_KEY: "microsoft.session.description" = "microsoft.session.description"

Property Value

string

SESSION_ID_KEY

static SESSION_ID_KEY: "microsoft.session.id" = "microsoft.session.id"

Property Value

string

SOURCE_NAME

static SOURCE_NAME: "Agent365Sdk" = "Agent365Sdk"

Property Value

"Agent365Sdk"

TELEMETRY_SDK_LANGUAGE_KEY

static TELEMETRY_SDK_LANGUAGE_KEY: "telemetry.sdk.language" = "telemetry.sdk.language"

Property Value

string

TELEMETRY_SDK_LANGUAGE_VALUE

static TELEMETRY_SDK_LANGUAGE_VALUE: "nodejs" = "nodejs"

Property Value

"nodejs"

TELEMETRY_SDK_NAME_KEY

static TELEMETRY_SDK_NAME_KEY: "telemetry.sdk.name" = "telemetry.sdk.name"

Property Value

string

TELEMETRY_SDK_NAME_VALUE

static TELEMETRY_SDK_NAME_VALUE: "A365ObservabilitySDK" = "A365ObservabilitySDK"

Property Value

"A365ObservabilitySDK"

TELEMETRY_SDK_VERSION_KEY

static TELEMETRY_SDK_VERSION_KEY: "telemetry.sdk.version" = "telemetry.sdk.version"

Property Value

string

TELEMETRY_SDK_VERSION_VALUE

static TELEMETRY_SDK_VERSION_VALUE: "0.1.0-preview.129" = "0.1.0-preview.129"

Property Value

string

TENANT_ID_KEY

static TENANT_ID_KEY: "microsoft.tenant.id" = "microsoft.tenant.id"

Property Value

string

TRACE_CONTENTS_ENVIRONMENT_VARIABLE

static TRACE_CONTENTS_ENVIRONMENT_VARIABLE: "AZURE_TRACING_GEN_AI_CONTENT_RECORDING_ENABLED" = "AZURE_TRACING_GEN_AI_CONTENT_RECORDING_ENABLED"

Property Value

"AZURE_TRACING_GEN_AI_CONTENT_RECORDING_ENABLED"

TRACE_CONTENTS_SWITCH

static TRACE_CONTENTS_SWITCH: "Azure.Experimental.TraceGenAIMessageContent" = "Azure.Experimental.TraceGenAIMessageContent"

Property Value

string

USER_EMAIL_KEY

static USER_EMAIL_KEY: "user.email" = "user.email"

Property Value

string

USER_ID_KEY

static USER_ID_KEY: "user.id" = "user.id"

Property Value

string

USER_NAME_KEY

static USER_NAME_KEY: "user.name" = "user.name"

Property Value

string