Starting and stopping the collection of message flow statistics
and accounting data
You can configure your integration nodes and integration
servers to start and stop the collection of accounting and statistics
data for your message flows, by setting properties in the node.conf.yaml or server.conf.yaml configuration
files.
About this task
Start collecting accounting and statistics data for one
or more active message flows by setting the statistics properties
in the node.conf.yaml or server.conf.yaml configuration
file for your integration node or integration server.
Procedure
- 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.
You can start 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):
- To turn on the collection of snapshot statistics
data, set the following properties in the appropriate .yaml file:
- Set the publicationOn property
to active.
- Set the outputFormat property to
one or more of the following values (separated by commas and enclosed
by single quotes):
- usertrace
The data is sent to the user trace,
which must be enabled before you can view the data.
- csv
The data is sent to a set of cyclic files
in the work directory of the integration node or integration server.
- bluemix
The data is sent to IBM Cloud Log Analysis,
which must be configured before you can view the data.
- json
The data is sent to the IBM App Connect
Enterprise web user interface, and also
to MQ and MQTT, if they have been enabled and configured.
- xml
The data is sent to MQ and MQTT, if they
have been enabled and configured.
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 message flow statistics and accounting data is turned off. If you
start collection (by setting the publicationOn property
to active), the default output format is usertrace.
When the collection of snapshot statistics data is turned
on, an up-to-date snapshot of information is collected every 20 seconds.
You can view the snapshot data in the web user interface. For more
information, see Viewing message flow statistics and accounting data.
- To turn on the collection of archive statistics
data, set the following properties in the appropriate .yaml file:
- Set the archivalOn property to active.
- Set the outputFormat property to
one or more of the following values (separated by commas and enclosed
by single quotes):
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.
- Optional: If you want to configure other aspects
of message flow statistics collection, follow the steps in Configuring the collection of message flow accounting and statistics data.
- Restart the integration node or integration server for
the changes to take effect. Changes to the server.conf.yaml and node.conf.yaml files
take effect only when the modified integration node or server is restarted. The state of statistics collection that is configured in the .yaml file
is applied to all flows that are deployed when the integration server
starts, and also to any additional flows that are deployed afterwards.