Collecting Performance Parameters with respect to Activities and Processes

It is important to identify activity instances and process instances with respect to time and memory.

The activity instance and process instance data is collected from the Container and is stored in a database. The stored data can be retrieved by using REST APIs with the help of Swagger UI.

Prerequisites

Use the PostgreSQL database to store the activity instance and process instance data.

Procedure

  1. Set the following configuration properties in the analyzer_config.ini file stored at <BWCE_HOME>\bwce\2.x\config\analyzer_config.ini.
    Property Description
    bw.analyzer.db.create.schema Create tables on startup if not exists.

    The default value is true.

    bw.analyzer.data.interval

    Set the value in minutes, hours, or in days.

    For example: bw.analyzer.data.interval=15days.

    The default value is not set. If the property is not set the query is executed on the complete data.

    bw.analyzer.refresh.interval Refresh interval for memory cache.

    The default value is 60000 milliseconds.

    bw.analyzer.udp.host Optional. Set the UDP server host address.

    The default value is localhost.

    bw.analyzer.udp.port Optional. Set the UDP server listening port.

    The default value is 34567.

    bw.analyzer.db.driver org.postgresql.Driver

    Currently only the PostgreSQL database is supported.

    bw.analyzer.db.connectionURL Set the database connection URL.

    The default value is jdbc:postgresql://localhost:5432/analyzer

    bw.analyzer.db.userName Set the database username.

    The default value is postgres.

    bw.analyzer.db.password Set the database password.

    The default value is admin.

    bw.analyzer.log.level Set the root log level.

    The default value is info.

    bw.analyzer.jetty.server.port Set jetty server port.

    The default value is 8080.

  2. Configure the database details in analyzer_config.ini file and copy the file to <BWCE_HOME>/bwce/2.x/system/analyzer/ folder. Create the docker image and analyzer instance with docker file present under <BWCE_HOME>/bwce/2.x/system/analyzer/Dockerfile
  3. Set the BW_ANALYZER_CONFIG= <UDP server Host>:<UDP server Port> environment variable while running the application.
    This property starts sending the activity instance and process instance data from Container.

    Set the following properties in the Container's BW_JAVA_OPTS environment variable while running the application:

    Property Description
    bw.engine.analyzer.udp.host Optional. Set UDP server hostname or an IP value.

    The default value is localhost.

    bw.engine.analyzer.udp.port Optional. Set UDP server listener port value.

    The default value is 34567.

    bw.engine.analyzer.batchsize Optional. Set the threshold value for activity or process instances to analyze the data in one batch.

    The default value is 100.

    bw.engine.analyzer.publishtimer Optional. Set subscriber publisher time interval in milliseconds.

    The default value is 30000.

  4. Use REST APIs to interact with the data using Swagger UI at URL http://<hostname/IP>:<PORT>/.
    Note: Base path for all REST APIs exposed is http://<host or IP address>:<port>/api/

Example

Note: Activity instances and process instances with respect to time and memory is only applicable for Docker platform.