open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
semantic-conventions/docs/azure/events.md

4.9 KiB
Raw Blame History

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

Attributes

The event name MUST be az.resource.log.

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 Experimental
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 Experimental
event.name string Identifies the class / type of event. [1] browser.mouse.click; device.app.lifecycle Recommended Experimental

[1]: Event names are subject to the same rules as attribute names. Notably, event names are namespaced to avoid collisions and provide a clean separation of semantics for events in separate domains like browser, mobile, and kubernetes.

Body Fields

Body Field Type Description Examples Requirement Level Stability
category string The Azure category of the log entry. AuditEvent, GatewayLogs, ApplicationGatewayAccessLog Required Experimental
correlation.id string The correlation ID of the log entry. 607964b6-41a5-4e24-a5db-db7aab3b9b34 Required Experimental
duration int The duration of the operations in milliseconds. 1000 Required Experimental
identity string A JSON blob that describes the identity of the user or application that performed the operation. someone Opt-In Experimental
operation.name string The name of the operation. SecretGet, Microsoft.ApiManagement/GatewayLogs, ApplicationGatewayAccess Required Experimental
operation.version string The version of the operation. 1.0 Required Experimental
properties keyvaluelist The properties provided in the Azure Resource Log. {
  "statusCode": "Created",
  "serviceRequestId": "50d5cddb-8ca0-47ad-9b80-6cde2207f97c"
}		 Required Experimental
result.type string The status associated with the logged event. Started, In Progress, Succeeded, Failed, Active, Resolved Required Experimental
result.signature string The substatus of associated with the logged event. OK Required Experimental
result.description string The description of the result. The operation was successful, The operation failed Required Experimental
tenant.id string The tenant ID of the Active Directory tenant that this event is tied to. 607964b6-41a5-4e24-a5db-db7aab3b9b34 Conditionally Required: if the event is tied to an Active Directory tenant. Experimental

See Azure Resource Log definition for the details.