OpenTelemetryConstants class

Package:

@microsoft/opentelemetry

OpenTelemetry constants for A365 observability.

Provides the well-known span operation names, attribute keys, metric names, environment-variable names, and feature-flag switches used when emitting A365 telemetry. 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

Properties

A365_MESSAGES_SCHEMA_VERSION_KEY	Attribute key for the A365 messages schema version.
AGENT_ID_KEY	Attribute key for the agent identifier (alias of GEN_AI_AGENT_ID_KEY).
APPLY_GUARDRAIL_OPERATION_NAME	Operation name used for guardrail-evaluation spans.
AZURE_RP_NAMESPACE_VALUE	Azure resource provider namespace value for Cognitive Services.
AZ_NAMESPACE_KEY	Attribute key for the Azure resource provider namespace (az.namespace).
CHANNEL_LINK_KEY	Attribute key for the channel link/description (microsoft.channel.link).
CHANNEL_NAME_KEY	Attribute key for the channel name (microsoft.channel.name).
CHAT_OPERATION_NAME	Operation name used for model chat/inference spans.
CUSTOM_PARENT_SPAN_ID_KEY	Attribute key for a custom parent span identifier (custom.parent.span.id).
CUSTOM_SPAN_NAME_KEY	Attribute key for a custom span name (custom.span.name).
ENABLE_A365_OBSERVABILITY	Environment-variable name that enables A365 observability.
ENABLE_A365_OBSERVABILITY_EXPORTER	Environment-variable name that enables the A365 observability exporter.
ENABLE_OBSERVABILITY	Environment-variable name that enables observability.
ENABLE_OPENTELEMETRY_SWITCH	Feature-switch name that enables the experimental activity source.
ERROR_MESSAGE_KEY	Attribute key for a human-readable error message (error.message).
ERROR_TYPE_CANCELLED	Error-type value used when an operation was cancelled.
ERROR_TYPE_KEY	Attribute key for the error type recorded on a span (error.type).
EXECUTE_TOOL_OPERATION_NAME	Operation name used for tool-execution spans.
GEN_AI_AGENT_AUID_KEY	Attribute/baggage key for the agentic user identifier (microsoft.agent.user.id).
GEN_AI_AGENT_BLUEPRINT_ID_KEY	Attribute/baggage key for the agent blueprint identifier (microsoft.a365.agent.blueprint.id).
GEN_AI_AGENT_DESCRIPTION_KEY	Attribute key for the agent description (gen_ai.agent.description).
GEN_AI_AGENT_EMAIL_KEY	Attribute/baggage key for the agentic user email (microsoft.agent.user.email).
GEN_AI_AGENT_ID_KEY	Attribute key for the agent identifier (gen_ai.agent.id).
GEN_AI_AGENT_NAME_KEY	Attribute key for the agent display name (gen_ai.agent.name).
GEN_AI_AGENT_PLATFORM_ID_KEY	Attribute key for the agent platform identifier (microsoft.a365.agent.platform.id).
GEN_AI_AGENT_THOUGHT_PROCESS_KEY	Attribute key for the agent thought process (microsoft.a365.agent.thought.process).
GEN_AI_AGENT_VERSION_KEY	Attribute key for the agent version (gen_ai.agent.version).
GEN_AI_CALLER_AGENT_APPLICATION_ID_KEY	Attribute key for the calling agent's blueprint (application) identifier.
GEN_AI_CALLER_AGENT_EMAIL_KEY	Attribute key for the calling agent's agentic user email.
GEN_AI_CALLER_AGENT_ID_KEY	Attribute key for the calling agent's identifier.
GEN_AI_CALLER_AGENT_NAME_KEY	Attribute key for the calling agent's name.
GEN_AI_CALLER_AGENT_PLATFORM_ID_KEY	Attribute key for the calling agent's platform identifier.
GEN_AI_CALLER_AGENT_USER_ID_KEY	Attribute key for the calling agent's agentic user identifier.
GEN_AI_CALLER_AGENT_VERSION_KEY	Attribute key for the calling agent's version.
GEN_AI_CALLER_CLIENT_IP_KEY	Attribute key for the caller client IP address (client.address).
GEN_AI_CHOICE	Attribute key for a gen-ai choice (gen_ai.choice).
GEN_AI_CLIENT_OPERATION_DURATION_METRIC_NAME	Metric name for the gen-ai client operation duration.
GEN_AI_CLIENT_TOKEN_USAGE_METRIC_NAME	Metric name for gen-ai client token usage.
GEN_AI_CONVERSATION_ID_KEY	Attribute key for the conversation identifier (gen_ai.conversation.id).
GEN_AI_CONVERSATION_ITEM_LINK_KEY	Attribute key for the conversation item deep link (microsoft.conversation.item.link).
GEN_AI_EXECUTION_PAYLOAD_KEY	Attribute key for the execution payload (gen_ai.execution.payload).
GEN_AI_ICON_URI_KEY	Attribute key for the agent icon URI (gen_ai.agent365.icon_uri).
GEN_AI_INPUT_MESSAGES_KEY	Attribute key for the serialized input messages (gen_ai.input.messages).
GEN_AI_OPERATION_NAME_KEY	Attribute key for the gen-ai operation name (gen_ai.operation.name).
GEN_AI_OUTPUT_MESSAGES_KEY	Attribute key for the serialized output messages (gen_ai.output.messages).
GEN_AI_PROVIDER_NAME_KEY	Attribute key for the gen-ai provider name (gen_ai.provider.name).
GEN_AI_REQUEST_MAX_TOKENS_KEY	Attribute key for the requested maximum number of tokens (gen_ai.request.max_tokens).
GEN_AI_REQUEST_MODEL_KEY	Attribute key for the requested model name (gen_ai.request.model).
GEN_AI_REQUEST_TEMPERATURE_KEY	Attribute key for the sampling temperature (gen_ai.request.temperature).
GEN_AI_REQUEST_TOP_P_KEY	Attribute key for the nucleus-sampling top-p value (gen_ai.request.top_p).
GEN_AI_RESPONSE_FINISH_REASONS_KEY	Attribute key for the finish reasons returned by the model (gen_ai.response.finish_reasons).
GEN_AI_RESPONSE_MODEL_KEY	Attribute key for the model that produced the response (gen_ai.response.model).
GEN_AI_SYSTEM_INSTRUCTIONS_KEY	Attribute key for the system instructions (gen_ai.system_instructions).
GEN_AI_TASK_ID_KEY	Attribute key for the task identifier (gen_ai.task.id).
GEN_AI_TOOL_ARGS_KEY	Attribute key for the serialized tool-call arguments (gen_ai.tool.call.arguments).
GEN_AI_TOOL_CALL_ID_KEY	Attribute key for the tool-call identifier (gen_ai.tool.call.id).
GEN_AI_TOOL_CALL_RESULT_KEY	Attribute key for the tool-call result (gen_ai.tool.call.result).
GEN_AI_TOOL_DESCRIPTION_KEY	Attribute key for the tool description (gen_ai.tool.description).
GEN_AI_TOOL_NAME_KEY	Attribute key for the tool name (gen_ai.tool.name).
GEN_AI_TOOL_TYPE_KEY	Attribute key for the tool type (gen_ai.tool.type).
GEN_AI_USAGE_INPUT_TOKENS_KEY	Attribute key for the number of input (prompt) tokens (gen_ai.usage.input_tokens).
GEN_AI_USAGE_OUTPUT_TOKENS_KEY	Attribute key for the number of output (completion) tokens (gen_ai.usage.output_tokens).
GUARDIAN_ID_KEY	Attribute key for the guardian identifier (microsoft.guardian.id).
GUARDIAN_NAME_KEY	Attribute key for the guardian name (microsoft.guardian.name).
GUARDIAN_PROVIDER_NAME_KEY	Attribute key for the guardian provider name (microsoft.guardian.provider.name).
GUARDIAN_VERSION_KEY	Attribute key for the guardian version (microsoft.guardian.version).
INVOKE_AGENT_OPERATION_NAME	Operation name (gen_ai.operation.name) used for agent invocation spans.
OUTPUT_MESSAGES_OPERATION_NAME	Operation name used for output-message spans.
SECURITY_CONTENT_INPUT_HASH_KEY	Attribute key for the hash of guarded input content (microsoft.security.content.input.hash).
SECURITY_CONTENT_INPUT_VALUE_KEY	Attribute key for the guarded input content value (microsoft.security.content.input.value).
SECURITY_CONTENT_MODIFIED_KEY	Attribute key indicating whether guarded content was modified (microsoft.security.content.modified).
SECURITY_CONTENT_OUTPUT_VALUE_KEY	Attribute key for the guarded output content value (microsoft.security.content.output.value).
SECURITY_DECISION_CODE_KEY	Attribute key for the guardrail decision code (microsoft.security.decision.code).
SECURITY_DECISION_REASON_KEY	Attribute key for the guardrail decision reason (microsoft.security.decision.reason).
SECURITY_DECISION_TYPE_KEY	Attribute key for the guardrail decision type (microsoft.security.decision.type).
SECURITY_EXTERNAL_EVENT_ID_KEY	Attribute key for an external correlation identifier for SIEM systems (microsoft.security.external_event_id).
SECURITY_FINDING_EVENT_NAME	Event name emitted for a security finding (microsoft.security.finding).
SECURITY_POLICY_DECISION_TYPE_KEY	Attribute key for the security policy decision type (microsoft.security.policy.decision.type).
SECURITY_POLICY_ID_KEY	Attribute key for the security policy identifier (microsoft.security.policy.id).
SECURITY_POLICY_NAME_KEY	Attribute key for the security policy name (microsoft.security.policy.name).
SECURITY_POLICY_VERSION_KEY	Attribute key for the security policy version (microsoft.security.policy.version).
SECURITY_RISK_CATEGORY_KEY	Attribute key for the detected risk category (microsoft.security.risk.category).
SECURITY_RISK_METADATA_KEY	Attribute key for non-content risk metadata (microsoft.security.risk.metadata).
SECURITY_RISK_SCORE_KEY	Attribute key for the numeric risk score (microsoft.security.risk.score).
SECURITY_RISK_SEVERITY_KEY	Attribute key for the detected risk severity (microsoft.security.risk.severity).
SECURITY_TARGET_ID_KEY	Attribute key for the guardrail target identifier (microsoft.security.target.id).
SECURITY_TARGET_TYPE_KEY	Attribute key for the guardrail target type (microsoft.security.target.type).
SERVER_ADDRESS_KEY	Attribute key for the destination server host name (server.address).
SERVER_PORT_KEY	Attribute key for the destination server port (server.port).
SERVICE_NAME_KEY	Attribute key for the service name (service.name).
SESSION_DESCRIPTION_KEY	Attribute key for the session description (microsoft.session.description).
SESSION_ID_KEY	Attribute key for the session identifier (microsoft.session.id).
SOURCE_NAME	Tracer/instrumentation-scope name used for all A365 spans.
TELEMETRY_SDK_LANGUAGE_KEY	Attribute key for the telemetry SDK language (telemetry.sdk.language).
TELEMETRY_SDK_LANGUAGE_VALUE	Telemetry SDK language value reported by this distro.
TELEMETRY_SDK_NAME_KEY	Attribute key for the telemetry SDK name (telemetry.sdk.name).
TELEMETRY_SDK_NAME_VALUE	Telemetry SDK name value reported by this distro.
TELEMETRY_SDK_VERSION_KEY	Attribute key for the telemetry SDK version (telemetry.sdk.version).
TELEMETRY_SDK_VERSION_VALUE	Telemetry SDK version value reported by this distro.
TENANT_ID_KEY	Attribute key for the tenant identifier (microsoft.tenant.id).
TRACE_CONTENTS_ENVIRONMENT_VARIABLE	Environment-variable name that enables recording of gen-ai message content.
TRACE_CONTENTS_SWITCH	Feature-switch name that enables tracing of gen-ai message content.
USER_EMAIL_KEY	Attribute key for the user email address (user.email).
USER_ID_KEY	Attribute key for the user identifier (user.id).
USER_NAME_KEY	Attribute key for the user display name (user.name).

