Live Objects - complete developer guide

Audit Log

Concepts

This service will let you monitor what is happening in the core of the platform. More precisely, you will find an "AuditLog message" when an error occurs in a Live Objects service.

Use Audit log only as debugging tool

the format of these logs is subject to change
quantity of AuditLogs and retention duration are limited. See the dedicated section

Simple http REST API is available to search and retrieve specific AuditLog messages that will allow you to debug your application.

See the AuditLog swagger documentation for further information regarding this API.

You will also find an Activity log menu in the web portal to display these AuditLog messages.

List of events

Events detailed information are subject to changes. Here are the kind of events you will be able to get.

Category Sub-category Description Actions generating an AuditLog

Category	Sub-category	Description	Actions generating an AuditLog
connectivity	mqtt	Logs about the MQTT connector (all modes) `ERROR` logs activated by default. `INFO` logs activated only when debug mode is activated on the API-Key or the device interface (more verbose for the latter). Note: MQTT AuditLogs are capped to avoid flooding. An AuditLog is sent to inform a limit is reached.	`ERROR` # bad topic subscription or publication # wrong datamessage format when publish # connection error # reached rate limit… `INFO` # connections and disconnections (debug mode on API-Key or device interface) # all MQTT messages: CONNECT, SUBSCRIBE, PUBLISH, PINGREQ, etc. (debug mode on device interface only)
connectivity	lora	LoRa® network events. Specific for LoRa® connector. These logs depend of your offer and can be extended with an advance mode. Please contact your customer service.	By default, simple network events are raised as AuditLog messages. # Join request # Join accept
connectivity	lwm2m	Logs about the LwM2M connector `ERROR` logs activated by default. `INFO` logs activated only when the debug mode is activated on the LwM2M interface. Note: LwM2M AuditLogs are capped to avoid flooding. An AuditLog is sent to inform the limit is reached. The capping limit is higher when the debug mode is activated.	`ERROR` # limit reached # connection refused (wrong security info, service disabled, etc.) # the request timed out # invalid request or response # any other reason preventing a message to be successfully sent or processed by the platform # DTLS handshake failed `INFO` # LwM2M operations (Register, Read, Send, etc.) requests and responses (including device responses with a code 4xx or 5xx) # DTLS handshake initiated
notification	http	Logs about the httpPush action used in the Routing service	`ERROR` trying to send an event using httpPush action. 4xx, 5xx with the response body Note: the AuditLog message is sent at the end of the retry policy, if activated in the routing policy.
notification	azure	Logs when using the action Azure Event Hubs in the Routing service	`ERROR` # trying to send an event to Microsoft Azure Event Hubs using the dedicated action in the Routing service.
data	storage	Logs about the Search service (Elastic Search indexation)	`ERROR` # 1000 fields in the model exceeded # incoherence of the model (for ex. start with an integer and then value change with a boolean) # several different types in an array ex. [1234, "stringText"] ⇒ impossible to index for Elastic Search
data	pipeline	Logs about the Pipeline service	`ERROR` # ExternalTransformation Step : 4xx or 5xx response from server / connection timeout / invalid data format of the response / too many pending data messages for the pipeline
device management	twin	Logs about the Twin service	`ERROR` # Max supported objects or instances # Invalid instance: definition not found, wrong parent/mapType/objectType, or duplicate # Reported values: distinct path quota reached # Reported values: size quota reached `INFO` # Operations : delayed operations

connectivity

mqtt

Logs about the MQTT connector (all modes)

ERROR logs activated by default.

INFO logs activated only when debug mode is activated on the API-Key or the device interface (more verbose for the latter).

Note: MQTT AuditLogs are capped to avoid flooding. An AuditLog is sent to inform a limit is reached.

ERROR

# bad topic subscription or publication
# wrong datamessage format when publish
# connection error
# reached rate limit…

INFO
# connections and disconnections (debug mode on API-Key or device interface)
# all MQTT messages: CONNECT, SUBSCRIBE, PUBLISH, PINGREQ, etc. (debug mode on device interface only)

connectivity

lora

LoRa® network events. Specific for LoRa® connector. These logs depend of your offer and can be extended with an advance mode. Please contact your customer service.

By default, simple network events are raised as AuditLog messages.
# Join request
# Join accept

connectivity

lwm2m

Logs about the LwM2M connector

ERROR logs activated by default.

INFO logs activated only when the debug mode is activated on the LwM2M interface.

Note: LwM2M AuditLogs are capped to avoid flooding. An AuditLog is sent to inform the limit is reached. The capping limit is higher when the debug mode is activated.

ERROR
# limit reached
# connection refused (wrong security info, service disabled, etc.)
# the request timed out
# invalid request or response
# any other reason preventing a message to be successfully sent or processed by the platform
# DTLS handshake failed

INFO
# LwM2M operations (Register, Read, Send, etc.) requests and responses (including device responses with a code 4xx or 5xx)
# DTLS handshake initiated

notification

http

Logs about the httpPush action used in the Routing service

ERROR trying to send an event using httpPush action.
4xx, 5xx with the response body
Note: the AuditLog message is sent at the end of the retry policy, if activated in the routing policy.

notification

azure

Logs when using the action Azure Event Hubs in the Routing service

ERROR

# trying to send an event to Microsoft Azure Event Hubs using the dedicated action in the Routing service.

data

storage

Logs about the Search service (Elastic Search indexation)

ERROR
# 1000 fields in the model exceeded
# incoherence of the model (for ex. start with an integer and then value change with a boolean)
# several different types in an array ex. [1234, "stringText"] ⇒ impossible to index for Elastic Search

data

pipeline

Logs about the Pipeline service

ERROR
# ExternalTransformation Step : 4xx or 5xx response from server / connection timeout / invalid data format of the response / too many pending data messages for the pipeline

device management

twin

Logs about the Twin service

ERROR
# Max supported objects or instances
# Invalid instance: definition not found, wrong parent/mapType/objectType, or duplicate
# Reported values: distinct path quota reached
# Reported values: size quota reached

INFO
# Operations : delayed operations