Activer CloudWatch les journaux

Le SDK Hub fournit des fonctionnalités de journalisation complètes. Par défaut, le SDK du Hub écrit les journaux dans le système de fichiers local. Vous pouvez toutefois tirer parti de l'API cloud pour configurer le streaming CloudWatch des journaux vers Logs, qui propose :

• Surveillez les performances des appareils : enregistrez des journaux d'exécution détaillés pour une gestion proactive des appareils. Activez une analyse et une surveillance avancées des journaux sur l'ensemble de votre parc d'appareils

• Résoudre les problèmes : générez des entrées de journal détaillées pour une analyse diagnostique rapide. Enregistrez les événements au niveau du système et de l'application pour une enquête approfondie.

• Journalisation flexible et centralisée : gestion des journaux à distance sans accès direct aux appareils. Regroupez les journaux de plusieurs appareils dans un seul référentiel consultable.

Prérequis

• Intégrez l'appareil géré dans le cloud. Consultez Configuration de l'intégration du hub pour plus de détails.

• Vérifiez le démarrage et la réussite de l'initialisation de l'agent Hub. Consultez Installation et validation du SDK Hub pour les intégrations gérées pour plus de détails.

Note

Pour créer des configurations de journalisation, consultez PutRuntimeLogConfiguration l'API pour plus de détails.

Avertissement

L'activation des journaux est prise en compte dans le calcul des quotas par niveaux. L'augmentation des niveaux de journalisation se traduira par une augmentation du volume de messages et des coûts supplémentaires.

Configuration des configurations du journal du SDK Hub

Configurez les paramètres du journal du SDK du hub en appelant l'API pour configurer la configuration du journal d'exécution.

Exemple exemple de demande d'API

aws iot-managed-integrations put-runtime-log-configuration \
    --managed-thing-id MANAGED_THING_ID \
    --runtime-log-configurations LogLevel=DEBUG,UploadLog=TRUE               

RuntimeLogConfigurations attributs

Les attributs suivants sont facultatifs et peuvent être configurés dans l'RuntimeLogConfigurationsAPI.

LogLevel

Définit le niveau de gravité minimal pour les traces d'exécution. Valeurs: DEBUG, ERROR, INFO, WARN

Par défaut : WARN (version publiée)

LogFlushLevel

Détermine le niveau de gravité pour le transfert immédiat des données vers le stockage local. Valeurs: DEBUG, ERROR, INFO, WARN

Par défaut : DISABLED

LocalStoreLocation

Spécifie l'emplacement de stockage pour les traces d'exécution. Par défaut : /var/log/awsiotmi

• Journal actif : /var/log/awsiotmi/ManagedIntegrationsDeviceSdkHub.log

• Journaux pivotés : /var/log/awsiotmi/ManagedIntegrationsDeviceSdkHub.N.log (N indique l'ordre de rotation)

LocalStoreFileRotationMaxBytes

Déclenche la rotation du fichier lorsque le fichier actuel dépasse la taille spécifiée.

Important

Pour une efficacité optimale, maintenez la taille du fichier en dessous de 125 Ko. Les valeurs supérieures à 125 Ko seront automatiquement limitées.

LocalStoreFileRotationMaxFiles,

Définit le nombre maximum de fichiers de rotation autorisés par le démon log.

UploadLog

Contrôle le transfert des traces d'exécution vers le cloud. Les journaux sont stockés dans le groupe /aws/iotmanagedintegration CloudWatch Logs.

Par défaut: false.

UploadPeriodMinutes

Définit la fréquence des téléchargements des traces d'exécution. Par défaut : 5

DeleteLocalStoreAfterUpload

Contrôle la suppression des fichiers après le téléchargement. Par défaut : true

Note

S'il est défini sur false, les fichiers téléchargés sont renommés en : /var/log/awsiotmi/ManagedIntegrationsDeviceSdkHub.uploaded.{uploaded_timestamp}

Exemple de fichier journal

Voir l'exemple d'un fichier CloudWatch journal ci-dessous :