Property Details

A365_MESSAGES_SCHEMA_VERSION_KEY

Attribute key for the A365 messages schema version.

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

Property Value

"microsoft.a365.messages.schema_version"

AGENT_ID_KEY

Attribute key for the agent identifier (alias of GEN_AI_AGENT_ID_KEY).

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

Property Value

"gen_ai.agent.id"

APPLY_GUARDRAIL_OPERATION_NAME

Operation name used for guardrail-evaluation spans.

static APPLY_GUARDRAIL_OPERATION_NAME: "apply_guardrail" = "apply_guardrail"

Property Value

"apply_guardrail"

AZURE_RP_NAMESPACE_VALUE

Azure resource provider namespace value for Cognitive Services.

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

Property Value

"Microsoft.CognitiveServices"

AZ_NAMESPACE_KEY

Attribute key for the Azure resource provider namespace (az.namespace).

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

Property Value

"az.namespace"

CHANNEL_LINK_KEY

Attribute key for the channel link/description (microsoft.channel.link).

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

Property Value

"microsoft.channel.link"

CHANNEL_NAME_KEY

Attribute key for the channel name (microsoft.channel.name).

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

Property Value

"microsoft.channel.name"

CHAT_OPERATION_NAME

Operation name used for model chat/inference spans.

static CHAT_OPERATION_NAME: "chat" = "chat"

