Using Bizagi Diagnostics

<< Click to Display Table of Contents >>

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

Using Bizagi Diagnostics

 

Overview

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

The following section illustrates how to use Bizagi Diagnostics once it has been set up (as described at Setting up Bizagi Diagnostics).

 

Using Bizagi Diagnostics

Get started by clicking the Bizagi Diagnostics shortcut created upon installation. You can also, in a browser go to the URL of the installed Bizagi Diagnostics web application --http://[your_server]/[Bizagi_diagnostics_website]/).

The shortcut automatically opens your default browser and load the Bizagi Diagnostics web application's overview page (this may take a minute or so).

 

Diagnostics_start

 

The  page presents several options in the left hand panel, while letting you define a time frame to monitor in the upper part.

The general layout of the Bizagi Diagnostics web application is explained below, along with further details regarding each option.

 

General layout

The main information you need to provide to start monitoring your Automation Server operation, is found in the upper part where you select:

A time frame which will apply for all displayed information. The Bizagi Diagnostics web application shows you the events of that time frame (e.g, 1 minute, 5 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, etc). You can also give the time frame with a specific start and end time in the Custom date tab.

 

Diagnostics_web01

 

An auto-refresh setting to determine If the Bizagi Diagnostics web application should display the latest information constantly. If you turn on the auto-refresh setting, while having a 5-minute time frame setting, you will constantly monitor the most recent five minutes of Automation Server reported operations).

 

You can set auto-refresh to apply every second, every 5, 15 or 30 seconds, or at intervals of 1 or 5 minutes.

If want to leave auto-refresh turned off, you can use the Refresh button to manually update information.

 

Diagnostics_web02

 

After you set the parameters to indicate what to monitor, each option on the left hand panel present different views for the reported Automation Server server events.

 

Diagnostics_web00

 

These views and charts are displayed in the main work area.

Details on each option are below.

 

Zooming in and out

At any time, in any chart, you can zoom in by defining a smaller time frame with your mouse. Draw a square to frame the portion you want to see in more detail:

 

Diagnostics_zoom

 

Sharing charts

At any time, in any chart, you can produce a hyperlink and share the same view with other users.

The hyperlink includes filtering options you are using for that chart:

 

Diagnostics_share

 

Overview

The overview option provides a first impression that summarizes the general performance of Automation Server.

 

Diagnostics_web03

 

It displays three charts:

Average duration per request: The average time in milliseconds it takes to process requests(for the pre-defined time frame, shown in the chart as the horizontal axis).

The duration is presented in four measurements:

oTotal duration: This is the sum of the other three measurements, and it is highlighted in pale blue.

oDatabase time: Time spent in database engine tasks such as running SQL queries or procedures; and it is highlighted in dark gray.

oBizagi time: Time spent running logic or other Bizagi tasks; it is highlighted in pale green.

oExternal time: Time spent waiting for external systems to complete their tasks (e.g when Bizagi invokes interfaces). It is highlighted in orange.

 

Diagnostics_web04

 

note_pin

Since Automation Server provides a Work portal which is accessed through a browser as a web application, a request in Bizagi includes actions that produce an HTTP request to send to the Bizagi server, and which in turn, require that Automation Server process and reply to each request.

 

This means that a request as considered by these charts, includes whenever a new case is created, or an activity is completed, as well as other HTTP requests fired by the Work portal as needed by Bizagi.

 

Bizagi Apdex indicator: A standard application performance index that indicates under which conditions Automation Server is operating (for the pre-defined time frame, shown in the chart as the horizontal axis).

Scoring is assigned as excellent, good, regular or bad (calculated as a standard Apdex score from 0 to 1).

Whenever Automation Server starts up or is restarted, the Apdex may show that Bizagi may take a minute or so to reach a state of optimal performance.

 

Diagnostics_apdex

 

Error rate (%): The percentage of reported errors compared to successful requests for the pre-defined time frame, shown in the chart as the horizontal axis.

 

Diagnostics_errorrate

 

Watch for, follow up on, and resolve any errors presented, and aim at having an error rate close as possible to 0%.

 

Discover

The discover option displays one chart to narrow down average duration for certain types of server events, and for specific data.

 

Diagnostics_discover

 

Use it to dig into system activity by filtering the collected information and then clicking Apply changes.

 

Diagnostics_web06

 

Filtering options are described in the table below.

 

