Présentation de Kepserver et exemple d'utilisation de l'intégration Datadog
Configuration de l'API pour l'accès aux logs
Activation du service d'API
Activation de la capture de diagnostic sur un canal
Paramètres pour la configuration à partir des icônes de la barre des tâches Windows
Paramètres pour la gestion des utilisateurs
Documentation de l'API REST
Présentation
L’intégration Scadamods Kepserver permet de surveiller les modifications apportées aux canaux, aux appareils et aux tags. Elle récupère les événements issus du journal des événements de Kepserver et les affiche en temps réel sur votre dashboard Datadog. Grâce à l’API de configuration de Kepserver, cette intégration recueille des détails qui vous permettent de vérifier la configuration des canaux, des appareils et des tags mis en œuvre sur chaque instance de Kepserver.
The _TotalTagCount tag indicates the total number of tags that are currently being accessed. These tags can be active or inactive.Note:This count does not represent the number of tags configured in the project.
The _SuccessfulReads tag contains a count of the number of reads this channel has completed successfully since the start of the application or since the last time the _Reset tag was invoked. This tag is formatted as unsigned 32-bit integer and will eventually rollover. This tag is read only.
The _SuccessfulWrites tag contains a count of the number of writes this channel has completed successfully since the start of the application or since the last time the _Reset tag was invoked. This tag is formatted as an unsigned 32-bit integer and will eventually rollover. This tag is read only.
The _FailedReads count of the num of reads this chan. has failed to complete since the start of app or since _Reset tag was invoked. Incremented after the channel has failed the request. This tag is formatted as an unsigned 32-bit integer and will eventually rollover. This tag is read only.
The _FailedWrites count of the num of writes this chan. has failed to complete since the start of the app _Reset tag was invoked. Incremented after the channel has failed the request. This tag is formatted as unsigned 32-bit integer and will eventually rollover. This tag is read only.
scadamods.kepserver.statistics.rx_bytes (gauge)
The _RxBytes tag contains a count of the number of bytes the channel has received from connected devices since the start of the application or since the last time the _Reset tag was invoked. This tag is formatted as unsigned 32-bit integer and will eventually rollover. This tag is read only.
scadamods.kepserver.statistics.tx_bytes (gauge)
The _TxBytes tag contains a count of the number of bytes the channel has sent to connected devices since the start of the application or since the last time the _Reset tag was invoked. This tag is formatted as unsigned 32-bit integer and will eventually rollover. This tag is read only.
The _MaxPendingReads tag contains a count of the maximum number of pending read requests for the channel since the start of the application (or the _Reset tag) was invoked. This tag is formatted as an unsigned 32-bit integer. The tag is read only.
The _MaxPendingWrites tag contains a count of the maximum number of pending write requests for the channel since the start of the application (or the _Reset tag) was invoked. This tag is formatted as an unsigned 32-bit integer. The tag is read only.
The _NextReadPriority is a channel-level system tag that reflects the priority level of the next read in the channel's pending read queue. Possible values are -1: No pending reads. 0:next read is a res of a schedule-level demand poll or explicit read from a client. 1 - n: next read is a result of scheduled read.
The _PendingReads tag contains a count of the current pending read requests for the channel. This tag is formatted as an unsigned 32-bit integer. The tag is read only.
The _PendingWrites tag contains a count of the current pending write requests for the channel. This tag is formatted as an unsigned 32-bit integer. This tag is read only.
The _SecondsInError tag is a DWord tag that displays the number of seconds since the device entered an error state. This tag displays 0 when the device is not in an error state.
Événements
Le check Kepserver envoie l’ensemble des logs d’événement fournis par l’API de log d’événement Kepserver.
Checks de service
scadamods_kepserver.can_connect : Renvoie CRITICAL si l’Agent ne parvient pas à se connecter à l’instance Kepserver qu’il surveille et à y recueillir des métriques. Si ce n’est pas le cas, renvoie OK.
Dépannage
1. Erreur d’accès non autorisé
Symptôme : le check Kepserver renvoie la valeur CRITICAL lorsqu’il ne parvient pas à se connecter à l’instance Kepserver.
Logs : le check Kepserver enregistre le message d’erreur suivant dans les logs :
Failed to retrieve Kepserver Event Logs: 401 Client Error: Unauthorized for url: http://127.0.0.1:57412//config/v1/event_log?
Recommandations :
Vérifiez que l’instance Kepserver est bien lancée.
Confirmez que l’utilisateur a bien accès à l’endpoint d’API Kepserver en ouvrant l’URL http://127.0.0.1:57412//config/v1/event_log? dans un navigateur.
Si l’utilisateur n’a pas accès à l’endpoint d’API Kepserver, créez un utilisateur avec les autorisations adéquates.
Accédez à la page d’administration de Kepserver et créez un utilisateur avec les autorisations adéquates.
Vérifiez que le service d’API de configuration est activé sur l’instance Kepserver. Pour ce faire, accédez à l’onglet correspondant et sélectionnez Yes pour l’option Enable.
Confirmez que l’endpoint d’API Kepserver est identique au lien « View in browser » dans l’onglet des services d’API de configuration.
Confirmez que le nom d’utilisateur et le mot de passe sont corrects dans le fichier scadamods_kepserver.d/conf.yaml.
2. Échec de la collecte des métriques OPC-UA
Description : les métriques OPC-UA proviennent de la fonction de diagnostic système de Kepserver. Cette fonction est désactivée par défaut et doit donc être activée dans les propriétés OPC-UA du projet. Le node_id désigne le serveur à partir duquel les métriques OPC-UA sont collectées. Si le serveur n’est pas lancé, le node_id ne sera pas trouvé par le client. Le node_id correspond à ns=2 par défaut pour l’instance Kepserver. Si vous souhaitez modifier ce paramètre, contactez support@scadamods.com.
Symptôme : le check Kepserver ne capture pas les métriques OPC-UA pour les diagnostics système.
Logs : le check Kepserver enregistre le message d’erreur suivant dans les logs :
OPC UA metric request failed: "The node id refers to a node that does not exist in the server address space."(BadNodeIdUnknown)
Recommandations :
Vérifiez que les diagnostics système sont activés dans Kepserver.
Accédez à la page des propriétés du projet Kepserver et sélectionnez l’onglet OPC-UA. Vérifiez que l’option Log diagnostics est définie sur Yes.
Ce n’est pas l’intégration que vous recherchez ? Une fonctionnalité importante pour votre organisation est manquante ? Écrivez-nous et nous l’ajouterons !
Cette application est disponible sur le Marketplace Datadog et développée par un partenaire technologique de Datadog. Cliquez ici pour l’acheter.
Pour aller plus loin
Documentation, liens et articles supplémentaires utiles :
