Semantic Conventions for Azure Resource Log events

Status: Experimental

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

Azure Resource Log

Status:

The event name MUST be az.resource.log.

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

Attribute	Type	Description	Examples	Requirement Level	Stability
az.service_request_id	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	Recommended
cloud.resource_id	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>	Recommended

Body fields:

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

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