Configuring an integration server and loading the IBM Integration Bus Kibana dashboard (manual method)

You can use the curl command and the mqsichangebluemixreporting command to configure integration servers to send logging information (BIP messages) to IBM® Cloud Log Analysis. You can also configure them to send Activity log data, resource statistics, and message flow statistics and accounting data. You can then view the reported data in the IBM Integration Bus Kibana dashboard. You can use this configuration method regardless of whether the host machine on which you are running IBM Integration Bus has direct access to the internet.

Complete the following steps to configure an integration server to send logging information to the Log Analysis service in IBM Cloud:

1. Run the following curl command on a machine that has direct access to the internet, to obtain the logging token and IBM Cloud space identifier:

   curl -k -XPOST -d 'user= <BLUEMIX_USER>&passwd=<BLUEMIX_PASSWORD>&space=<BLUEMIX_SPACE>&organization=<BLUEMIX_ORGANIZATION>' <BLUEMIX_LOGIN_URL>

   where the BLUEMIX_LOGIN_URL is the IBM Cloud login URL for your selected region. You must specify the following IBM Cloud credentials in the command to obtain the logging token and space identifier:

   BLUEMIX_USER

   IBM Cloud user name

   BLUEMIX_PASSWORD

   IBM Cloud password

   BLUEMIX_SPACE

   IBM Cloud space

   BLUEMIX_ORGANIZATION

   IBM Cloud organization

2. Run the mqsichangebluemixreporting command from the host machine that is running IBM Integration Bus (typically on-premise) to configure and activate the logging feature.
   For example, the following command specifies that all integration servers (as specified by the -g parameter) on integration node myIntegrationNode1, will report to Log Analysis using the results obtained from the output of the curl command:

   mqsichangebluemixreporting myIntegrationNode1 -g -l active -x logs.opvis.bluemix.net 
     -i b651725a-3af6-6718-1531-396ab8782dbc -t 1f7hYBjUxvMk

   You can set the logging status to active only if valid values are specified (or have been specified previously) for the following parameters:

   -x hostName:portNumber

   Sets the host name and, optionally, the port number for logging, statistics, and accounting services.

   For -x hostname, specify the following values:

   • If you are using IBM Cloud region us_south, specify logs.opvis.bluemix.net
   • If you are using IBM Cloud region eu_gb, specify logs.eu-gb.opvis.bluemix.net

   If the host machine does not have direct access to the internet, you can use the -x host:port parameter value to specify a gateway through which the connection can be routed.

   -i spaceID

   Sets the IBM Cloud space identifier for logging, statistics, and accounting services. Take this value from the output returned from the curl command in step 1.

   -t token

   Sets the IBM Cloud logging token for logging, statistics, and accounting services. Take this value from the output returned from the curl command in step 1.

   For more information about these parameters, see mqsichangebluemixreporting command.

When you have enabled your integration servers to send logging information to Log Analysis, you can optionally enable them to send message flow statistics and accounting data:

3. Run the mqsichangeflowstats command, specifying bluemix as the output format in the -o parameter, and setting either the -a or -s parameter to active.
   For example, the following command turns on the collection of snapshot statistics data for all message flows in all integration servers for myIntegrationNode1, and emits the data in bluemix format to the Log Analysis service:

   mqsichangeflowstats myIntegrationNode1 -s -g -j -c active -o bluemix  
   

You can also choose to configure your integration servers to send resource statistics to Log Analysis, by running the mqsichangeresourcestats and mqsichangeproperties commands:

4. Run the mqsichangeresourcestats command, activating the collection of resource statistics by setting the -c parameter to active.
   For example, the following command turns on collection of resource statistics for myIntegrationServer1 on myIntegrationNode1:

   mqsichangeresourcestats myIntegrationNode1 -e myIntegrationServer1 -c active

   If you do not specify an integration server (by using the -e parameter), statistics collection is activated for all integration servers on the integration node. For more information, see mqsichangeresourcestats command.
