Semantic conventions for Azure resource log events

Status: Development

This document defines semantic conventions for instrumentations that emit Azure Resource Log events.

Azure Resource Log

Status:

The event name MUST be azure.resource.log.

Describes Azure Resource Log event, see Azure Resource Log Top-level Schema for more details.

Attributes:

Key	Stability	Requirement Level	Value Type	Description	Example Values
azure.service.request.id		Recommended	string	The unique identifier of the service request. It’s generated by the Azure service and returned with the response.	00000000-0000-0000-0000-000000000000
cloud.resource_id		Recommended	string	The Fully Qualified Azure Resource ID the log is emitted for.	arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function; //run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID; /subscriptions/<SUBSCRIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>

Body fields:

:warning: Body fields will be moved to complex attributes once the semantic convention tooling supports complex attributes (see #1870).

Field Name	Stability	Requirement Level	Value Type	Description	Example Values
category		Recommended	string	The Azure category of the log entry.	AuditEvent; GatewayLogs; ApplicationGatewayAccessLog
correlation.id		Recommended	string	The correlation ID of the log entry.	607964b6-41a5-4e24-a5db-db7aab3b9b34
duration		Recommended	int	The duration of the operations in milliseconds.	1000
identity		Opt-In	undefined	“A JSON blob that describes the identity of the user or application that performed the operation.” [1]
operation.name		Recommended	string	The name of the operation.	SecretGet; Microsoft.ApiManagement/GatewayLogs; ApplicationGatewayAccess
operation.version		Recommended	string	The version of the operation.	1.0
properties		Recommended	undefined	The properties provided in the Azure Resource Log.
result.description		Recommended	string	The description of the result.	The operation was successful; The operation failed
result.signature		Recommended	string	The substatus of associated with the logged event.	OK
result.type		Recommended	string	The status associated with the logged event.	Succeeded; Failed; Started
tenant.id		Conditionally Required [2]	string	The tenant ID of the Active Directory tenant that this event is tied to.	00000000-0000-0000-0000-000000000000

[1]: Typically, this field includes the authorization and claims or JWT token from Active Directory.

[!Warning] This field contains sensitive (PII) information.

[2] tenant.id: if the event is tied to an Active Directory tenant.