Overview
Bizagi Diagnostics provides a Dashboard which presents the events registered in your Environment. This article explains the main components of the dashboard and what you can do with Bizagi Diagnostics.
General layout
The main information you need to provide to start monitoring your Automation Server operation appears in the screen where you select the following:
•A time frame which applies for all displayed information. The Bizagi Diagnostics web application shows the events within that time frame.
You can also set a time frame with a specific start and end time in the Custom range section.
The < and > buttons let you to move left or right in the charts.
In the Custom range section, you can find an auto-refresh setting so the information refreshes periodically. With this setting enabled, you will monitor your project's information with the most recent information logged.
You can set auto-refresh to apply every 5, 10 or 30 seconds; 1, 5 or 15 minutes; 1 or 2 hours; or every day.
If want to leave auto-refresh turned off, you can set the value off or leave the value empty.
•Adding panels (Graphs or tables).
At any time, you can include a new panel by using the options featured by Grafana.
To use this option, experience using Grafana is required. It is important to know what data you want to display and how this data is going to be displayed. Refer to http://docs.grafana.org/guides/getting_started/#adding-editing-graphs-and-panels for more information.
•Share the dashboard.
At any time, you can produce a link and share the dashboard with other people. Click the Share dashboard option at the top of the screen.
You can include in the link the filtering options you are using in the dashboard:
Those who access through this link need to provide the credentials for the admin user, as explained in Using Bizagi Diagnostics.
•Zooming in and out.
You can select a time frame to zoom in and review certain information. To zoom in, using the mouse, draw a square to the frame the portion you want to reduce the time frame:
To zoom out and expand the time frame, simply double click any point in the chart.
•Changing the size of a panel.
At any time, in any panel, you can change the size of a panel by dragging and dropping its right bottom corner.
•Managing the properties of a panel.
At any time, in any panel, you can click next to the panel title to see the following options
OPTION |
DESCRIPTION |
|---|---|
View |
Opens the panel in the dashboard |
Edit |
Allows you to edit the properties of the panel. For more information, refer to Grafana's official documentation site according to the panel type •Singlestat: http://docs.grafana.org/features/panels/singlestat/ •Graph: http://docs.grafana.org/features/panels/graph/ •Pie Chart: https://grafana.com/plugins/grafana-piechart-panel •Table: http://docs.grafana.org/features/panels/table_panel/ |
Share |
Produces a link and shares the panel with other people. |
More |
Gives you the following options: •Duplicate: duplicates the selected panel •Copy: copies the selected panel. The copied panel has to be added using the Add panel option. •Panel JSON: opens a pop-up window with the given panel in JSON format. This is useful when you want to replicate the panel later •Export CSV: Allows you to export the panel in CSV format by defining if the CSV dialect is used. This option is available for graph and table type panels •Toggle legend: hides or shows the value description of the panel. This option is available for graph-type panels |
Remove |
Deletes the selected panel from the dashboard. |
Controls
The available controls are described on the table below.
OPTION |
DESCRIPTION |
|---|---|
Stack by |
This control affects how the data is aggregated to the dashboard and how the is be grouped. The available values for this control are: •All: Use this option to not group the data by any field. •@FirstChanceException: Reported Exception name •@LogOperation: Read or write operation of the business logs •@LogType: Entity, Attribute or Transition Log Type •@ProcedureName: Name of Invoked Stored Procedure •@RuleID: Identifier of the Business Rules •AWI: Name of invoked Asynchronous Interfaces •AsynchType: Type of Asynchronous Task (Service, RPA) •CaseNumber: Case creation number •ErrorData: Contents of reported error •Method: Name of internal mapping for REST external interfaces •Operation: Type of logged operation as explained below in Event type. •ProcessName: Name of logged process •RestURL: Remote URL for External interface •RuleName: Name of executed Business Rule •ServiceMethodName: Name of internal mapping for SOAP external interfaces •Sql: SQL Query invoked •TaskName: Name of logged task •Url: URL Invoked by the server •User: User who caused the logged activity |
Event type |
Lets you define if you want to be able to filter information by one of these events. •BizagiOperation: The operation performed in Bizagi (Case Creation, Next and Case Closing) •BusinessLog: Read or Write Operation on a Business Log •Error: Logged errors within the server •Query: SQL queries and Stored Procedure invocations •Request: External Interface Invocations •Rule: Business Rule Invocation |
Server Instance |
Filter the results by a given Server. This is useful when your environment is in cluster. |
Task |
Filter the results by a given task |
Thread ID |
Filter the results by the identifier of the thread that executed the task |
Stacking Query 1 |
These controls are populated with the same values as the Stack by control. They allow you to do dual-aggregation of data within two panels in the Custom Queries panel. |
Stacking Query 2 |
Panels
The following panels are available in the dashboard
•Last Event Recorded At
Shows the event displayed that is furthest to the right of the chart. This panel cannot be removed.
•Total time
Show three graph-type panels to helping you select an initial time interval with promising data.
This set displays three charts:
oTime Spent segregated by Database, Internal and External Services
oWorkItems
oTop threads
|
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 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. |
•Detailed Time
The Detailed Time set displays aggregated data through the criteria defined by the Stack by control. These charts are empty when the value for the Stack by control is All.
This set displays five charts:
oMax Request Time grouped by the value of the Stack by control
oAverage Request Time grouped by the value of the Stack by control
oEvent Count grouped by the value of the Stack by control
o[Stack by value] Event Count
o[Stack by value] Total Time
|
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). |
•Details
The Details set shows specific aggregated data (eg. SQL queries, tasks, processes, users) through the selected criteria in the Stack by control along with the data filters.
Custom queries
The Custom queries set shows the results of the double aggregation defined in the Stack by control along with the Stacking Query controls