5. Run the mqsichangeproperties command, setting the -o parameter to ComIbmResourceStatsManager, the -n parameter to bluemixReporting, and the -v parameter to active.
   For example:

   mqsichangeproperties myIntegrationNode1 -e myIntegrationServer1 -o ComIbmResourceStatsManager -n bluemixReporting -v active

   For more information, see mqsichangeproperties command.

You can also optionally configure your integration servers to send Activity Log data to the Log Analysis service, by using an ActivityLog configurable service:

6. Define a configurable service of type ActivityLog, and set the bluemixReporting property to true.
   You can define the configurable service by using either the IBM Integration Bus web user interface or the mqsicreateconfigurableservice command. For information about how to complete this step, see Creating configurable services.

When you have finished configuring the integration servers, restart the integration node and import the Kibana dashboard:

7. Restart the integration node (or all the integration servers that you have configured), for the changes to take effect.
   When the reporting status is active, data for all integration servers on the specified integration node will be sent to Log Analysis. Alternatively, if you specified a named integration server (by using the -e parameter), data will be reported for that integration server only.

   The default interval for sending events to Log Analysis is 60 seconds, so there can be a delay of up to 60 seconds before you see events in the Kibana dashboard.

8. Import the IBM Integration Bus Kibana dashboard into the Log Analysis service, by completing the following steps:
   1. Start your IBM Integration Bus integration servers.
   2. Login to your Log Analysis service using the same IBM Cloud credentials as used in Step 1 and, if necessary, switch to the same organization and space.
   3. Use the default Kibana views to ensure that logging events have been received from your configured servers. If there are no events, check your IBM Integration Bus local event log to see if there are any error messages. If there are errors, resolve them before continuing to the next step.
      The default interval for sending events to Log Analysis is 60 seconds, so there can be a delay of up to 60 seconds before you see events in the Kibana dashboard. By default, the Kibana dashboard shows events that it has received during the previous 15 minutes; if you do not see any events, you might consider increasing this time limit.
   4. Click the Kibana 5 tab, then click Settings.
   5. Click the first entry in the Index Pattern list, in the upper left corner of the window, to show the full index and reveal the action buttons.
   6. Click Reload field list and then click OK.
   7. Review the field list and ensure that it contains entries from IBM Integration Bus, such as ibm_messageId.
   8. Select the Discover tab under Kibana 5.
   9. Click the Load saved search (open folder) button, then Manage searches. Navigate to the BluemixReporting subdirectory of the work path directory (as defined by the MQSI_WORKPATH environment variable), and then the integration node subdirectory. For example, C:\ProgramData\IBM\MQSI\BluemixReporting\myIntegrationNode. This folder contains your prepared IBM Integration Bus dashboard files.
   10. Select the file IIB_K5_query_< Bluemix space identifier >.json and import it.
   11. Select the Visualize tab under Kibana 5.
   12. Click Manage searches and navigate to the folder contains your prepared IBM Integration Bus dashboard files.
       To find these files, go to the BluemixReporting subdirectory of the work path directory (defined by the MQSI_WORKPATH environment variable), and then the integration node subdirectory. For example, C:\ProgramData\IBM\MQSI\BluemixReporting\myIntegrationNode. This folder contains your prepared IBM Integration Bus dashboard files.
   13. Select the file IIB_K5_visuals_< Bluemix space identifier >.json and import it.
   14. Select the Dashboard tab under Kibana 5.
   15. Click Manage searches and navigate to the folder contains your prepared IBM Integration Bus dashboard files.
       To find these files, go to the BluemixReporting subdirectory of the work path directory (defined by the MQSI_WORKPATH environment variable), and then the integration node subdirectory. For example, C:\ProgramData\IBM\MQSI\BluemixReporting\myIntegrationNode. This folder contains your prepared IBM Integration Bus dashboard files.
   16. Select the file IIB_K5_dashboard_< Bluemix space identifier >.json and import it.
9. You can now view data from your configured and restarted integration servers, by logging into the Log Analysis service and opening the IBM Integration Bus Kibana dashboard. For more information, see Viewing logging and statistics information in the IBM Integration Bus Kibana dashboard in IBM Cloud.