Property Value

"chat"

CUSTOM_PARENT_SPAN_ID_KEY

Attribute key for a custom parent span identifier (custom.parent.span.id).

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

Property Value

"custom.parent.span.id"

CUSTOM_SPAN_NAME_KEY

Attribute key for a custom span name (custom.span.name).

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

Property Value

"custom.span.name"

ENABLE_A365_OBSERVABILITY

Environment-variable name that enables A365 observability.

static ENABLE_A365_OBSERVABILITY: "ENABLE_A365_OBSERVABILITY" = "ENABLE_A365_OBSERVABILITY"

Property Value

"ENABLE_A365_OBSERVABILITY"

ENABLE_A365_OBSERVABILITY_EXPORTER

Environment-variable name that enables the A365 observability exporter.

static ENABLE_A365_OBSERVABILITY_EXPORTER: "ENABLE_A365_OBSERVABILITY_EXPORTER" = "ENABLE_A365_OBSERVABILITY_EXPORTER"

Property Value

"ENABLE_A365_OBSERVABILITY_EXPORTER"

ENABLE_OBSERVABILITY

Environment-variable name that enables observability.

static ENABLE_OBSERVABILITY: "ENABLE_OBSERVABILITY" = "ENABLE_OBSERVABILITY"

Property Value

"ENABLE_OBSERVABILITY"

