You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/event-grid/monitor-mqtt-delivery-reference.md
+212-1Lines changed: 212 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,8 +53,219 @@ This article provides a reference of log and metric data collected to analyze th
53
53
| DropReason | The reason a session was dropped. The available values include: <br><br>- SessionExpiry: a persistent session has expired. <br>- TransientSession: a non-persistent session has expired. <br>- SessionOverflow: a client didn't connect during the lifespan of the session to receive queued QOS1 messages until the queue reached its maximum limit. <br>- AuthorizationError: a session drop because of any authorization reasons.
54
54
55
55
56
+
## Resource logs
57
+
58
+
MQTT broker in Azure Event Grid captures diagnostic logs for the following categories:
This section provides schema and examples for these logs.
67
+
68
+
### Common properties
69
+
The following properties are common for all the resource logs from MQTT broker.
70
+
71
+
| Property name | Type | Description |
72
+
| ----------- | ---- | ----------- |
73
+
|`time`|`DateTime`| Timestamp (UTC) when the log was generated. |
74
+
|`resourceId`|`String`| Resource ID of the Event Grid namespace. For example: `/SUBSCRIPTIONS/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/RESOURCEGROUPS/MYRG/PROVIDERS/MICROSOFT.EVENTGRID/NAMESPACE/MYNAMESPACE`. |
75
+
|`location`|`String`| Location of the namespace |
76
+
|`operationName`|`String`| Name of the operation. For example: `Microsoft.EventGrid/topicspaces/connect`, `Microsoft.EventGrid/topicspaces/disconnect`, `Microsoft.EventGrid/topicspaces/publish`, `Microsoft.EventGrid/topicspaces/subscribe`, `Microsoft.EventGrid/topicspaces/unsubscribe`. |
77
+
|`category`|`String`| Category or type of the operation. For example: `FailedMQTTConnections`, `SuccessfulMQTTConnections`, `MQTTDisconnections`, `FailedMQTTPublishedMessages`, `FailedMQTTSubscriptionOperations`. |
78
+
|`resultType`|`String`| Result of the operation. For example: `Failed`, `Succeeded`. |
79
+
|`resultSignature`|`String`| Result of the failed operation. For example: `QuotaExceeded`, `ClientAuthenticationError`, `AuthorizationError`. This property isn't included for the successful events like `SuccessfulMQTTConnections`. |
80
+
|`resultDescription`|`String`| More description about the result of the failed operation. This property isn't included for the successful events like `SuccessfulMQTTConnections`. |
81
+
|`AuthenticationAuthority`|`String`| Type of authority used to authenticate your MQTT client. It's set to one of the following values: `Local` for clients registered in Event Grid's local registry, or `AAD` for clients using Microsoft Entra for authentication. |
82
+
|`authenticationType`|`String`| Type of authentication used by the client. It's set to one of the following values: `CertificateThumbprintMatch`, `AccessToken`, or `CACertificate`. |
83
+
|`clientIdentitySource`|`String`| Source of the client’s identity. It's `JWT` when you use Microsoft Entra ID authentication. |
84
+
|`authenticationAuthority`|`String`| Authority of the client's identity. It's set to one of the following values: `local` for the clients in Event Grid namespace's local registry, `AAD` for AAD clients. |
85
+
|`clientIdentity`|`String`| Value of the client’s identity. It's the name of the local registry or object ID for Microsoft Entra ID clients.|
86
+
87
+
88
+
### Failed MQTT connections
89
+
This log includes an entry for every failed `MQTT CONNECT` operation by the client. This log can be used to diagnose connectivity issues.
"resultDescription": "Timed out per negotiated Keep Alive",
175
+
"identity": {
176
+
"clientIdentity": "client1"
177
+
},
178
+
"properties": {
179
+
"sessionName": "client1",
180
+
"protocol": "MQTT5"
181
+
}
182
+
}
183
+
]
184
+
```
185
+
186
+
Here are the properties and their descriptions.
187
+
188
+
| Property | Type | Description |
189
+
| ----------- | ---- | ----------- |
190
+
|`sessionName`|`String`| Name of the session provided by the client in the `MQTT CONNECT` packet’s clientId field. |
191
+
|`protocol`|`String`| Protocol used by the client to connect. Possible values are: MQTT3, MQTT3-WS, MQTT5, MQTT5-WS. |
192
+
193
+
194
+
### Failed MQTT published messages
195
+
This log includes an entry for every MQTT message that failed to be published to or delivered by an Event Grid namespace. This log can be used to diagnose publishing issues and message loss.
"resultDescription": "Topic name 'testtopic/small4.0' does not match any topicspaces",
208
+
"identity": { "clientIdentity": "client1" },
209
+
"properties": {
210
+
"sessionName": "client1",
211
+
"protocol": "MQTT5",
212
+
"traceId": "ako65yewjjhzbdp3lxny7557fu",
213
+
"qos": 1,
214
+
"topicName": "testtopic/small4.0",
215
+
"operationCount": 1
216
+
}
217
+
}
218
+
]
219
+
```
220
+
221
+
Here are the columns of the `EventGridNamespaceFailedMqttPublishedMessages` Log Analytics table and their descriptions.
222
+
223
+
| Column name | Type | Description |
224
+
| ----------- | ---- | ----------- |
225
+
|`sessionName`|`String`| Name of the session provided by the client in the MQTT CONNECT packet’s clientId field. |
226
+
|`protocol`|`String`| Protocol used by the client to publish. Possible values are: MQTT3, MQTT3-WS, MQTT5, MQTT5-WS. |
227
+
|`traceId`|`Int`| Generated trace ID. |
228
+
|`qos`|`Int`| Quality of service used by the client to publish. Possible values are: 0 or 1. |
229
+
|`topicName`|`String`| MQTT Topic Name used by the client to publish. |
230
+
|`operationCount`|`Int`| Count of MQTT message that failed to be published to or delivered by an Event Grid namespace with the same resultDescription. |
231
+
232
+
### Failed MQTT subscription operations
233
+
This log includes an entry for every MQTT subscribe operation by an MQTT client. A log entry is added for each topic filter within the same subscribe/unsubscribe packet that has the same error. This log can be used to diagnose subscription issues and message loss.
0 commit comments