Affichage de statistiques de niveau connexion à l'aide des API de surveillance REST

Les administrateurs système peuvent afficher les statistiques de surveillance de niveau de connexion à l'aide des API de surveillance REST.

Pourquoi et quand exécuter cette tâche

Les administrateurs système peuvent afficher des statistiques de niveau connexion à l'aide d'une API de surveillance REST ou de l'interface utilisateur Web d'IBM® IoT MessageSight. Pour plus d'informations sur l'utilisation de l'interface utilisateur Web d'IBM IoT MessageSight pour l'affichage de statistiques de niveau connexion, voir Affichage de statistiques de niveau connexion à l'aide de l'interface graphique.

Procédure

Les statistiques de surveillance de niveau connexion peuvent être créées à l'aide d'une API de surveillance REST. Les données de surveillance de connexion sont régulièrement connectées et mises en cache. Le cache des données de surveillance de connexion est mis à jour toutes les 60 secondes. Par conséquent, les statistiques qui sont produites peuvent être obsolètes de 60 secondes et ne sont pas forcément immédiatement disponibles si la commande est émise à l'heure de début du serveur IBM IoT MessageSight. Pour créer des statistiques de surveillance de niveau connexion, procédez comme suit :

  1. Utilisez la méthode GET d'une API REST d'IBM IoT MessageSight avec l'URI de configuration d'IBM IoT MessageSight suivant :

    http://<IP-noeud-final-admin:Port>/ima/v1/monitor/<TypeObjet>

  2. Insérez les paramètres de requête permettant de demander les statistiques que vous souhaitez obtenir dans le contenu JSON. L'exemple suivant utilise cURL pour créer des statistiques de niveau connexion :
    curl -X GET http://127.0.0.1:9089/ima/v1/monitor/Connection?Endpoint=Endpoint%26StatType=StatType

    où :

    • Endpoint
      Correspond au nom du noeud final.
    • StatType
      Indique le type de données selon lequel ordonner les résultats.
      Les valeurs admises sont les suivantes :
      NewestConnection
      Connexions les plus récentes.
      OldestConnection
      Connexions les plus anciennes.
      HighestThroughputMsgs
      Débit de messages le plus élevé.
      LowestThroughputMsgs
      Débit de messages le plus faible.
      HighestThroughputKB
      Débit de données en Ko/seconde le plus élevé.
      LowestThroughputKB
      Débit de données en Ko/seconde le plus faible.
      La valeur par défaut est NewestConnection.
    Remarque : Les données de connexion peuvent être obsolètes de 60 secondes au maximum.

Résultats

Les zones suivantes sont renvoyées :
  • Name
    Chaîne
    Nom de la connexion. Le CientId est couramment utilisé.
  • Protocol
    Chaîne
    Nom du protocole.
  • ClientAddr
    Chaîne
    Adresse IP du client.
  • UserId
    Chaîne
    ID utilisateur principal.
  • Endpoint
    Chaîne
    Nom du noeud final.
  • Port
    Nombre
    Port du serveur IBM IoT MessageSight.
  • ConnectTime
    Nombre
    Indique le nombre de microsecondes écoulées depuis l'époque unix.
    Heure à laquelle la connexion est créée.
  • Duration
    Nombre
    Durée de la connexion en nanosecondes.
  • ReadBytes
    Nombre
    Nombre d'octets lus depuis l'heure de connexion.
  • ReadMsg
    Nombre
    Nombre de messages lus depuis l'heure de connexion.
  • WriteBytes
    Nombre
    Nombre d'octets écrits depuis l'heure de connexion.
  • WriteMsg
    Nombre
    Nombre de messages écrits depuis l'heure de connexion.

Exemple

L'exemple suivant utilise cURL pour indiquer comment utiliser une méthode GET afin de créer des statistiques sur les connexions classées par rapport au débit de messages le plus élevé :

curl -X GET http://127.0.0.1:9089/ima/v1/monitor/Connection?Endpoint=DemoEndpoint%26StatType=HighestThroughputMsgs
 
 

Le code ci-dessous est un exemple de réponse indiquant la réussite à la méthode GET qui a été utilisée pour créer des statistiques sur les noeuds finaux ayant le débit de messages le plus élevé.

{ "Version":"v1", "Connection": [ { "Name":"DemoClientId","Protocol":"mqtt","ClientAddr":"9.20.230.65","UserId":"",
"Endpoint":"DemoEndpoint","Port":16102,"ConnectTime":1446728129213566618,"Duration":160676522991,"ReadBytes":39,"ReadMsg":0,
"WriteBytes":14,"WriteMsg":0} } ] }



Commentaires

Icône d'horodatage Dernière révision: 28 septembre 2017
http://pic.dhe.ibm.com/infocenter/ism/v1r0m0/com.ibm.ism.doc/Monitoring/admin00012.html