ENABLE_OPENTELEMETRY_SWITCH

Feature-switch name that enables the experimental activity source.

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

Property Value

"Azure.Experimental.EnableActivitySource"

ERROR_MESSAGE_KEY

Attribute key for a human-readable error message (error.message).

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

Property Value

"error.message"

ERROR_TYPE_CANCELLED

Error-type value used when an operation was cancelled.

static ERROR_TYPE_CANCELLED: "TaskCanceledException" = "TaskCanceledException"

Property Value

"TaskCanceledException"

ERROR_TYPE_KEY

Attribute key for the error type recorded on a span (error.type).

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

Property Value

"error.type"

EXECUTE_TOOL_OPERATION_NAME

Operation name used for tool-execution spans.

static EXECUTE_TOOL_OPERATION_NAME: "execute_tool" = "execute_tool"

Property Value

"execute_tool"

GEN_AI_AGENT_AUID_KEY

Attribute/baggage key for the agentic user identifier (microsoft.agent.user.id).

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

Property Value

"microsoft.agent.user.id"

GEN_AI_AGENT_BLUEPRINT_ID_KEY

Attribute/baggage key for the agent blueprint identifier (microsoft.a365.agent.blueprint.id).

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

Property Value

"microsoft.a365.agent.blueprint.id"

GEN_AI_AGENT_DESCRIPTION_KEY

Attribute key for the agent description (gen_ai.agent.description).

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

Property Value

"gen_ai.agent.description"

GEN_AI_AGENT_EMAIL_KEY

Attribute/baggage key for the agentic user email (microsoft.agent.user.email).

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

Property Value

"microsoft.agent.user.email"

GEN_AI_AGENT_ID_KEY

Attribute key for the agent identifier (gen_ai.agent.id).

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

Property Value

"gen_ai.agent.id"

GEN_AI_AGENT_NAME_KEY

Attribute key for the agent display name (gen_ai.agent.name).

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

Property Value

"gen_ai.agent.name"

