Surveillance de Haskell

Vous pouvez laisser le SDK créer automatiquement des portées d'entrée pour toutes les requêtes HTTP entrantes dans une application WAI en l'utilisant comme plug-in middleware WAI. Les en-têtes de traçage Instana ainsi que les en-têtes de contexte de traçage du W3C sont automatiquement pris en compte par le plug-in. Notez que les plages d'exit doivent encore être créées manuellement via les fonctions withHttpExit ou startHttpExit/completeExit (voir ci-dessous).

Le plug-in middleware ajoutera également un en-tête de réponse HTTP supplémentaire (Server-Timing) aux réponses HTTP. Cet en-tête active la corrélation d'arrière-plan de surveillance de site Web.

import qualified Instana.Wai.Middleware.Entry as InstanaWaiMiddleware

main = do
  Warp.run 3000 $ InstanaWaiMiddleware.traceHttpEntries instana $ app

Toutes les fonctions commençant par with acceptent (entre autres paramètres) une action d'E-S. Le kit SDK démarre une étendue avant, puis exécute l'action d'E-S indiquée avant de terminer l'étendue. L'utilisation de ce style est recommandée par rapport à l'API de bas niveau qui nécessite le démarrer et terminer vous-même les étendues.

• withRootEntry : crée une étendue d'entrée qui est la racine d'une trace (sans étendue parent).
• withEntry : crée une étendue d'entrée avec une portée parent.
• withHttpEntry : fonction de commodité qui examine une requête HTTP entrante pour les en-têtes de traçage Instana ou les en-têtes de contexte de traçage W3C et crée une portée d'entrée. Il ajoutera automatiquement les métadonnées correctes à l'étendue. Notez que vous n'avez pas besoin de traiter les demandes HTTP entrantes du tout lors de l'utilisation du plug-in de middleware Instana WAI (voir ci-dessus).
• withHttpEntry_: une variante de withHttpEntry avec une signature de type plus générale, mais moins de fonctions. Elle poursuivra automatiquement la trace à partir des en-têtes entrants (en-têtes Instana ou contexte de trace W3C ), tout comme withHttpEntry le fait [...], mais elle ne capturera pas le code d'état de la réponse HTTP ni n'ajoutera l'en-tête de réponse nécessaire à la corrélation du backend de surveillance du site web (Server-Timing). Il est recommandé d'utiliser withHttpEntry au lieu de cette fonction, si possible. Vous pouvez également appeler postProcessHttpResponse dans le bloc withHttpEntry_ pour couvrir les deux fonctions manquantes mentionnées ci-dessus. Notez que vous n'avez pas besoin de traiter les demandes HTTP entrantes du tout lors de l'utilisation du plug-in de middleware Instana WAI.
• withExit : crée une étendue de sortie. Ce style ne peut être appelé qu'au sein d'un appel withRootEntry ou withEntry, car une étendue de sortie nécessite une étendue d'entrée en tant que parent.
• withHttpExit : crée une étendue de sortie pour une demande client HTTP donnée. Il ajoutera automatiquement les métadonnées correctes à l'étendue afin d'être préféré à withExit lors du traçage des demandes HTTP sortantes. Il ajoutera également les en-têtes HTTP de traçage Instana ainsi que les en-têtes HTTP du contexte de traçage du W3C HTTP à la demande de propagation du contexte de traçage en aval.
• postProcessHttpResponse : traite la réponse d'une entrée HTTP. Cette fonction doit être appelée alors que l'étendue d'entrée HTTP est toujours active. Il peut être utilisé dans un bloc withHttpEntry_ ou entre startHttpEntry et completeEntry. Cette fonction réalise deux choses : elle capture le code d'état HTTP de la réponse et l'ajoute sous forme d'annotation à l'étendue active. Cela ajoute également un en-tête de réponse supplémentaire « HTTP » (Server-Timing) à la réponse HTTP fournie, ce qui permet la corrélation avec le système de surveillance du site web. Le code client devrait rarement avoir la nécessité de l'appeler directement. Au lieu de cela, capturer les demandes HTTP entrantes avec withHttpEntry, ce qui fait automatiquement ces deux choses.
• addAnnotation: ajoute une balise à l'étendue en cours.

• startRootEntry : démarre une étendue d'entrée qui correspond au début d'une trace (sans étendue parent). Il vous faudra appeler completeEntry à moment donné.
• startEntry : démarre une étendue d'entrée. Il vous faudra appeler completeEntry à moment donné.
• startHttpEntry : démarre une étendue d'entrée pour une demande HTTP entrante. Il ajoutera automatiquement les métadonnées correctes à l'étendue. Il n'est pas nécessaire de traiter les demandes HTTP entrantes du tout lors de l'utilisation du plug-in middleware WAI (voir ci-dessus). Il vous faudra appeler completeEntry à moment donné.
• startExit : démarre une étendue de sortie. Il vous faudra appeler completeExit à moment donné.
• startHttpExit : démarre une étendue de sortie pour une demande HTTP sortante. Il ajoutera automatiquement les métadonnées correctes à l'étendue afin d'être préféré à startExit lors du traçage des demandes HTTP sortantes. Il ajoutera également des en-têtes HTTP à la requête pour propager le contexte de traçage en aval. Vous devrez appeler completeExit à un moment donné.
• completeEntry : finalise une étendue d'entrée. Place l'étendue dans la mémoire tampon du kit SDK pour la transmettre à l'agent Instana.
• completeExit : finalise une étendue de sortie. Place l'étendue dans la mémoire tampon du kit SDK pour la transmettre à l'agent Instana.

Assurez-vous d'avoir lu la documentation d' Instana sur le traçage personnalisé. Cette documentation contient de nombreuses informations utiles pour intégrer le traçage d' Instana dans votre code; elle explique notamment quelles métadonnées peuvent être ajoutées aux segments (via InstanaSDK.addTag et InstanaSDK.addTagAt).

Instana fait la différence entre les portées enregistrées et celles de SDK. Les portées enregistrées sont généralement créées par le traçage automatique et il existe une manipulation spécialisée pour chaque enregistrement enregistré dans le pipeline de traitement d'Instana. Les portées SDK, en revanche, sont le type de portées créées à l'aide d'un SDK de traçage (comme le SDK de traçage Haskell ou d'autres SDK similaires pour les autres plateformes d'exécution). La portée SDK est traitée de manière plus générique par le pipeline de traitement d'Instana.

Notez que presque toutes les portées créées avec ce SDK doivent être des portées SDK. Il ne s'agit que de deux exceptions, pour lesquelles ce SDK crée des portées enregistrées :

• L'entrée HTTP/WAI (serveur) s'étend et
• L'exit HTTP (client) s'étend.

Le SDK propose des fonctions spécifiques pour créer ces intervalles enregistrés (withHttpEntry, withHttpExit ainsi que les fonctions de bas niveau startHttpEntry correspondantes et startHttpExit, voir « Style des crochets » et « API de bas niveau »).