Configurer les paramètres de diagnostic de l’Agent MQTT

Article
11/21/2024

Important

Ce paramètre nécessite la modification de la ressource d’Agent et peut être configuré uniquement au moment du déploiement initial, en utilisant Azure CLI ou le portail Azure. S’il est nécessaire de modifier la configuration Broker, un nouveau déploiement est requis. Pour en savoir plus, consultez Personnaliser l’Agent par défaut.

Les paramètres de diagnostic vous permettent de configurer les métriques, les journaux et l’auto-vérification de l’Agent MQTT.

Métriques

Les métriques fournissent des informations sur l’intégrité et l’état actuels et passés de l’Agent MQTT. Ces métriques sont émises au format OpenTelemetry (OTLP). Elles peuvent être converties au format Prometheus en utilisant un collecteur OpenTelemetry, et routées vers des tableaux de bord Azure Managed Grafana en utilisant le service géré pour Prometheus d’Azure Monitor. Pour en savoir plus, consultez Configurer l’observabilité et le monitoring.

Pour obtenir la liste complète des métriques disponibles, consultez Métriques de l’Agent MQTT.

Journaux d’activité

Les journaux fournissent des informations sur les opérations effectuées par l’Agent MQTT. Ces journaux sont disponibles dans le cluster Kubernetes en tant que journaux de conteneur. Ils peuvent être configurés pour être envoyés aux journaux Azure Monitor avec Container Insights.

Pour en savoir plus, consultez Configurer l’observabilité et le monitoring.

Auto-vérification

Le mécanisme d’auto-vérification de l’Agent MQTT est activé par défaut. Il utilise une sonde de diagnostic et des traces OpenTelemetry (OTel) pour monitorer l’Agent. La sonde envoie des messages de test pour vérifier le comportement et le minutage du système.

Le processus de validation vérifie si le système fonctionne correctement en comparant les résultats des tests avec les résultats attendus. Ces résultats sont les suivants :

La prise des messages de chemin via le système.
Le comportement de minutage du système.

La sonde de diagnostic exécute régulièrement des opérations MQTT (PING, CONNECT, PUBLISH, SUBSCRIBE, UNSUBSCRIBE) sur l’Agent MQTT, et monitore les accusés de réception et les traces correspondants pour vérifier la latence, la perte de messages et l’exactitude du protocole de réplication.

Important

La sonde de diagnostic d’auto-vérification publie des messages dans la rubrique azedge/dmqtt/selftest. Ne publiez pas de rubriques de sonde de diagnostic qui commencent par azedge/dmqtt/selftest et ne vous abonnez pas à ce type de rubriques. La publication de ces rubriques ou l’abonnement à ces rubriques peuvent affecter la sonde ou les vérifications d’auto-test, ce qui peut entraîner des résultats non valides. Les résultats non valides peuvent être listés dans les journaux, les métriques ou les tableaux de bord de la sonde de diagnostic. Par exemple, vous pouvez voir le problème La vérification du chemin a échoué pour l’événement de sonde avec le type d’opération « Publier » dans les journaux de la sonde de diagnostic. Pour plus d’informations, consultez Problèmes connus.

Changer les paramètres de diagnostic

Dans la plupart des scénarios, les paramètres de diagnostic par défaut sont suffisants. Pour remplacer les paramètres de diagnostic par défaut pour l’Agent MQTT, modifiez la section diagnostics dans la ressource d’Agent. Actuellement, le changement des paramètres est pris en charge uniquement avec l’indicateur --broker-config-file quand vous déployez Opérations Azure IoT en utilisant la commande az iot ops create.

Pour un remplacement, préparez d’abord un fichier de configuration d’Agent en suivant la référence d’API BrokerDiagnostics. Par exemple :

{
  "diagnostics": {
    "metrics": {
      "prometheusPort": 9600
    },
      "logs": {
        "level": "debug"
      },
    "traces": {
      "mode": "Enabled",
      "cacheSizeMegabytes": 16,
      "selfTracing": {
        "mode": "Enabled",
        "intervalSeconds": 30
      },
      "spanChannelCapacity": 1000
    },
    "selfCheck": {
      "mode": "Enabled",
      "intervalSeconds": 30,
      "timeoutSeconds": 15
    }
  }
}

Ensuite, déployez Opérations Azure IoT en utilisant la commande az iot ops create avec l’indicateur --broker-config-file, comme la commande suivante (les autres paramètres sont omis pour des raisons de concision) :

az iot ops create ... --broker-config-file <FILE>.json

Pour en savoir plus, consultez Prise en charge d’Azure CLI pour la configuration avancée de l’Agent MQTT et Exemples d’Agent.

Étapes suivantes

Déployer des ressources d’observabilité et configurer des journaux

Partager via