Suivi de l' IBM MQ s dans les environnements sur site

Prérequis

  • Installez et configurez les instances du serveur et du gestionnaire de files d'attente d' IBM MQ avant d'installer et de configurer le traçage d' IBM MQ.

  • Vérifiez les systèmes d'exploitation pris en charge pour le traçage de l' IBM MQ afin de garantir la compatibilité avec votre environnement.

  • Installez la version d' OpenSSL e prise en charge en fonction de votre plateforme.

    • Linux et Windows : OpenSSL 3.2.3 ou version ultérieure
    • AIX : OpenSSL 3.0.16.1000 ou version ultérieure
    • Assurez-vous que les exigences spécifiques à la plateforme suivantes sont respectées :

      • Windows : Installez Microsoft Visual C++ Redistributable 2019 ou version ultérieure. Téléchargez le dernier package disponible sur le site Web de Microsoft.

      • AIX:

        1. Installez le runtime XL C/C++ pour AIX 17.1.3.0 ou versions ultérieures, y compris les ensembles de libc++.rtefichiers suivants, libc++abi.rte, et libunwind.rte.

          Pour vérifier que les ensembles de fichiers sont installés, exécutez :

          lslpp -l | grep -e libc++.rte -e libc++abi.rte -e libunwind.rte
           
        2. Assurez-vous que les versions suivantes de la bibliothèque système AIX sont installées :

          • pthreads 7.2.5.203 ou version ultérieure
          • libc 7.2.5.206 ou version ultérieure

          Pour vérifier les versions de la bibliothèque, exécutez :

          lslpp -l | grep -e bos.rte.libc -e bos.rte.libpthreads

Téléchargement d' IBM MQ Suivi des sorties utilisateur

Avant d'activer le traçage pour l' IBM MQ sur site, téléchargez et configurez le package d'exits utilisateur de traçage de l' IBM MQ.

Remarque : la sortie utilisateur IBM MQ ne contient plus de lien statique vers OpenSSL. Pour garantir la compatibilité avec OpenTelemetry,, vous devez installer une version prise en charge d' OpenSSL sur votre système. Pour les instructions d'installation :

Pour télécharger le package de sortie utilisateur Tracing d' IBM MQ, procédez comme suit :

  1. Téléchargez le fichier « Tracing .tar.gz user exit » (Suivi de sortie utilisateur) d' IBM MQ à partir d 'Artifactory. Pour télécharger le fichier, utilisez les identifiants suivants :

    • Nom d'utilisateur : Underscore (_)
    • Mot de passe : une clé d'agent valide
  2. Extrayez le fichier .tar.gz téléchargé vers un emplacement temporaire. Après l'extraction, recherchez cinq paquets user-exit, chacun pour une plate-forme différente, dans le répertoire.

  3. Transférez le package de sortie utilisateur spécifique à la plate-forme vers votre serveur d' IBM MQ.

  4. Extrayez le package de sortie utilisateur dans le répertoire suivant :

    • Linux ou AIX IBM MQ serveur : /var/mqm/exits64
    • Windows IBM MQ serveur : C:\ProgramData\IBM\MQ\exits64
  5. Placez les fichiers suivants dans le exits64 répertoire :

    • IBM MQ Fichier binaire de sortie utilisateur (intercepte les appels IBM MQ API et lance des appels à la bibliothèque cliente encapsulée OpenTelemetry C++ pour créer des intervalles)

      • Linux et AIX : mqtracingexit_r
      • Windows: mqtracingexit.dll
    • OpenTelemetry encapsulé Fichier binaire client C++ (fournit des fonctions permettant de gérer le cycle de vie des spans et d'envoyer les spans à l'agent hôte Instana )

      • Linux et AIX : tracelibrary.so
      • Windows: tracelibrary.dll
    • mqtracingexit.conf Fichier de configuration : ce fichier est le fichier de configuration pour toutes les instances du gestionnaire de file d'attente sur le serveur MQ. Pour créer un fichier de configuration spécifique à un gestionnaire de file d'attente, copiez mqtracingexit.conf dans mqtracingexit_<QMNAME>.conf.

  6. Assurez-vous que le traceur peut résoudre les bibliothèques partagées du client OpenTelemetry lors de l'exécution en suivant les étapes suivantes :

    • Linux/AIX

      1. Copiez les libopentelemetry_*.so fichiers du /opt/instana/tracing/ibmmq/lib répertoire.
    • Windows

      1. Copiez les opentelemetry_*.dll fichiers du C:\ProgramData\IBM\MQ\exits64 répertoire.
      2. Ajoutez le C:\ProgramData\IBM\MQ\exits64 répertoire à votre variable PATH d'environnement via la boîte de dialogue Variables d'environnement système.
      3. Redémarrez votre terminal.
      Remarque : ces étapes doivent être effectuées pour l'utilisateur IBM MQ (mqm sur Linux, MQ_USERAIX et Windows ) et tout autre utilisateur qui démarre les services MQ.
  7. Installez une version compatible d' OpenSSL, si nécessaire. Assurez-vous que le traceur est capable de résoudre les binaires d' OpenSSL s correspondant à la version requise. Si vous ne parvenez pas à mettre à jour l'installation principale d' OpenSSL, procédez de l'une des manières suivantes :

    • Linux ou AIX : Installez ou créez un lien vers une installation secondaire d' OpenSSL dans le /opt/instana/tracing/ibmmq/lib répertoire.
    • Windows : Installez ou liez une installation secondaire d' OpenSSL au C:\ProgramData\IBM\MQ\exits64 répertoire.