OPTION

DESCRIPTION

Show (duration)

Define if you want to display only reports which exceed a certain amount of time in milliseconds (by using the slider).

You can also define if you wish to filter by total duration, by database time, Bizagi time, or by external time (duration/time definitions apply the same as in the average duration per request chart).

Stack by

Classify results and show details inlayers (stacked) by:

Bizagi operation: the type of operation executed by Bizagi (e.g, clicking Save, Next, or creating a new process).

Process: the different processes of your project.

Server instance: the different servers of your cluster.

Source: the different Automation Server components such as the Web application or the Scheduler service.

Task name: the different activities in your project's processes.

User: the different end users accessing your Work portal.

Event type

Allows you to define if you want the be able to filter information by seeing below a list of events.

Bizagi operation: Events associated to the regular operations run by Bizagi such as clicking Save, Next, or creating a new process.

Get jobs: Events associated to custom jobs run by the Scheduler.

Query: Events associated with running queries at the database.

Request: Events associated with the regular operations run by Bizagi in overall requests.

Thread: Events associated with whenever the Scheduler fires new threads for programmed tasks.

 

Once you define this setting, you can narrow down each bit of information that can be displayed in the chart. For example, for Query type events, you can select Web application or Scheduler and click Apply changes:

 

Diagnostics_web07

 

To select or unselect bits of information regarding events, consider the definitions above at the Stack by filters section, in addition to these:

Case number: List the process instances (i.e cases) which are reported.

SQL: List the SQL statement or queries which are executed by Bizagi.

An in-depth look at SQL statements which show a significant delay, may indicate that some tables need database tuning. Have your DBA review the statistics and indexes where there seem to be delays.

URL: Lists the URL of the invoked REST services.

 

When viewing the chart, you can use top-down analysis options located in the upper right part (by default this is minimized), to total information (as percentage, average or count):

 

Diagnostics_topdown

 

 

note_pin

It is often important to review the number of counts for events which show a slow response time.

A lower number of counts for those events, may indicate that a SQL query or invoked URL is part of the resources Automation Server loads upon application startup or restart (in which case, it could be considered normal for those resources to present a much longer delay when compared to transactional operations which occur at a much greater scale).

 

Similarly, the lower part (by default minimized), shows a table with details of the recorded events that compose the information of the chart.

This table includes: Server instance, source component, event type, timestamp, the different duration measures (total duration, database time, Bizagi time, external time) and significant tags:

Diagnostics_discoverevents

 

 

Health

The health option displays the overall health status of all Automation Server components reporting to Bizagi Diagnostics.

A diagram illustraties your Bizagi system architecture with more than one Web server or Scheduler service being active when applicable.

 

Diagnostics_health

 

The diagram shows average availability (server uptime for the Work portal or Scheduler service) for the pre-defined time frame.

Similarly, average time to the database is displayed for the Work portal or Scheduler service.

You can hover the mouse pointer on each Work portal instance (Web servers), and click Check health to run an immediate check on its associated resources availability:

 

Diagnostics_healthdetails

 

You can hover the mouse pointer on each Work portal instance (Web server) and click Detail to see its reported health status in terms of availability and latency:

 

Diagnostics_web05

 

Hover the mouse pointer on a Scheduler service instances, and click Detail to see its reported health status in terms of availability and latency.

 

Users

The users option shows the number of users working simultaneously (for the pre-defined time frame, shown in the chart as the horizontal axis).

 

Diagnostics_cusers

 

Errors

The errors option lists, and provides in depth details for, all reported errors.

 

Diagnostics_errors

 

This view has a chart in the upper part to display the total number of errors (for the pre-defined time frame, shown in the chart as the horizontal axis), while showing details of those reported errors: the case instance, source, timestamp, the error exception, and diagnostic tags.

 

Traces

The traces option lists all custom traces written in scripting expressions by means of the CHelper.trace() method.

 

Diagnostics_traces

 

You can browse the traces according to the timestamp, server instance, source (Web application or Scheduler), category (name of the trace) or logged data.

 

note_pin

To make the most of this view, we recommend that your team agrees on a standard nomenclature for your traces (e.g, possibly including the case identifier in its file name).

 

Settings

The settings option lets you to change settings uniformly for all of your Automation Server components to define which server events are reported into logs.

 

For more information about this option, refer to General pointers and tuning tips.