Setting up Bizagi Diagnostics

<< Click to Display Table of Contents >>

Navigation:  Automation Server > Automation Server configuration and administration guide > System maintenance and monitoring > Monitoring > Bizagi Diagnostics >

Setting up Bizagi Diagnostics

Overview

Bizagi Diagnostics is a toolkit that provides monitoring options for Automation Server operations in a Test or Production environment, as described at Bizagi Diagnostics.

The following section illustrates the prerequisites of Bizagi Diagnostics and how to set it up in your environment.

 

Prerequisites

Make sure you meet the following requisites before installing and using Bizagi Diagnostics:

 

At least 3 GB of free disk space and 8 GB of RAM where Bizagi Diagnostics will be installed.

 

Java Runtime Environment installed where Bizagi Diagnostics will run.

Make sure you use version 8, update 71 or higher. Check for an installed Java JRE and its versions by using a command prompt and typing:

java -version

 

JAVA_version_new

 

You can download Java JRE from Oracle's official website at: http://www.oracle.com/technetwork/java/javase/downloads/index.html

 

JAVA_HOME environment variable configured.

Check this environment variable's configuration by using a command prompt and typing:

echo %JAVA_HOME%

 

JAVAHOME_env_Var_new

 

Pre-configuring Bizagi Diagnostics

You need to configure each component to generate the logs needed by Diagnostics, on the path where the tool reads from.

To do so, edit the configuration file for each component (Work portal and Scheduler service), for each Automation Server server of your setup.

Enable its logs and specify the path where they will be stored.

 

Edit the web.config file of your Bizagi Work portal including the two lines mentioned below, within the <appSettings> element (by default located at C:\Bizagi\Projects\[your_project]\WebApplication):

 

If you are working on a clustered environment, you need to do this for each node.

 

<add key="DiagnosticsEnabled" value="true"/>

<add key="DiagnosticsStorageName" value="[Diagnostics_readFrom_path]\[name_of_node]"/>

 

Diagnostics_config1_new

 

[Diagnostics_readFrom_path]: the folder configured to read the logs from. This path is set during Bizagi Diagnostics installation.

For the Automation Server access, this may be a UNC path (e.g, \\fileServer\logsPath\).

 

[name_of_node]: This is not a sub-folder definition but a prefix you define to mark each different component in a unique manner. This way, logs read by Bizagi Diagnostics know from which component they come from. You can use W01 for a Work portal of node #1 in a cluster setup, and W02 for node #2, and so on. Similarly, you can use S01 for a Scheduler service of node #1 in a cluster setup and S02 for node #2, and so on.

Note that DiagnosticsEnabled determines if the logs become active for this component (possible values are true or false).

 

Save changes when done. Changes in this file do not require a service restart.

 

Edit the BizAgi.Scheduler.Services.exe.config file of your Scheduler service (by default at C:\Bizagi\Projects\[your_project]\Scheduler) to include the same lines as mentioned before in the <appSettings> element.

 

If you are working on a clustered environment, you need to do this for each node.

 

Save your changes when done.

Changes in this file require restarting the Scheduler from the Windows services panel, which takes up a few seconds and doesn't interrupt Automation Server operations.

 

Downloading Bizagi Diagnostics

Download the installer file directly from http://resourcesbizagi.blob.core.windows.net/docs/BizagiDiagnostics.exe.

 

Installing Bizagi Diagnostics

To install Bizagi Diagnostics, run the BizagiDiagnostics.exe installer file, with local admin rights:

 

Diagnostics_install1_new

 

Click Next in the welcome screen.

Review the terms of Bizagi Diagnostics license agreement, accept them and click Next.

 

Diagnostics_install7_new

 

Select the installation location by specifying the Destination folder

 

Diagnostics_install2_new

 

Click Next when ready.

 

Configure the path from where Bizagi Diagnostics will read logged information. This path should match the one given on the pre-configuration, where Automation Server creates logs.

 

note_pin

When defining this path, consider:

 

This path may be set as a local folder shared with Automation Server servers.

For Automation Server setups using a high availability system architecture (clusters), you would have more than one Automation Server server writing logs into this path.

If you use such a configuration, make sure that this folder can be accessed as a UNC path by Automation Server instances (e.g, \\fileServer\logsPath\), and that it is set with adequate access rights for the service account running Automation Server.

 

Diagnostics_install3_new

 

Click Next and confirm the installation by clicking Install.

The installation procedure may take a few minutes.

 

Diagnostics_install4_new

 

Click Close when done.

 

Diagnostics_install5_new

 

When the installation is complete you need to manually start three Windows services installed with Bizagi Diagnostics.

 

Open the Services tool and locate the services BizagiDiagnostics_Elasticsearch, BizagiDiagnostics_Grafana, and BizagiDiagnostics_Logstash. Then, start each service by right-clicking each service and selecting Start.

 

Diagnostics_install6_new

 

At this point, Bizagi Diagnostics is all set, and you can start to use it, as described in Using Bizagi Diagnostics.

 

Troubleshooting

As mentioned before, Bizagi Diagnostics relies on additional services such as ElasticSearch, LogStash and Grafana.

 

After the first time you start the respective services, these services should automatically start up with your machine.

If these service do not automatically start up, you need to start them up manually.