GEN_AI_AGENT_PLATFORM_ID_KEY

Attribute key for the agent platform identifier (microsoft.a365.agent.platform.id).

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

Property Value

"microsoft.a365.agent.platform.id"

GEN_AI_AGENT_THOUGHT_PROCESS_KEY

Attribute key for the agent thought process (microsoft.a365.agent.thought.process).

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

Property Value

"microsoft.a365.agent.thought.process"

GEN_AI_AGENT_VERSION_KEY

Attribute key for the agent version (gen_ai.agent.version).

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

Property Value

"gen_ai.agent.version"

GEN_AI_CALLER_AGENT_APPLICATION_ID_KEY

Attribute key for the calling agent's blueprint (application) identifier.

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

Property Value

"microsoft.a365.caller.agent.blueprint.id"

GEN_AI_CALLER_AGENT_EMAIL_KEY

Attribute key for the calling agent's agentic user email.

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

Property Value

"microsoft.a365.caller.agent.user.email"

GEN_AI_CALLER_AGENT_ID_KEY

Attribute key for the calling agent's identifier.

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

Property Value

"microsoft.a365.caller.agent.id"

GEN_AI_CALLER_AGENT_NAME_KEY

Attribute key for the calling agent's name.

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

Property Value

"microsoft.a365.caller.agent.name"

GEN_AI_CALLER_AGENT_PLATFORM_ID_KEY

Attribute key for the calling agent's platform identifier.

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

Property Value

"microsoft.a365.caller.agent.platform.id"

GEN_AI_CALLER_AGENT_USER_ID_KEY

Attribute key for the calling agent's agentic user identifier.

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

Property Value

"microsoft.a365.caller.agent.user.id"

GEN_AI_CALLER_AGENT_VERSION_KEY

Attribute key for the calling agent's version.

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

Property Value

"microsoft.a365.caller.agent.version"

GEN_AI_CALLER_CLIENT_IP_KEY

Attribute key for the caller client IP address (client.address).

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

Property Value

"client.address"

GEN_AI_CHOICE

Attribute key for a gen-ai choice (gen_ai.choice).

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

Property Value

"gen_ai.choice"

GEN_AI_CLIENT_OPERATION_DURATION_METRIC_NAME

Metric name for the gen-ai client operation duration.

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

Property Value

"gen_ai.client.operation.duration"

GEN_AI_CLIENT_TOKEN_USAGE_METRIC_NAME

Metric name for gen-ai client token usage.

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

Property Value

"gen_ai.client.token.usage"

GEN_AI_CONVERSATION_ID_KEY

Attribute key for the conversation identifier (gen_ai.conversation.id).

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

Property Value

"gen_ai.conversation.id"

GEN_AI_CONVERSATION_ITEM_LINK_KEY

Attribute key for the conversation item deep link (microsoft.conversation.item.link).

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

Property Value

"microsoft.conversation.item.link"

GEN_AI_EXECUTION_PAYLOAD_KEY

Attribute key for the execution payload (gen_ai.execution.payload).

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

Property Value

"gen_ai.execution.payload"

GEN_AI_ICON_URI_KEY

Attribute key for the agent icon URI (gen_ai.agent365.icon_uri).

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

Property Value

"gen_ai.agent365.icon_uri"

GEN_AI_INPUT_MESSAGES_KEY

Attribute key for the serialized input messages (gen_ai.input.messages).

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

Property Value

"gen_ai.input.messages"

GEN_AI_OPERATION_NAME_KEY

Attribute key for the gen-ai operation name (gen_ai.operation.name).

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

Property Value

"gen_ai.operation.name"

GEN_AI_OUTPUT_MESSAGES_KEY

Attribute key for the serialized output messages (gen_ai.output.messages).

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

Property Value

"gen_ai.output.messages"

GEN_AI_PROVIDER_NAME_KEY

Attribute key for the gen-ai provider name (gen_ai.provider.name).

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

Property Value

"gen_ai.provider.name"

GEN_AI_REQUEST_MAX_TOKENS_KEY

Attribute key for the requested maximum number of tokens (gen_ai.request.max_tokens).

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

Property Value

"gen_ai.request.max_tokens"

GEN_AI_REQUEST_MODEL_KEY

Attribute key for the requested model name (gen_ai.request.model).

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

