Use the mqsichangebluemixreporting command to configure integration servers to send data to services in the IBM® Cloud. You can configure your integration servers to send startup and usage information to the IBM Cloud Product Insights service, to send logging and statistics data to the IBM Cloud Log Analysis service, or both.
The IBM Cloud Log Analysis service is part of IBM Cloud (formerly Bluemix®). IBM Cloud Product Insights is a service that is available on IBM Cloud Private. Ensure that your version (and fix-pack level) of IBM App Connect Enterprise is compatible with the level of the services that you are using, before you enable IBM App Connect Enterprise to connect to them.
You can use the mqsichangebluemixreporting command to configure a connection to IBM Cloud Log Analysis, and send it logging data (BIP messages), Activity Log data, resource statistics, and message flow statistics and accounting data. You can then use a Kibana dashboard to view the reported data for all your integration servers, both those associated with an integration node and those running independently of an integration node. IBM Cloud Log Analysis can also receive logging events from other products such as IBM MQ, WebSphere® Liberty, and IBM Business Process Manager, which means that you can create single queries that include events from multiple products and view the results in one place.
You can also use the mqsichangebluemixreporting command to configure a connection to IBM Cloud Product Insights and send it startup and usage information for a specified integration server or for all integration servers on a specified integration node. Optionally, you can configure the connection via a specified HTTP proxy server. You can then use a dashboard in IBM Cloud to view the usage information for your integration servers, including the CPU time, resident set size, and the number of active CPUs.
You run the mqsichangebluemixreporting command from the host machine that is running your integration server (typically on-premise) to activate the reporting feature, and the IBM Cloud service receives notifications at the specified times. The Product Insights service is notified each time an integration server starts, and the Log Analysis service receives data about the integration server at specified intervals.
You can run the mqsichangebluemixreporting command multiple times. Each time you run the command, only the values set by the specified parameters are updated; any other previously set values remain unchanged. For example, you might want to run the mqsichangebluemixreporting command once to configure your integration servers to send startup and usage information to the Product Insights service, and then run the command again to configure the integration servers to send logging information to the Log Analysis service. Any configuration that was set when you ran the command previously is retained unless you specify a new value for a parameter that was set previously.
As a further example, if you run the command once and specify only the name of the integration node and the -j (apiHost) and -k (apiKey) parameters, the configuration applies to all integration servers owned by the integration node, and the reporting state for startup and usage (which is set by the -c parameter) is set to inactive by default. You can then run the command again at a later date, setting the -c parameter to active, and all other previously set parameter values are then used for reporting the startup and usage information to the Product Insights service.
The changes that are made by the mqsichangebluemixreporting command become effective the next time the integration server starts. For information about starting the integration server, see Starting an integration server.
Logging and statistics data:
If you activate the logging capability (by specifying the -l parameter on the mqsichangebluemixreporting command), BIP messages that are triggered by integration server events are sent to IBM Cloud Log Analysis. The logging data that is sent contains information about the events that are issued by the integration server process; events that are initiated by other components are not reported. If you compare the contents of the local event log with the contents of the log in the Kibana dashboard, you will see that a very small number of messages at the beginning and end of the local log are not shown in the dashboard; these are typically messages about the start and end of the message logging process.
If you have configured the integration server to send statistics and accounting data, resource statistics data, or activity log data to IBM Cloud Log Analysis (by setting properties in the server.conf.yaml configuration file for the integration server), that data is also displayed on the Kibana dashboard. For more information, see Configuring an integration server by using the server.conf.yaml file and Reporting logging and statistics data to IBM Cloud Log Analysis and displaying it in a Kibana dashboard.
Refer to the online Kibana documentation for information about using Kibana, and see the IBM App Connect Enterprise Dashboard for an example of how to create your own customized dashboard.
Startup and usage reporting:
You can override the host name that the integration server reports to IBM Cloud Product Insights, by setting the MQSI_BLUEMIXREPORTING_HOSTNAME environment variable. This can be useful if you are running the integration server in a container.
>>-mqsichangebluemixreporting-----------------------------------> >--+-integrationNodeName--+-----------------------------+-+-----> | +- -e --integrationServerName-+ | | '- -g ------------------------' | '- -w --workDir----------------------------------------' >--+-------------------------+--+---------------+---------------> '- -c --startupUsageState-' '- -j --apiHost-' >--+--------------+--+-----------------+------------------------> '- -k --apiKey-' '- -y --httpProxy-' >--+------------------+--+-----------------+--------------------> '- -m --intMinutes-' '- -n --groupName-' >--+--------------------+--+--------------+---------------------> '- -l --loggingState-' '- -r --region-' >--+--------------------+--+-------------+----------------------> '- -o --organization-' '- -a --space-' >--+----------------+--+----------------+-----------------------> '- -u --username-' '- -p --password-' >--+------------------+--+----------------+---------------------> '- -s --intSeconds-' '- -x --hostname-' >--+-----------------------+--+--------------------+----------->< '- -i --spaceIdentifier-' '- -t --loggingToken-'
The specified directory must already exist and it must be the work directory of an integration server. The work directory is created by the mqsicreateworkdir command. For more information, see Configuring an integration server by using the server.conf.yaml file.
If this parameter is set to active, valid values must also be specified (or must have been specified previously) for the -x (hostname:portnumber) and -a (space) parameters.
The logging state is inactive by default.
If this parameter is set to active, valid values must also be specified (or must have been specified previously) for the -j and -k parameters.
The reporting state is inactive by default.
A value for this parameter must be specified (or must have been specified previously) if the -c parameter is set to active.
A value for this parameter must be specified (or must have been specified previously) if the -c parameter is set to active.
Always enter the command on a single line; in some examples, line breaks have been added to enhance readability.
mqsichangebluemixreporting -w c:\myaceworkdir -c active
-n Test -j https://productinsights-api.ng.bluemix.net -m 15
-k ab232e28-6aed-4365-8996-7457d176b0c7
The -j parameter specifies the API host for your region (where your data will be sent), as specified in your service credentials. To find your API host, check the information that is specified in the credentials for your service instance.
The -k parameter specifies the API key.
mqsichangebluemixreporting -w c:\myaceworkdir -c active -j https://hybridconnect-api.ng.bluemix.net
-k 9ec5g5c2-c5m1-3287-b2xd-c371fc22d467 -y https:mygateway.co.uk
You
can remove the setting for a previously specified proxy server by
setting the -y parameter to "".
For example:mqsichangebluemixreporting -w c:\myaceworkdir -c active -j https://hybridconnect-api.ng.bluemix.net
-k 9ec5g5c2-c5m1-3287-b2xd-c371fc22d467 -y ""
mqsichangebluemixreporting -w c:\myaceworkdir -l active -r https://api.ng.bluemix.net
-o a.user@comp.com -a dev -u a.user@comp.com -p password123
mqsichangebluemixreporting myIntegrationNode1 -e myIntegrationServer3 -c active
-n Test -j https://productinsights-api.ng.bluemix.net -m 15
-k ab232e28-6aed-4365-8996-7457d176b0c7
As an alternative to specifying a particular integration server (by using the -e parameter), you can set the -g parameter to enable reporting for all integration servers on the specified integration node.
The -j parameter specifies the API host for your region (where your data will be sent), as specified in your service credentials. To find your API host, check the information that is specified in the credentials for your service instance.
The -k parameter specifies the API key.