Managing resource statistics collection

Complete the following steps to configure the collection of resource statistics:

1. Open the server.conf.yaml configuration file for your integration server, by using a YAML editor.

   You can edit the file by using the built-in YAML editor that is provided in the IBM App Connect Enterprise Toolkit, either by double-clicking the file in the Application Development view or by right-clicking the file and selecting Open with > YAML editor. If you choose to edit the file by using a plain text editor, ensure that you do not include any tab characters (which are not valid in YAML) and use a YAML validation tool to validate the contents of your file.

   The properties that you need to set are in the Statistics section of the .yaml configuration file:

   
   Statistics:
         ...
       Resource:
       reportingOn: true         # Choose 1 of : true|false. Explicitly set to 'true' by default. If unset, defaults to 'false'.
       #outputFormat: ''         # Choose 'csvFile' or 'file' (for IIB v10 compatibility). If unset, defaults to ''.

2. Uncomment the reportingOn property and set it to true. This setting takes effect when the integration server is restarted. However, it can be changed dynamically (without restarting the integration server) by using the mqsichangeresourcestats command.

   When a node.conf.yaml or server.conf.yaml file is created, the reportingOn property is explicitly set to true, and resource statistics for the integration node or server are published to the web user interface. If the reportingOn property is unset (with a value of ''), the publication of resource statistics is turned off.

   In node.conf.yaml and server.conf.yaml files that were created prior to IBM App Connect Enterprise V11.0.0.8, the reportingOn property was set to false by default, so the publication of resource statistics was turned off. To enable the publication of resource statistics for those integration nodes or servers, edit the relevant .conf.yaml file and set the reportingOn property to true.

3. Optional: If you want the resource statistics to be published to a file (in addition to the web user interface), set the outputFormat property to csvFile. For more information, about publishing resource statistics to a file, see Reporting resource statistics to files.
4. Restart the integration server for the changes to take effect.
   For more information about how to start an integration server, see Starting an integration server.

1. Start the web user interface for your integration node; see Accessing the web user interface.
   The integration servers that are owned by the integration node are displayed as tiles under the Servers tab.
2. Click the Open List of Options icon for the required integration server.
   • If you are viewing all the available servers under the Servers tab, the Open List of Options icon appears within the tile for each integration server.
3. Click Open in the drop-down menu to view the content of the integration server under the Contents tab.
4. Click the Open List of Options icon.
   • If you are viewing the content of an integration server under the Contents tab, the Open List of Options icon appears in the title bar for the integration server.
5. Click the required option in the drop-down menu.
   • To start collecting resource statistics for this integration server, click Resource statistics on in the drop-down menu.
   • To stop collecting resource statistics for this integration server, click Resource statistics off in the drop-down menu.
   If resource statistics collection is turned on for the integration server, data is displayed in the Resource Statistics tab.

1. If your integration server is running on Linux®, UNIX, or Windows systems, set up the correct command environment.
   For more information about how to complete this task, see Setting up a command environment.
2. Run one of the following commands:
   • To start or stop collecting resource statistics for a specific integration server, or for all integration servers, run the mqsichangeresourcestats command with the appropriate parameters.

     For example, to start collecting resource statistics for the default integration server for an integration node that is named INODE, enter the following command:

     mqsichangeresourcestats INODE -c active -e default 

     For example, to stop collecting resource statistics for all integration servers on an integration node that is named INODE, enter the following command:

     mqsichangeresourcestats INODE -c inactive

     By default, the settings that you specify with this command persist when the integration server or node is restarted and when the message flow is redeployed. If you do not want the settings to persist, you can specify the --non-persist parameter, which causes the settings to remain in effect only until a restart or redeploy. After a restart or redeploy, the settings that are specified in the server.conf.yaml or node.conf.yaml configuration file take effect.

     For more information, see mqsichangeresourcestats command.

   • To check the status of resource collection, run the mqsireportresourcestats command with the appropriate parameters.
     For example, to view status for the default integration server on INODE, enter:

     mqsireportresourcestats INODE -e default 

     For further examples, see the mqsireportresourcestats command.

   • To set and check the properties that control where resource statistics are reported, use the mqsichangeproperties and mqsireportproperties commands.