Setting up Bizagi Diagnostics

<< Click to Display Table of Contents >>

Navigation:  Bizagi Engine > Bizagi system administration > Maintenance and administration > Monitoring > Bizagi Diagnostics >

Setting up Bizagi Diagnostics

Overview

Bizagi Diagnostics is a toolkit featured by Bizagi Ltd in order to provide monitoring options for Bizagi Engine 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

Ensure you meet with the following software and server configuration requisites before installing and using Bizagi Diagnostics.

 

PREREQUISITE

WHAT YOU NEED

FURTHER INFORMATION

Java (JRE) from Oracle.

Java Runtime Environment installed where Bizagi Diagnostics will run.

Ensure you use version 8, update 71 or higher.

You may check for installed Java JRE and its versions by using a command prompt and typing (it should list the current version):

java -version

 

JAVA_version

 

You may download Java JRE from Oracle's official website at:

http://www.oracle.com/technetwork/java/javase/downloads/index.html

JAVA_HOME environment variable configured.

You may check for this environment variable's adequate configuration by using a command prompt and typing (it should display the corresponding path):

echo %JAVA_HOME%

 

JAVAHOME_env_Var

Microsoft .NET framework.

Microsoft .NET framework 4.5 and ASP.NET 4.5 (or higher) installed where Bizagi Diagnostics will run.

You may download Microsoft's .NET framework, version 4.5, directly from its official website at:

http://go.microsoft.com/fwlink/?LinkId=395269

 

Ensure you enable ASP.NET 4.5 within the features of the .NET 4.5 framework.

Microsoft .NET 3.5 features (enabling these regardless of having 4.5).

Ensure you enable the .NET framework 3.5 features which include compatibility for 2.0 and 3.0 framework features.

Microsoft Internet Information Services.

An operational IIS to host the Bizagi Diagnostic web application.

Supported IIS versions are: 6, 7, 7.5, 8, or 8.5.

Ensure you use a supported IIS given by a supported Windows operating system (e.g, Windows server 2008 R2, 2012 R2).

IIS with the enabled role of:

IIS 6 Management Compatibility.

Ensure you enable these role for the IIS Web server feature, as shown below:

 

IIS6_mgmt_compat

 

A configured base site at the IIS to host the Bizagi Diagnostics web application.

You may use the Default web site provided by the IIS:

 

IIS_default_website

An application pool at the IIS set to use the v4.0 .NET framework, enabling 32-bit applications and using an Integrated mode to manage pipelines.

You should create a dedicated application pool for the sole use of Bizagi Diagnostics:

 

IIS_app_pool

 

In addition to the above, note that Bizagi Diagnostics requires at least 360MB of free disk space:

 

Prereq_diskspace

 

 

Installing Bizagi Diagnostics

In order to install Bizagi Diagnostics, ensure you run the setup.exe installer file, with local admin rights:

 

Diagnostics_install1

 

Click Next in the initial welcome screen.

 

Select the installation location by specifying:

Site: The base site at the IIS which will host the Bizagi Diagnostics web application (e.g, Default web site), as mentioned in the prerequisites section above.

Virtual directory: The name of the web site and virtual directory, which will have the contents of the Bizagi Diagnostics web application. It will be created as a folder in the base path of the IIS base site (e.g, C:\inetpub\wwwroot\Bizagi.Diagnostics.Web\).

Application pool:  The application pool at the IIS which will be used by the Bizagi Diagnostics web application, as mentioned in the prerequisites section above.

 

Diagnostics_install2

 

Click Next when done.

 

Configure the path from where Bizagi Diagnostics will read logged information.

In this path, you will ensure that Bizagi Engine will be creating logs. This part is specified in the next section about Configuring Bizagi Diagnostics.

 

note_pin

When defining this path, consider:

 

This path may be set as a local folder shared with Bizagi Engine servers.

This is so because for Bizagi Engine setups using a high availability system architecture (i.e, clusters), you would have more than one Bizagi Engine server writing logs into this path.

While using such configuration, you will then ensure that this folder can be accessed as a UNC path by Bizagi Engine instances (e.g, \\fileServer\logsPath\), while ensuring that it is set with adequate access rights for the service account running Bizagi Engine.

 

Diagnostics_install3

 

Click Next and confirm the installation by clicking Next again.

The installation procedure may take up a few minutes.

 

Diagnostics_install4

 

Click Close when done.

 

Diagnostics_install5

 

At this point, installation is complete and you should be able to verify that the Bizagi Diagnostics website has been created at your IIS base site:

 

Diagnostics_install6

 

note_pin

Additional services are installed by default using the HTTP port number 9200, such as an Elastic service.

 

Configuring Bizagi Diagnostics

Once you have installed Bizagi Diagnostics, its web application becomes active.

Though, you will still need to carry out configuration aspects in order to ensure that your Bizagi Engine logs details into the path Bizagi Diagnostic reads from.

 

In order to do so, first edit the configuration file for each component (Work portal and Scheduler service) in each Bizagi Engine server of your setup.

Through this configuration, you explicitly define that each component logs detail and specify into which path it will be doing so.

 

Proceed by editing the web.config file of your Bizagi Work portal (by default at C:\Bizagi\Projects\[your_project]\WebApplication) for each node so that you include these 2 lines inside of the <appSettings> element:

 

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

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

 

Diagnostics_config1

 

Consider replacing:

[Diagnostics_readFrom_path]: Specify the folder you already configured to read from --during Bizagi Diagnostics installation.

Recall that for Bizagi Engine access, this path may be a UNC path (e.g, \\fileServer\logsPath\).

[instance_prefix]: 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 will know beforehand from which component they come from. You may 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.

In addition to the above, 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.

 

Similarly, continue by editing the BizAgi.Scheduler.Services.exe.config file of your Scheduler service (by default at C:\Bizagi\Projects\[your_project]\Scheduler) for each node so that you include the same lines as before and one additional line using the <add key="RaiseSettingsService" value="false"/> key, inside of the <appSettings> element and consider inputting adequate values in them, as described before.

 

Keys for the Scheduler are:

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

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

<add key="RaiseSettingsService" value="false"/>

 

The Scheduler's configuration file should look like the one shown below:

 

Diagnostics_config2

 

Save changes when done.

Changes in this file may require a service restart (restarting the Scheduler from the Windows services panel, which takes up a few seconds and doesn't interrupt Bizagi Engine operations).

 

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

 

note_pin

To view all available options that allow using additional possibilities regarding the storage for server events, refer to Advanced options when recording server events.

 

Troubleshooting

Bizagi Diagnostics relies on additional services such as ElasticSearch and LogStash.

A successful Bizagi Diagnostics operation should be able to rely on an operational Elastic Search monitor running at http://localhost:9200/_plugin/HQ.

 

The Bizagi Diagnostics service automatically starts up, restarts and watches over these other services. This means that this Bizagi Diagnostic service should be up and running (verifiable at the Windows services panel).

 

Diagnostics_troubleshooting

 

In case this service does not automatically start up to initialize the other services, you may execute the other services' .bat files (and review their .config files) manually at:

ElasticSearch: Executable file at C:\BizagiDiagnosticsTool\ELK\elasticsearch\bin\elasticsearch.bat.

LogStash: Executable file at C:\BizagiDiagnosticsTool\ELK\logstash\bin\logstash.bat, which should be run by using logstash -f logstash.conf