- 4 minutes to read

Release Notes

Configuring IBM Integration Bus Logging Agent

Info

This guide provides instructions for configuring the IBM Integration Bus Logging Agent for Nodinite.

Note

You must first make sure all Prerequisites are satisfied.

The Nodinite IBM Integration Bus Logging Agent consumes IBM Monitoring Events that you must configure with a Monitoring Profile. This is detailed in the Nodinite Logging IBM Integration Bus user guide.

Configuration File

In the installation folder (default): C:\Program Files\Nodinite\Logging Agent - IBM Integration Bus, there is a file named Settings.json, which contains the configuration for the Logging Agent.
ConfigurationFile
The Settings.json file configures the Nodinite Logging IBM Integration Bus Agent.

You can change the following options:

  • Environment - is set to Test, Prod, QA, or the domain name this Agent runs within.
  • Debug - true or false; in a production domain, this value should be set to false.
  • Version - READ ONLY; this value is internal to know if there is a need to update the configuration to the latest version (do not change this value!)
  • WmqSources is an array of Broker configurations pointing the Agent where to look for the logged IBM Integration Bus Monitor Events.
    • Name - The user-friendly configuration name.
    • Enabled - A flag indicating wheter this configuration is active, or not New 6.2.1.1
    • Server - the name of the host with the WebSphere MQ Broker.
    • Manager - The name of the WebSphere MQ Broker.
    • UserName - The name of the user to connect with the broker.
      • Password - The password for user connecting with the broker.
    • Port - the TCP port to use (default=1414).
    • Channel - the name of the Channel in use to connect with the broker.
    • UseSSL - When checked, encrypt the channel communication New 5.4.4.0.
      • CipherSpec - The name of the CipherSpec to use with this configuration. You must use any of the pre-defined values in the CipherSpecs Table
      • SSLKeyRepository - Enter the full path with the certificate files, i.e. c:\MQ\KeyDB\key.
    • LogApi - The URI to the LogApi
    • LogAgentId - The identifier for this Log Monitoring Agent Configuration.
    • PollingInterval - The polling interval in seconds (30-300).

      Note

      If you enter a value outside the allowed range, the system will automatically adjust the value to be inside the allowed range New 5.4.4.0.

    • DefaultLogStatusCode - When using ACE (Version 11/12); you may want to set this value according to your preferences. The @terminal is no longer part of the Monitoring Event.New 6.2.1.1
    • DefaultMessageTypeName - The default name of the Message Type. The default is Monitoring Event which is a bad name according to our recommendations.New 6.2.1.1
    • Queue - The name of the queue with IBM Monitoring events in XML format.
      • BadMessages - Structure for backout messages
        • QueueName

JSON configuration file example

Below is an example of a configuration file (Settings.json):

{
  "Environment": "Test",
  "Debug": true,
  "Version": "1.3",
  "WmqSources": [
    {
      "Name": "WMQ-Dev",
      "Enabled": true,
      "Server": "127.0.0.1",
      "Manager": "IMTEST",
      "Username": "immq",
      "Password": "immq",
      "Port": 1414,
      "Channel": "TEST",
      "UseSSL": false,
      "SSLCipherSpec": null,
      "SSLKeyRepository": null,
      "LogAPI": "https://nodinitesrv01/Nodinite/Dev/LogAPI/",
      "LogAgentId": 8,
      "PollingInterval": 60,
      "DefaultLogStatusCode": -1,
      "DefaultMessageTypeName": "Monitoring Event",
      "Queue": "inputQueueName",
      "BadMessages": {
        "QueueName": "BadLetterQueue"
      }
    }
  ]
}

Note

When using HTTPS, a certificate must be installed and configured... (recommended if the LogApi is not installed on 'localhost'). Use: notation with HTTPS and FQDN for server for example: "https://demo.nodinite.com/LogAPI/"

Cipher Spec Table

When using SSL, you must specify the CipherSpec to use with the Channel. Any of the following are accepted. The deprecated entries are not even listed. If you need another entry in the list; please contact our support to get an updated version.

CipherSpec
ECDHE_ECDSA_3DES_EDE_CBC_SHA256
ECDHE_ECDSA_AES_128_CBC_SHA256
ECDHE_ECDSA_AES_128_GCM_SHA256
ECDHE_ECDSA_AES_256_CBC_SHA384
ECDHE_ECDSA_AES_256_GCM_SHA384
ECDHE_ECDSA_NULL_SHA256
ECDHE_ECDSA_RC4_128_SHA256
ECDHE_RSA_3DES_EDE_CBC_SHA256
ECDHE_RSA_AES_128_CBC_SHA256
ECDHE_RSA_AES_128_GCM_SHA256
ECDHE_RSA_AES_256_CBC_SHA384
ECDHE_RSA_AES_256_GCM_SHA384
ECDHE_RSA_NULL_SHA256
ECDHE_RSA_RC4_128_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_NULL_SHA256
TLS_RSA_WITH_RC4_128_SHA256
TLS_AES_128_GCM_SHA256
TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_CCM_SHA256
TLS_AES_128_CCM_8_SHA256

The following are using TLS 1.0, which is deprecated and not allowed.

CipherSpec
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA

Next Step

Install IBM Integration Bus Logging Agent