Activation d' IBM MQ Suivi des exits utilisateur

Pour activer une sortie utilisateur pour l' IBM MQ sur site, modifiez le fichier mqs.ini (pour tracer toutes les instances du gestionnaire de file d'attente sur un hôte) ou qm.ini (pour tracer un gestionnaire de file d'attente spécifique).

Les fichiers se trouvent dans les répertoires suivants, en fonction de la plate-forme de votre serveur d' IBM MQ :

  • Linux et AIX

    • mqs.ini: /var/mqm
    • qm.ini: /var/mqm/qmgrs/<QMNAME>
  • Windows

    • mqs.ini: C:\ProgramData\IBM\MQ
    • qm.ini: C:\ProgramData\IBM\MQ\qmgrs\<QMNAME>

<QMNAME> est le nom du gestionnaire de file d'attente.

Activation du traçage pour un gestionnaire de file d'attente spécifique

Pour activer le traçage pour un gestionnaire de file d'attente spécifique, procédez comme suit :

  1. Sauvegardez le fichier qm.ini.

    • Linux et AIX : /var/mqm/qmgrs/<QMNAME>/qm.ini
    • Windows: C:\ProgramData\IBM\MQ\qmgrs\<QMNAME>\qm.ini
  2. Modifiez le qm.ini fichier et ajoutez la configuration suivante :

    • Linux et AIX :

      ApiExitLocal:
          Sequence=100
          Function=EntryPoint
          Module=/var/mqm/exits64/mqtracingexit
          Name=TracingApiExit
    • Windows:

      ApiExitLocal:
          Sequence=100
          Function=EntryPoint
          Module=C:\ProgramData\IBM\MQ\exits64\mqtracingexit
          Name=TracingApiExit

    Où :

    • Sequence: Identifie la séquence de cette sortie par rapport aux autres sorties. Une sortie avec un numéro de séquence inférieur est appelée avant une sortie avec un numéro de séquence supérieur.
    • Function: Identifie le nom du point d'entrée de la fonction dans le module qui contient le code des exits utilisateur.
    • Module: Contient le code des exits utilisateur. Si cette zone contient le nom de chemin complet du module, il est utilisé en l'état. Si ce champ contient uniquement le nom du module, celui-ci est localisé à l'aide de ExitsDefaultPath l'attribut dans le qm.ini fichier ExitPath .
    • Name: Le nom descriptif de l'utilisateur existe.
  3. Sauvegardez les modifications.

  4. Redémarrez l'instance du gestionnaire de file d'attente pour appliquer les modifications.

Pour plus d'informations sur l'activation d'une sortie utilisateur pour l' IBM MQ, consultez le guide « IBM MQ ».

Activation du traçage pour toutes les instances du gestionnaire de file d'attente

Pour activer le traçage pour toutes les instances du gestionnaire de file d'attente sur un hôte, procédez comme suit :

  1. Sauvegardez le fichier mqs.ini.

    • Linux et AIX : /var/mqm/mqs.ini
    • Windows: C:\ProgramData\IBM\MQ\mqs.ini
  2. Modifiez le mqs.ini fichier et ajoutez les configurations suivantes :

    • Dans les fichiers Linux et AIX, ajoutez les lignes suivantes :

      ApiExitCommon:
        Sequence=100
        Function=EntryPoint
        Module=/var/mqm/exits64/mqtracingexit
        Name=TracingApiExit
    • Dans le fichier Windows, ajoutez les lignes suivantes :

      ApiExitCommon:
        Sequence=100
        Function=EntryPoint
        Module=C:\ProgramData\IBM\MQ\exits64\mqtracingexit
        Name=TracingApiExit
    Remarque : lorsque le gestionnaire de file d'attente démarre, les attributs de cette strophe sont lus, puis remplacés par la sortie utilisateur définie dans le qm.ini fichier.
  3. Sauvegardez les modifications.

  4. Redémarrez les instances du gestionnaire de file d'attente pour appliquer les modifications.

Configuration d' IBM MQ Tracing

Pour configurer le traçage pour l' IBM MQ sur site, procédez comme suit :

  1. Go vers le exits64 répertoire :

    • Linux et AIX : /var/mqm/exits64
    • Windows: C:\ProgramData\IBM\MQ\exits64
  2. Modifiez le mqtracingexit.conf fichier pour toutes les instances du gestionnaire de file d'attente ou le mqtracingexit_<QMNAME>.conf fichier pour un gestionnaire de file d'attente spécifique.

     # The configuration items for IBM MQ Tracing user exit 2026.1.3
     LOG_LEVEL="error"                      # The log level of the tracing user exit, which can be set to error, warn, info, or debug. The default value is error.
     SPAN_FORMAT="instana"                  # The trace system to which the span data is sent. The default value is "instana", but you can also change it to "otel" to send the span data to an OpenTelemetry collector.
     MONITOR_LEVEL="normal"                 # The tracing level of the queue manager(s), which can be set to off, quiet, normal, or debug. The default value is normal.
     IBMMQ_FF_SEND_METRICS = "off"         # Feature flag to include message backout count metrics in trace spans. Set to "on" or "off" (default: off).
     #IBMMQ_DEST_MONITOR_LEVEL_OFF = ""     # The regex for message destinations with MONITOR_LEVEL(tracing level) off, for example: "^TMPQ.*". An example for multiple conditions: "^SYSTEM\\.AUTH\\..*|^TEMP\\.QUEUE\\..*".
     #IBMMQ_DEST_MONITOR_LEVEL_QUIET = ""   # The regex for message destinations with MONITOR_LEVEL(tracing level) quiet.
     #IBMMQ_DEST_MONITOR_LEVEL_NORMAL = ""  # The regex for message destinations with MONITOR_LEVEL(tracing level) normal. 
     #IBMMQ_DEST_MONITOR_LEVEL_DEBUG = ""   # The regex for message destinations with MONITOR_LEVEL(tracing level) debug.
     #IBMMQ_PUBSUB_SUPPORT = "off"          # The switch for the pubsub support, which can be set to on or off. The default value is off.
     #IBMMQ_RFH2_HEADERS_TO_EXPOSE = ""     # A list of message headers that should be included in the span payload, with each header separated by commas.
     #INSTANA_AGENT_HOST = "localhost"      # The Instana agent host, localhost will be used by default.
     #INSTANA_AGENT_PORT = 42699            # The Instana agent port, 42699 will be used by default.
     #INSTANA_AGENT_PROTO = "http"          # The connection type between mq tracing exit and instana agent; http and https are supported; http will be used by default.
     #HOST_ALIAS="<YOUR-HOST-NAME>"         # The host name to match with instana agent configuration.yaml.
     #LOCAL_SOURCE_ADDRESS = ""             # The local source ip address for outgoing traffic; if not specified, a local address will be automatically allocated by default.
    
     #The following three configuration items only apply when the SPAN_FORMAT is set to "otel".
     #OTLP_EXPORTER_GRPC_ENDPOINT = ""      # The grpc endpoint to which the span data is sent. The default value is "localhost:4317".
     #OTLP_EXPORTER_SSL_CACERT_PATH = ""    # The path of the CA certificate file to verify the certificate of the target OpenTelemetry collector. Used only for GRPC exporter.
     #OTLP_EXPORTER_HTTP_URL = ""           # The http url to which the span data span data is sent. For example, "http://localhost:4318:/v1/traces".
     #OTEL_EXPORTER_OTLP_HEADERS=""         # Custom headers to include in OTLP requests, formatted as key-value pairs separated by commas. For example: "api-key=secret,custom-header=value".
     #OTEL_RESOURCE_ATTRIBUTES=""           # Resource attributes to attach to all telemetry data, formatted as key-value pairs separated by commas. For example: "service.name=my-service,deployment.environment=production".

    Pour plus d'informations sur les paramètres de configuration, consultez la section Paramètres de configuration.

  3. Sauvegardez le fichier.

  4. Redémarrez les instances du gestionnaire de file d'attente.

Remarque : les versions 246 et ultérieures d' Instana prennent en charge la définition d'un nom de service personnalisé pour la sortie utilisateur de traçage d' IBM MQ. Pour définir un nom de service personnalisé, configurez la variable INSTANA_SERVICE_NAME d'environnement pour les processus de l' IBM MQ.

Paramètres de configuration

Le tableau suivant répertorie les paramètres de configuration :

Tableau 1. Paramètres de configuration
Paramètre Description
LOG_TARGET Spécifie la destination de la sortie du journal. Les valeurs prises en charge sontsystem etfile. La valeur par défaut estfile. Cettesystem option enregistre les journaux dans le syslog sur les systèmes d' Linux s et UNIX, et dans le journal des événements sur les systèmes d' Windows s.
LOG_LEVEL Spécifie le niveau de journalisation :info,warn,error, oudebug. Les fichiers journaux sont stockés à l'adresse/tmp/ibmmqtrace ( Linux ou AIX ) ouC:\ProgramData\IBM\MQ\trace ( Windows ). Pour modifier le répertoire par défaut des fichiers journaux, consultez les étapes déc rites dans la section « Fichiers journaux pour le traçage d' IBM MQ ».
SPAN_FORMAT Spécifie le système de trace auquel les données de portée sont envoyées. Définissez cette variable surinstana. Par défaut, les données sont envoyées au point de terminaison de l'agenthttp://localhost:42699 hôte. Pour envoyer les données de span à un agent hôte distant à l'aide du protocole HTTPS, mettez à jour les élémentsINSTANA_AGENT_HOST de configuration suivants INSTANA_AGENT_PROTO: LeSPAN_FORMAT paramètre doit être identique pour les hôtes IBM MQ.
MONITOR_LEVEL Spécifie le niveau de traçage par défaut pour les gestionnaires de file d'attente :off,quiet,normal, ou debugoff: Aucune donnée de suivi n'est collectéequiet Les informations de traçabilité ne sont pas incluses dans tous les messages, mais ceux-ci peuvent tout de même être tracés dans le serveur d' IBM MQnormal Les informations de corrélation de trace sont ajoutées aux messages comportant des en-têtes « RFH2 » ou des propriétés nommées, mais ne sont pas ajoutées aux messages textedebug Les informations de corrélation de trace sont ajoutées à tous les messages qui font l'objet d'une trace.
IBMMQ_DEST_MONITOR_LEVEL_OFF Spécifie les destinations des messages avec le niveau de offtraçage. La valeur doit être une expression régulière, par exemple"^TMPQ.*". Cela signifie que les messages envoyés aux destinataires dont l'adresse commence parTMPQ ne sont pas tracés. Pour garantir l'intégrité de la transaction, conservez le même niveau de traçabilité pour les destinations des messages dans la même chaîne de messagerie. Si une destination de message correspond à plusieurs expressions régulières, l'ordre de priorité des expressions régulières prises en compte est le suivant :OFF,QUIET,NORMAL, etDEBUG.
IBMMQ_DEST_MONITOR_LEVEL_QUIET Spécifie les destinations des messages en fonction du niveau de quiettraçabilité. La valeur doit être une expression régulière. Si une destination de message correspond à cette expression régulière, les informations de corrélation de trace ne sont pas ajoutées à tous les messages envoyés à cette destination. Mais vous pouvez toujours retracer les messages dans le serveur IBM MQ.
IBMMQ_DEST_MONITOR_LEVEL_NORMAL Spécifie les destinations des messages avec le niveau de normaltraçage. La valeur doit être une expression régulière. Si la destination du message correspond à cette expression régulière, les informations de corrélation de trace sont ajoutées aux messages avec des en-têtes d' RFH2 s ou des propriétés nommées. Mais les informations de corrélation des traces ne sont pas ajoutées aux messages texte.
IBMMQ_DEST_MONITOR_LEVEL_DEBUG Indique les destinataires des messages en fonction du niveau de debugtraçabilité. La valeur doit être une expression régulière. Si la destination du message correspond à cette expression régulière, les informations de corrélation de trace sont ajoutées à tous les messages envoyés à cette destination. Dans « Windows », les niveaux de surveillance de la file d'attente de destination (IBMMQ_DEST_MONITOR_LEVEL_*) et le niveau de surveillance global (MONITOR_LEVEL) ne peuvent pas être utilisés conjointement en raison d 'un problème connu.
IBMMQ_FF_SEND_METRICS Activez cet indicateur pour permettre l'envoi d'attributs numériques en tant que métriques dans les spans d' Instana. Seul cetMQMDBackoutCount attribut est pris en charge.
IBMMQ_PUBSUB_SUPPORT Contrôle la prise en charge du traçage des messages de publication et d'abonnement. Réglez-le suron pour activer la prise en charge etoff sur pour la désactiver.
IBMMQ_RFH2_HEADERS_TO_EXPOSE Spécifie une liste d'en-têtes de message qui doivent être inclus dans la charge utile de la balise span; chaque en-tête est séparé par une virgule, par exemple.IBMMQ_RFH2_HEADERS_TO_EXPOSE="rfh2_folder1.header1, rfh2_folder2.header2, header3" Tout en-tête de message dont la taille dépasse 256 octets est tronqué afin d'éviter la création d'une taille d'intervalle trop importante qui affecterait les performances globales. De plus, la longueur totale de tous les en-têtes de messages collectés dans une période donnée ne doit pas dépasser 3 Ko. Par conséquent, seuls les en-têtes les plus importants doivent être configurés pour la collecte.
INSTANA_AGENT_HOST Spécifie l'hôte de l'agent auquel les données de type span au format Instana sont envoyées. Par défaut, localhost est utilisé. Si vous indiquez un hôte d'agent distant, ajoutez d'abord une lignehttp.listen=* pour*instanaAgentDir*/etc/instana/com.instana.agent.main.config.Agent.cfg l'agent de l'hôte distant, car par défaut, cet agent n'est pas accessible depuis les autres hôtes.
INSTANA_AGENT_PORT Indique le port sur lequel l'agent d' Instana est à l'écoute; c'est42699 celui utilisé par défaut. Vous devez modifier le port uniquement lorsque l'agent écoute sur un autre port.
INSTANA_AGENT_PROTO Spécifie le type de connexion entre la sortie de traçage de l' IBM MQ et l'agent hôte. IBM MQ Le capteur prend en charge les protocoles HTTP et HTTPS. Cependant, HTTP est utilisé par défaut. Pour changer le protocole en HTTPS, vous devez d'abord sécuriser le point de terminaison de l'agent. Pour plus d'informations sur la sécurisation du point de terminaison de l'agent, consul tez la section « Configuration du chiffrement de l' TLS pour le point de terminaison de l'agent ».
HOST_ALIAS Spécifie un alias d'hôte pour les données de segment collectées par la sortie utilisateur de trace d' IBM MQ. Vous pouvez associer les appels à IBM MQ à l'entité d'infrastructure si le capteur d' IBM MQ s surveille également le gestionnaire de file d'attente. Le nom de domaine complet (FQDN) de l'hôte MQ est utilisé par défaut. La valeur de l'alias hôte doit correspondre à l'hôte IBM MQ spécifié dans la configuration YAML de l'agent hôte. Si le nom de domaine complet (FQDN) de l'hôte IBM MQ n'est pas utilisé dans la configuration du capteur IBM MQ et que l'agent hôte ne se trouve pas sur l'hôte local IBM MQ, spécifiez un alias d'hôte. Le capteur IBM MQ peut détecter le nom de domaine complet (FQDN) des instances locales du gestionnaire de file d'attente.
LOCAL_SOURCE_ADDRESS Spécifie l'adresse IP source locale pour le trafic sortant provenant de IBM MQ Tracing user exit. Vous devez le configurer uniquement si votre serveur IBM MQ dispose de plusieurs interfaces réseau et que vous souhaitez lier tout le trafic sortant de IBM MQ Tracer la sortie utilisateur vers une interface réseau spécifique.
OTLP_EXPORTER_GRPC_ENDPOINT Spécifie le point de terminaison OTLP gRPC vers lequel les données de span d' OpenTelemetry sont envoyées lorsqu'ilSPAN_FORMAT est activéotel. La valeur par défaut estlocalhost:4317. Si l'option « TLS » est activée sur le point de terminaison gRPC, procédez également à la configurationOTLP_EXPORTER_SSL_CACERT_PATH. Sur la plateforme AIX, le protocole OTLP gRPC (activé lors de la configurationOTLP_EXPORTER_GRPC_ENDPOINT) n'est pas disponible; c'est pourquoi HTTP est utilisé par défaut.
OTEL_EXPORTER_OTLP_HEADERS Spécifie les en-têtes personnalisés à envoyer avec les données de portée d' OTLP lorsque SPAN_FORMAT est défini sur otel. Les en-têtes doivent être fournis sous forme de paires clé-valeur séparées par des virgules, au key1=value1,key2=value2 format. Ce paramètre est utile pour les jetons d'authentification, les clés d' API, ou d'autres métadonnées requises par le point de terminaison du collecteur OTLP. Par exemple, Authorization=Bearer token123,X-Custom-Header=value.
OTEL_RESOURCE_ATTRIBUTES Spécifie les attributs de ressource à associer à toutes les sections « span » de l' OTLP lorsque SPAN_FORMAT est défini sur otel. Les attributs de ressource fournissent des informations contextuelles sur la source des données de télémétrie. Les attributs doivent être fournis sous forme de paires clé-valeur séparées par des virgules, selon ce key1=value1,key2=value2 format. Parmi les attributs courants, on trouve service.name, service.version, et deployment.environment. Par exemple, service.name=my-mq-service,service.version=1.0.0,deployment.environment=production. Ces attributs permettent d'identifier et de classer les intervalles dans les plateformes d'observabilité.

Gestion des journaux de traçage d' IBM MQ

L'exit utilisateur de traçage de l' IBM MQ peut écrire des journaux dans le système de fichiers ou dans les mécanismes de journalisation du système. Utilisez le LOG_TARGET paramètre de configuration pour contrôler ce comportement.

Fichiers journaux

IBM MQ Les journaux de suivi sont enregistrés dans mqExit*.log des fichiers. Pour définir le niveau de journalisation du traçage « IBM MQ », modifiez le LOG_LEVEL paramètre de configuration dans l'exit utilisateur du traçage « IBM MQ ».

  • Sur Linux et AIX, les fichiers journaux se trouvent par défaut dans le /tmp/ibmmqtrace répertoire.

    Pour modifier le répertoire par défaut des fichiers journaux de suivi de l' IBM MQ, procédez comme suit :

    1. Définissez la variable d'environnement INSTANA_IBMMQ_TRACE_DIR sur l'hôte de l' IBM MQ. Définissez cette variable d'environnement pour tous les utilisateurs qui peuvent démarrer les processus d' IBM MQ. Sinon, si vous n'avez pas défini cette variable d'environnement et que vous démarrez les processus IBM MQ, les fichiers journaux sont placés dans le répertoire par défaut.
    2. Redémarrez les instances du gestionnaire de file d'attente.
  • Sur Windows, les fichiers journaux se trouvent par défaut dans le C:\ProgramData\IBM\MQ\trace répertoire. Par défaut, les fichiers journaux de traçage de l' IBM MQ sont préfixés par mqExit.

    Pour modifier ce préfixe par défaut pour les fichiers journaux de traçage de l' IBM MQ, procédez comme suit :

    1. Définissez la variable d'environnement INSTANA_IBMMQ_TRACE_PREFIX sur l'hôte de l' IBM MQ. Définissez cette variable d'environnement pour tous les utilisateurs qui peuvent démarrer les processus d' IBM MQ. Sinon, si vous n'avez pas défini cette variable d'environnement et que vous démarrez les processus IBM MQ, les fichiers journaux sont préfixés par mqExit.
    2. Redémarrez les instances du gestionnaire de file d'attente.

Journalisation du système

Vous pouvez configurer le traçage d' IBM MQ pour que les messages de journalisation soient enregistrés dans le système de journalisation natif du système d'exploitation plutôt que dans des fichiers journaux.

Linux et AIX

Sur les systèmes Linux et AIX, vous pouvez configurer la commande exit pour qu'elle envoie des messages au service de journalisation du système (syslog). Cette configuration permet au démon syslog du système de capturer les messages de traçage d' IBM MQ et de les traiter conformément à la configuration syslog.

Pour activer la journalisation du système, procédez comme suit :

  1. Dans le mqtracingexit.conf fichier, définissez le paramètre de configuration approprié pour configurer la sortie de traçage de l' IBM MQ e afin qu'elle utilise la journalisation système.
  2. Les messages sont consignés dans le syslog via le service utilisateur. Vous pouvez filtrer et acheminer les messages à l'aide de la configuration syslog standard, généralement dans /etc/syslog.conf ou /etc/rsyslog.conf.
  3. Consultez les messages en utilisant l'une des méthodes suivantes :

    • Sur les systèmes basés sur systemd, utilisez la journalctl commande.
    • Consultez les fichiers journaux dans le /var/log/ répertoire.

Windows

Sur les systèmes d' Windows, vous pouvez configurer la commande « exit » pour qu'elle enregistre une entrée dans le journal des événements d' Windows. Cette configuration nécessite la création d'une source de journal d'événements personnalisée pour le traçage d' IBM MQ.

Pour configurer l'intégration du journal des événements d' Windows, procédez comme suit :

  1. Créez la structure de clés de registre du journal des événements :

    • Ouvrez l'Éditeur du Registre ( regedit.exe ) en tant qu'administrateur
    • Accédez à ou créez : Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EventLog\Instana\IBM-MQ
  2. Ajoutez la valeur de registre « EventMessageFile » :

    • Nom: EventMessageFile
    • Type : REG_EXPAND_SZ (Valeur de chaîne extensible)
    • Données : %systemroot%\System32\mscoree.dll

    Cette valeur indique la DLL qui contient les ressources de mise en forme des messages.

  3. Ajoutez la valeur de registre « TypesSupported » :

    • Nom: TypesSupported
    • Type : REG_DWORD (DWORD 32 bits)
    • Données : 0x00000007 (hexadécimal) ou 7 (décimal)

    Cette valeur est un masque de bits qui active tous les types d'événements :

    • 0x0001 = Événements d'erreur
    • 0x0002 = Événements d'alerte
    • 0x0004 = Séances d'information
    • 0x0007 = Tous les types d'événements (Erreur + Avertissement + Information)
  4. Redémarrez le gestionnaire de file d'attente après avoir modifié le registre afin de vous assurer que la configuration soit prise en compte.
  5. Consultez les événements :

    • Ouvrez l'Observateur d'événements ( eventvwr.msc )
    • Accédez à : Journaux des applications et des services → Instana → IBM - MQ

    IBM MQ Les messages de traçage s'affichent avec les niveaux de gravité appropriés.

Remarque : les messages de niveau débogage ne sont pas consignés dans le journal système ni dans le journal des événements.

Envoi des données de portée d' OpenTelemetry s au récepteur d' OTLP s

IBM MQ Le traçage sur Linux et Windows peut générer des données d'étendue au format OpenTelemetry. Les données peuvent ensuite être envoyées à un récepteur utilisant le protocole OpenTelemetry ( OTLP ), tel que OpenTelemetry Collector ou Jaeger Collector. Le récepteur d' OTLP s exporte ensuite les données vers le backend d'observabilité pour un traitement ultérieur.

Pour générer des données d'envergure d' OpenTelemetry s et les envoyer au récepteur OTLP, procédez comme suit :

  1. Accédez au serveur IBM MQ et ouvrez le fichier mqtracingexit.conf de configuration pour IBM MQ Tracing user exit.
  2. Définissez le champ SPAN_FORMAT sur otel.
  3. Pour envoyer les données de portée à un récepteur OTLP gRPC, spécifiez le point de terminaison gRPC dans le champ OTLP_EXPORTER_GRPC_ENDPOINT. La valeur par défaut est localhost:4317. Si TLS est activé pour le point de terminaison gRPC, indiquez le chemin d'accès au fichier de certificat CA dans le champ OTLP_EXPORTER_SSL_CACERT_PATH. Ce fichier de certificat vérifie le certificat du point de terminaison cible OTLPgRPC.
  4. Si vous souhaitez utiliser un récepteur OTLP HTTP, indiquez l' URL du point de terminaison OTLP HTTP dans le champ OTLP_EXPORTER_HTTP_URL. Par exemple, http://localhost:4318/v1/traces.
  5. Facultatif : pour envoyer des en-têtes personnalisés avec les données de la période « OTLP », indiquez-les dans le champ OTEL_EXPORTER_OTLP_HEADERS sous forme de paires clé-valeur séparées par des virgules. Par exemple, Authorization=Bearer token123,X-Custom-Header=value. Utilisez ce paramètre pour l'authentification ou pour transmettre des métadonnées au collecteur OTLP.
  6. Facultatif : pour associer des attributs de ressource à toutes les portées « OTLP », indiquez-les dans le champ OTEL_RESOURCE_ATTRIBUTES sous forme de paires clé-valeur séparées par des virgules. Par exemple, service.name=my-mq-service,service.version=1.0.0,deployment.environment=production. Ces attributs fournissent des informations contextuelles sur la source des données de télémétrie.
  7. Redémarrez les instances du gestionnaire de file d'attente.

Vous pouvez configurer cette fonctionnalité pour IBM MQ sur un cluster Red Hat OpenShift en définissant des variables d'environnement équivalentes au pod du gestionnaire de file d'attente. Pour plus d'informations sur la configuration des variables d'environnement pour le pod du gestionnaire de file d'attente, consultez la section Configuration du traçage d' IBM MQ s sur un cluster Red Hat OpenShift.

Mise à niveau du traçage d' IBM MQ

Lorsqu'une nouvelle version de l'exit utilisateur de traçage d' IBM MQ s est disponible, vous pouvez la mettre à niveau comme suit :

Mise à niveau sur Linux ou AIX

Pour mettre à niveau le traçage d' IBM MQ s sur Linux ou AIX, procédez comme suit :

  1. Si l'agent Instana s'exécute sur le serveur IBM MQ, arrêtez les instances du gestionnaire de file d'attente et l'agent Instana.
  2. Sauvegardez les fichiers de configuration pour l' IBM MQ Suivez la sortie utilisateur dans le /var/mqm/exits64 répertoire sur le serveur IBM MQ.
  3. Extrayez les fichiers de sortie utilisateur de traçage téléchargés IBM MQ et remplacez les fichiers correspondants dans le /var/mqm/exits64 répertoire.
  4. Dans le /opt/instana/tracing/ibmmq/lib répertoire, remplacez les libopentelemetry dépendances par les dépendances libopentelemetry mises à jour.
  5. Si l'agent d' Instana s a été arrêté à l'étape 1, redémarrez les instances du gestionnaire de file d'attente et l'agent d' Instana s.

mise à niveau sous Windows

Pour mettre à niveau le traçage d' IBM MQ s sur Windows, procédez comme suit :

  1. Si l'agent Instana s'exécute sur le serveur IBM MQ, arrêtez les instances du gestionnaire de file d'attente, l' IBM MQ Explorer et l'agent Instana.
  2. Sauvegardez les fichiers de configuration pour l' IBM MQ Suivez la sortie utilisateur dans le C:\ProgramData\IBM\MQ\exits64 répertoire sur le serveur IBM MQ.
  3. Extrayez le fichier de sortie utilisateur de traçage téléchargé IBM MQ et remplacez les fichiers correspondants dans le C:\ProgramData\IBM\MQ\exits64 répertoire.
  4. Si l'agent Instana a été arrêté à l'étape 1, redémarrez les instances du gestionnaire de file d'attente, l' IBM MQ Explorer et l'agent Instana.

Désactivation du traçage d' IBM MQ

Pour désactiver la collecte des données de traçage dans IBM MQ, définissez MONITOR_LEVEL sur off dans le mqtracingexit.con fichier. Voir Configuration du traçage d' IBM MQ.

Pour désactiver la sortie utilisateur de traçage d' IBM MQ, procédez comme suit sur les hôtes d' IBM MQ :

  1. Supprimez les ApiExitCommon strophes ApiExitLocal et que vous avez configurées dans le /var/mqm/mqs.ini fichier C:\ProgramData\IBM\MQ\mqs.ini ou.
  2. Supprimez le /var/mqm/qmgrs/<QMNAME>/qm.ini fichier C:\ProgramData\IBM\MQ\qmgrs\<QMNAME>\qm.ini ou des hôtes IBM MQ s où le traçage IBM MQ est activé.
  3. Redémarrez les instances du gestionnaire de file d'attente, l' IBM MQ Explorer et l'agent Instana si l'agent Instana s'exécute sur le serveur IBM MQ.