Property Value

"gen_ai.request.model"

GEN_AI_REQUEST_TEMPERATURE_KEY

Attribute key for the sampling temperature (gen_ai.request.temperature).

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

Property Value

"gen_ai.request.temperature"

GEN_AI_REQUEST_TOP_P_KEY

Attribute key for the nucleus-sampling top-p value (gen_ai.request.top_p).

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

Property Value

"gen_ai.request.top_p"

GEN_AI_RESPONSE_FINISH_REASONS_KEY

Attribute key for the finish reasons returned by the model (gen_ai.response.finish_reasons).

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

Property Value

"gen_ai.response.finish_reasons"

GEN_AI_RESPONSE_MODEL_KEY

Attribute key for the model that produced the response (gen_ai.response.model).

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

Property Value

"gen_ai.response.model"

GEN_AI_SYSTEM_INSTRUCTIONS_KEY

Attribute key for the system instructions (gen_ai.system_instructions).

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

Property Value

"gen_ai.system_instructions"

GEN_AI_TASK_ID_KEY

Attribute key for the task identifier (gen_ai.task.id).

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

Property Value

"gen_ai.task.id"

GEN_AI_TOOL_ARGS_KEY

Attribute key for the serialized tool-call arguments (gen_ai.tool.call.arguments).

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

Property Value

"gen_ai.tool.call.arguments"

GEN_AI_TOOL_CALL_ID_KEY

Attribute key for the tool-call identifier (gen_ai.tool.call.id).

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

Property Value

"gen_ai.tool.call.id"

GEN_AI_TOOL_CALL_RESULT_KEY

Attribute key for the tool-call result (gen_ai.tool.call.result).

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

Property Value

"gen_ai.tool.call.result"

GEN_AI_TOOL_DESCRIPTION_KEY

Attribute key for the tool description (gen_ai.tool.description).

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

Property Value

"gen_ai.tool.description"

GEN_AI_TOOL_NAME_KEY

Attribute key for the tool name (gen_ai.tool.name).

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

Property Value

"gen_ai.tool.name"

GEN_AI_TOOL_TYPE_KEY

Attribute key for the tool type (gen_ai.tool.type).

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

Property Value

"gen_ai.tool.type"

GEN_AI_USAGE_INPUT_TOKENS_KEY

Attribute key for the number of input (prompt) tokens (gen_ai.usage.input_tokens).

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

Property Value

"gen_ai.usage.input_tokens"

GEN_AI_USAGE_OUTPUT_TOKENS_KEY

Attribute key for the number of output (completion) tokens (gen_ai.usage.output_tokens).

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

Property Value

"gen_ai.usage.output_tokens"

GUARDIAN_ID_KEY

Attribute key for the guardian identifier (microsoft.guardian.id).

static GUARDIAN_ID_KEY: "microsoft.guardian.id" = "microsoft.guardian.id"

Property Value

"microsoft.guardian.id"

GUARDIAN_NAME_KEY

Attribute key for the guardian name (microsoft.guardian.name).

static GUARDIAN_NAME_KEY: "microsoft.guardian.name" = "microsoft.guardian.name"

Property Value

"microsoft.guardian.name"

GUARDIAN_PROVIDER_NAME_KEY

Attribute key for the guardian provider name (microsoft.guardian.provider.name).

static GUARDIAN_PROVIDER_NAME_KEY: "microsoft.guardian.provider.name" = "microsoft.guardian.provider.name"

Property Value

"microsoft.guardian.provider.name"

GUARDIAN_VERSION_KEY

Attribute key for the guardian version (microsoft.guardian.version).

static GUARDIAN_VERSION_KEY: "microsoft.guardian.version" = "microsoft.guardian.version"

Property Value

"microsoft.guardian.version"

INVOKE_AGENT_OPERATION_NAME

Operation name (gen_ai.operation.name) used for agent invocation spans.

static INVOKE_AGENT_OPERATION_NAME: "invoke_agent" = "invoke_agent"

Property Value

"invoke_agent"

OUTPUT_MESSAGES_OPERATION_NAME

Operation name used for output-message spans.

static OUTPUT_MESSAGES_OPERATION_NAME: "output_messages" = "output_messages"

Property Value

"output_messages"

SECURITY_CONTENT_INPUT_HASH_KEY

