Start of change
IBM App Connect Enterprise, Version 11.0.0.2 Operating Systems: Windows, Linux


Configuring the collection of message flow accounting and statistics data

You can use integration node and integration server configuration files (node.conf.yaml and server.conf.yaml) to view and modify the settings that control the collection of message flow accounting and statistics data.

Before you begin

About this task

You can modify the properties that have been set for message flow accounting and statistics data collection. For example, you can start collecting data for a new message flow that you have deployed to an integration server for which you are already collecting data. When you restart the integration server, the new settings that you have defined in the .yaml configuration file will come into effect.

You can configure the collection of snapshot data, archive data, or both, by setting properties in the Statistics section of the configuration file (node.conf.yaml or server.conf.yaml), as shown in the following example:
Statistics:
  # Application message flows will by default inherit Snapshot and Archive values set here
  Snapshot:
    #publicationOn: 'inactive'   # choose 1 of : active|inactive, default inactive
                                 # Also set Events.OperationalEvents.MQ|MQTT for outputFormat json,xml to be published to MQ/MQTT
    #accountingOrigin: 'none'    # choose 1 of : none|basic
    #nodeDataLevel: 'none'       # choose 1 of : none|basic|advanced
    #outputFormat: 'usertrace'   # comma separated list of : csv,bluemix,json,xml,usertrace
    #threadDataLevel: 'none'     # choose 1 of : none|basic
  Archive:
    #archivalOn: 'inactive'      # choose 1 of : active|inactive, default inactive
                                 # Also set Events.OperationalEvents.MQ|MQTT for outputFormat xml to be published to MQ/MQTT
    #accountingOrigin: 'none'    # choose 1 of : none|basic
    #majorInterval: 60           # Sets the interval in minutes at which archive statistics are published
    #nodeDataLevel: 'none'       # choose 1 of : none|basic|advanced
    #outputFormat: 'usertrace'   # comma separated list of : csv,xml,usertrace
    #threadDataLevel: 'none'     # choose 1 of : none|basic

Procedure

Configure the collection of accounting and statistics data for one or more active message flows by setting the statistics properties in the configuration file for your integration node or integration server:

  1. Open the appropriate node.conf.yaml or server.conf.yaml configuration file by using a YAML editor.

    If you do not have access to a YAML editor, you can edit the file by using a plain text editor; however, you must ensure that you do not include any tab characters, because they are not valid characters in YAML files and would cause your integration server configuration to fail. If you are using a plain text editor, ensure that you use a YAML validation tool to validate the content of your file.

  2. To configure the collection of snapshot statistics data, set the following properties in the configuration file:
    1. Enable the collection of snapshot statistics data by setting the publicationOn property to active. By default, the publication of message flow statistics and accounting data is turned off.
    2. Decide the target destination and specify the appropriate format in the outputFormat property.

      If you want to display statistics in the web user interface, you must specify json as one of the values in the outputFormat property; the web user interface can display message flow statistics and accounting data that it receives only in JSON format. You can choose multiple destinations by specifying multiple comma-separated values:

      • usertrace

        User trace log (the default setting).

      • csv

        CSV format.

      • bluemix

        Logmet for IBM® Cloud format. By setting the output format to bluemix, the statistical information can be reported to IBM Cloud Log Analysis, and viewed in a Kibana dashboard. For more information, see Reporting logging and statistics data to IBM Cloud Log Analysis and displaying it in a Kibana dashboard.

      • json

        JSON publication message. If you want to display statistics in the web user interface, you must specify json as one of the values in the outputFormat property.

      • xml

        XML format publication message.

    3. Optional: Decide whether you want to associate data collection with a particular accounting origin. To report an accounting origin for the data, set the accountingOrigin property to basic. Accounting and statistics data can be accumulated and reported with reference to an identifier associated with a message in a message flow. This identifier is the accounting origin, which provides a method of producing individual accounting and statistics data for multiple accounting origins that generate input to message flows. The default for this property is none (no support). For more information, see Setting message flow accounting and statistics accounting origin.
    4. Optional: Decide whether you want to collect thread-related statistics. To include thread-related data, set the threadDataLevel property to basic. The default value for this property is none.
    5. Optional: Decide whether you want to collect node-related statistics. If you do, you can also collect information about terminals for the nodes. To include node-related data, set the nodeDataLevel property to basic, or to include node-related and terminal-related data, specify advanced.
  3. To configure the collection of archive statistics data, set the following properties in the appropriate .yaml file:
    1. Set the archivalOn property to active.
    2. Set the outputFormat property to one or more of the following values (separated by commas and enclosed by single quotes):
      • usertrace
      • csv
      • xml

      If you want to display statistics in the web user interface, you must specify json as one of the values in the outputFormat property; the web user interface can display message flow statistics and accounting data that it receives only in JSON format.

      By default, the publication of archive statistics data is turned off. If you start collection (by setting the archivalOn property to active), the default output format is usertrace.

    3. Optional: Specify the interval (in minutes) at which archive statistics are published, by setting the majorInterval property. The default is 60 minutes.
    4. Optional: To report an accounting origin for the data, set the accountingOrigin property to basic. Accounting and statistics data can be accumulated and reported with reference to an identifier associated with a message in a message flow. This identifier is the accounting origin, which provides a method of producing individual accounting and statistics data for multiple accounting origins that generate input to message flows. The default for this property is none (no support). For more information, see Message flow accounting and statistics accounting origin.
    5. Optional: To include thread-related data in the statistics, set the threadDataLevel property to basic. The default value for this property is none.
    6. Optional: To include node-related data in the statistics, set the nodeDataLevel property to basic, or to include node-related and terminal-related data in the statistics, specify advanced.
  4. Restart the integration server for the changes to take effect. For information about how to start an integration server, see Starting an integration server.

bc28570_.htm | Last updated 2018-11-02 14:46:16
End of change