Attribute key for the hash of guarded input content (microsoft.security.content.input.hash).

static SECURITY_CONTENT_INPUT_HASH_KEY: "microsoft.security.content.input.hash" = "microsoft.security.content.input.hash"

Property Value

"microsoft.security.content.input.hash"

SECURITY_CONTENT_INPUT_VALUE_KEY

Attribute key for the guarded input content value (microsoft.security.content.input.value).

static SECURITY_CONTENT_INPUT_VALUE_KEY: "microsoft.security.content.input.value" = "microsoft.security.content.input.value"

Property Value

"microsoft.security.content.input.value"

SECURITY_CONTENT_MODIFIED_KEY

Attribute key indicating whether guarded content was modified (microsoft.security.content.modified).

static SECURITY_CONTENT_MODIFIED_KEY: "microsoft.security.content.modified" = "microsoft.security.content.modified"

Property Value

"microsoft.security.content.modified"

SECURITY_CONTENT_OUTPUT_VALUE_KEY

Attribute key for the guarded output content value (microsoft.security.content.output.value).

static SECURITY_CONTENT_OUTPUT_VALUE_KEY: "microsoft.security.content.output.value" = "microsoft.security.content.output.value"

Property Value

"microsoft.security.content.output.value"

SECURITY_DECISION_CODE_KEY

Attribute key for the guardrail decision code (microsoft.security.decision.code).

static SECURITY_DECISION_CODE_KEY: "microsoft.security.decision.code" = "microsoft.security.decision.code"

Property Value

"microsoft.security.decision.code"

SECURITY_DECISION_REASON_KEY

Attribute key for the guardrail decision reason (microsoft.security.decision.reason).

static SECURITY_DECISION_REASON_KEY: "microsoft.security.decision.reason" = "microsoft.security.decision.reason"

Property Value

"microsoft.security.decision.reason"

SECURITY_DECISION_TYPE_KEY

Attribute key for the guardrail decision type (microsoft.security.decision.type).

static SECURITY_DECISION_TYPE_KEY: "microsoft.security.decision.type" = "microsoft.security.decision.type"

Property Value

"microsoft.security.decision.type"

SECURITY_EXTERNAL_EVENT_ID_KEY

Attribute key for an external correlation identifier for SIEM systems (microsoft.security.external_event_id).

static SECURITY_EXTERNAL_EVENT_ID_KEY: "microsoft.security.external_event_id" = "microsoft.security.external_event_id"

Property Value

"microsoft.security.external_event_id"

SECURITY_FINDING_EVENT_NAME

Event name emitted for a security finding (microsoft.security.finding).

static SECURITY_FINDING_EVENT_NAME: "microsoft.security.finding" = "microsoft.security.finding"

Property Value

"microsoft.security.finding"

SECURITY_POLICY_DECISION_TYPE_KEY

Attribute key for the security policy decision type (microsoft.security.policy.decision.type).

static SECURITY_POLICY_DECISION_TYPE_KEY: "microsoft.security.policy.decision.type" = "microsoft.security.policy.decision.type"

Property Value

"microsoft.security.policy.decision.type"

SECURITY_POLICY_ID_KEY

Attribute key for the security policy identifier (microsoft.security.policy.id).

static SECURITY_POLICY_ID_KEY: "microsoft.security.policy.id" = "microsoft.security.policy.id"

Property Value

"microsoft.security.policy.id"

SECURITY_POLICY_NAME_KEY

Attribute key for the security policy name (microsoft.security.policy.name).

static SECURITY_POLICY_NAME_KEY: "microsoft.security.policy.name" = "microsoft.security.policy.name"

Property Value

"microsoft.security.policy.name"

SECURITY_POLICY_VERSION_KEY

Attribute key for the security policy version (microsoft.security.policy.version).

static SECURITY_POLICY_VERSION_KEY: "microsoft.security.policy.version" = "microsoft.security.policy.version"

Property Value

"microsoft.security.policy.version"

SECURITY_RISK_CATEGORY_KEY

Attribute key for the detected risk category (microsoft.security.risk.category).

static SECURITY_RISK_CATEGORY_KEY: "microsoft.security.risk.category" = "microsoft.security.risk.category"

Property Value

"microsoft.security.risk.category"

SECURITY_RISK_METADATA_KEY

Attribute key for non-content risk metadata (microsoft.security.risk.metadata).

static SECURITY_RISK_METADATA_KEY: "microsoft.security.risk.metadata" = "microsoft.security.risk.metadata"

Property Value

"microsoft.security.risk.metadata"

SECURITY_RISK_SCORE_KEY

Attribute key for the numeric risk score (microsoft.security.risk.score).

static SECURITY_RISK_SCORE_KEY: "microsoft.security.risk.score" = "microsoft.security.risk.score"

Property Value

"microsoft.security.risk.score"

SECURITY_RISK_SEVERITY_KEY

Attribute key for the detected risk severity (microsoft.security.risk.severity).

static SECURITY_RISK_SEVERITY_KEY: "microsoft.security.risk.severity" = "microsoft.security.risk.severity"

Property Value

"microsoft.security.risk.severity"

SECURITY_TARGET_ID_KEY

Attribute key for the guardrail target identifier (microsoft.security.target.id).

static SECURITY_TARGET_ID_KEY: "microsoft.security.target.id" = "microsoft.security.target.id"

Property Value

"microsoft.security.target.id"

SECURITY_TARGET_TYPE_KEY

Attribute key for the guardrail target type (microsoft.security.target.type).

static SECURITY_TARGET_TYPE_KEY: "microsoft.security.target.type" = "microsoft.security.target.type"

Property Value

"microsoft.security.target.type"

SERVER_ADDRESS_KEY

Attribute key for the destination server host name (server.address).

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

Property Value

"server.address"

SERVER_PORT_KEY

Attribute key for the destination server port (server.port).

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

Property Value

"server.port"

SERVICE_NAME_KEY

Attribute key for the service name (service.name).

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

Property Value

"service.name"

SESSION_DESCRIPTION_KEY

Attribute key for the session description (microsoft.session.description).

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

Property Value

"microsoft.session.description"

SESSION_ID_KEY

Attribute key for the session identifier (microsoft.session.id).

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

Property Value

"microsoft.session.id"

SOURCE_NAME

Tracer/instrumentation-scope name used for all A365 spans.

static SOURCE_NAME: "Agent365Sdk" = "Agent365Sdk"

Property Value

"Agent365Sdk"

TELEMETRY_SDK_LANGUAGE_KEY

Attribute key for the telemetry SDK language (telemetry.sdk.language).

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

Property Value

"telemetry.sdk.language"

TELEMETRY_SDK_LANGUAGE_VALUE

Telemetry SDK language value reported by this distro.

static TELEMETRY_SDK_LANGUAGE_VALUE: "nodejs" = "nodejs"

Property Value

"nodejs"

TELEMETRY_SDK_NAME_KEY

Attribute key for the telemetry SDK name (telemetry.sdk.name).

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

Property Value

"telemetry.sdk.name"

TELEMETRY_SDK_NAME_VALUE

Telemetry SDK name value reported by this distro.

static TELEMETRY_SDK_NAME_VALUE: "microsoft-opentelemetry" = "microsoft-opentelemetry"

Property Value

"microsoft-opentelemetry"

TELEMETRY_SDK_VERSION_KEY

Attribute key for the telemetry SDK version (telemetry.sdk.version).

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

Property Value

"telemetry.sdk.version"

TELEMETRY_SDK_VERSION_VALUE

Telemetry SDK version value reported by this distro.

static TELEMETRY_SDK_VERSION_VALUE: "1.4.0" = "1.4.0"

Property Value

"1.4.0"

TENANT_ID_KEY

Attribute key for the tenant identifier (microsoft.tenant.id).

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

Property Value

"microsoft.tenant.id"

TRACE_CONTENTS_ENVIRONMENT_VARIABLE

Environment-variable name that enables recording of gen-ai message content.

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

Feature-switch name that enables tracing of gen-ai message content.

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

Property Value

"Azure.Experimental.TraceGenAIMessageContent"

USER_EMAIL_KEY

Attribute key for the user email address (user.email).

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

Property Value

"user.email"

USER_ID_KEY

Attribute key for the user identifier (user.id).

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

Property Value

"user.id"

USER_NAME_KEY

Attribute key for the user display name (user.name).

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

Property Value

"user.name"