Introduction

The Widget Setting allows you to choose from multiple graph types to visualize a filtered group of records. You can select the visualization type that best suits your data, including bar, line, area, step, and pie. You can modify some or all of the following widget elements to match the look and feel of your Dashboard.

By widget setting, you can perform various settings related to widgets, such as chart settings, advanced settings, and can apply filters. These settings are further categorized into various sub-sections. The widgets are displayed in the Dashboard based on the configured settings.

General setting

The General widget setting provides a basic implementation of different types of widgets (for example: data, graph, tabular, etc.) and charts (for example, area, line, bar, pie, etc.).

Widget Types

It is the representation of the widget on the panel. Select the Widget type, such as Graph, Data, Tabular, or Label. The next selection is based on the Widget type selected. The following are the widget type:

• Data
• Graph
• Label
• Tabular

Graph Widget Type

This widget is used to show a different types of graphs.

Graph Widget Setting

Graph Types

It allows you to choose from multiple graph types to visualize a filtered group of records. There are the following graph types that you can select from the given list below:

• Normal Graph: A normal graph displays data in a standard graphical format, which includes all graph types. For a normal graph, you need to select the formula type, such as Average, Min, Max, Count, or Sum Count.

Note: You can add multiple formulas, when you select graph type other than 'Normal' graph type then the 'Graph Sample Filter' will be disabled.

• Category Graph: Category graphs belong to the following categories, such as Stacked Area Chart and Stacked Bar Chart.
• Percentile Graph: A percentile graph shows the value of a variable below which a certain percentage of observations fall. Percentiles can be computed for ordinal, interval, or ratio data.
• Slab Count Graph: Slab count graph counts the number of samples in a particular time interval. You can change all graphs to the Slab Count Graph.

Example: In Slab Count, it will give 10 samples for the given time duration. The minimum and maximum values of the native metric data for the given time duration will be the Minimum and Maximum of the first and last slab range. On the basis of the minimum and maximum values, it will get the difference between them and divide it by 10 to get the range interval of each slab. Then on the basis of each range, it will count the number of average values which will lie in that range and the count value will be the value of that particular slab.

Chart Types

It offers the following different visualization types

• Area: An area chart displays graphically quantitative data. The area between the axis and line is commonly emphasized with colors and textures. An area chart is used to represent cumulative data using numbers or percentages over time.
• Bar: In this case, the line chart is converted to Bars. You need to specify the criteria, such as Avg All, Avg Top 5, Avg Top 10, or Avg Bottom 10.
• Donut: Donut chart is represented in the form of a donut. You need to specify the criteria by using show values .
• Dial: The purpose of Dial Graph is to analyze easily, the data in online mode how data variation is coming and to view samples of data in Dial Chart except for Line Chart.
• Line: The charts are displayed in the form of lines.
• Meter: The purpose of the Meter graph is to analyze the data in online mode how data variation is coming and to view samples of data in Meter Chart except for Line Chart.
• Pie: It is useful in the case of multiple graphs. If one graph is converted into Pie, then a simple circle filled with one color is displayed.
• Stacked Area/Bar: Stacked Area chart means the area chart of each graph is stacked on each other.
• Dual Axis Line: Dual Axis Line is useful for comparing trends in two data sets whose numeric range differs greatly in form of lines.
• Dual Axis Bar/Line: Dual Axis Bar/Line is useful for comparing trends in two data sets whose numeric range differs greatly in forms of Bar/Line.
• Dual Axis Area Line: A dual bar line allows you to summarize or plot two y-axis variables that have different domains.

Honeycomb:

A honeycomb graph, also known as a hexagonal lattice or honeycomb lattice, is a type of graph structure that resembles the hexagonal cells of a honeycomb. The honeycomb chart type displays the health of a subject based on the alerts that are generated on the said subject. The lattices change their color as per the alerts generated. The color coding is described as follows:

• Red: The presence of this color signifies the generation of critical alerts on the subject.
• Orange: The presence of this color signifies the generation of major alerts on the subject.
• Yellow: The presence of this color signifies the generation of minor alerts on the subject.
• Green: The presence of this color signifies that no alerts where generated on the subject.

Honeycomb Filters

You can also group the honeycomb lattices as per the following filters selected which are listed below:

• By Severity: In this option, you can apply the filters based on the following severity which are listed below:
  • No Filter: Shows all the subjects irrespective of alerts generated or not.
  • Critical: Shows all those subjects which have critical alerts generated.
  • Major and Above: Show all those subjects which are having major or above severity alert.
  • Minor and Above: Show all those subjects which are having minor or above severity alert.
• By Subject: In this option, you can provide the criteria for the subject such as: “All Tier”, “All Channel”, “Pattern” By applying this filter, the honeycomb will show the respective subject i.e. if user selects all tiers, then the honeycomb widget will display all the tiers that are present irrespective of the tiers configured on the widget.
• Health Based on: In this option, you can configure the honeycomb to view alerts that are either generated on the metric configured in the widget or across all metrics. Details are as follows:
  • Widget Metrics: The honeycomb lattice’s color will be dictated by the alerts generated on the metric configured in the widget i.e. if you have configured CPU utilization as the metric in the widget then the honeycomb lattice color will change depending upon alerts generated on CPU utilization.
  • All Metrics: The honeycomb lattice’s color will be dictated by the alerts generated on all the metrics being monitored by the product i.e. if CPU utilization is configured on the widget but an alert is generated on Memory Consumed, then the honeycomb lattice’s color will change according to the severity of the alert generated for Memory Consumed metric.

Note:

• Once you have selected all the required filters to be used, then you have to click on the Apply Add button to apply the Honeycomb filter on the widget.
• If you want to reset the Widget Settings window, then you have to click on the Reset Reset

Show Value

You can select the Data Field names, such as minimum, maximum, average, and sum count.

• Avg:Average value of all samples for the selected time frame.
• Count:Count of all the samples for the selected time frame.
• Last Sample: Last sample refers to the most recent data point plotted on the graph, where the data point represents the most recent measurements or observations available for the variable being used.
• Max:Maximum value of all samples for the selected time frame.
• Min:Minimum value of all samples for the selected time frame.
• Standard Deviation: Standard deviation is the value for the standard deviation of the data samples of the graph.
• Subject Count: The subject count refers to the total number of unique subjects being depicted in the graph where Subject means further hierarchy nodes under a specific node.
• Sum: Sum is the addition of all the values of all the specified metrics.
• Sum Count: The sum count is the cumulative sum of each sample count present at a particular time interval.

Legend Settings

This is used to show/hide legend on the graph. We can set the position also where to show on the graph. To enable this, select the Show Legend checkbox and then select the legend position (left/right / bottom) from the drop-down list. In this example, we have selected Legend Position - Left.

Data Widget Type

This widget is to show value for one or more metrics. This widget will also show captions with value.

Data Widget Settings

Show Value: It is the criteria of the data field. The available options are as follows:

• Average
• Count
• Last Sample
• Maximum
• Minimum
• Standard Deviation
• Subject Count
• Sum
• Sum Count

Severity Definitions: Select the operator (such as <,>, <=,>=) for the critical and major threshold and the threshold values.

Tabular Widget Type

A table widget displays data in rows and columns. Each row in the table represents an item, and each column shows a selected attribute of that item. For example, a table might show a list of servers with key attributes for each server, such as CPU usage and disk space. When selecting Tabular as the widget type, you need to choose the following options:

Label Widget Type

The Label widget type is used to create a blank widget with just a label in it. The main purpose of this widget type is to provide a heading or title for a group of widgets and place those widgets below this Label widget. Furthermore, you can apply various formatting options to the Label widget, such as bold, italics, underline, font size, font color, text alignment, and many other formatting features.

Group Widget Type

It is required to make a group of different widgets inside a Group Widget so that those can be identified separately and the widget operations are performed easily like moving together. The widget operations performed on Group widgets like Time period, Compare will reflect on all the different widgets present inside.
Further to this, you can perform Widget Title Settings, Color settings, and another formatting.

Advanced

Here, you can perform some advanced-level settings based on the Widget type:

Template Layout Settings

You can specify the duration (in minutes) by which the X-axis (Duration/Time) of the graph will be shifted back by selected Duration.

Caption Settings
You can format the font of the graph caption, such as bold, italic, or underline. You can also edit the default caption of the graphs and provide a new one based on the requirements.

Widget DrillDown
You can specify up to which level the widget drill down is required. In addition, you can enable/disable the parameterization for that particular widget.

Color Settings
You can set the Font color, Background color, and Icon color of a widget.

Display
You can specify the display settings of the text in the widget that includes - Font formatting (Bold, Italics, Underline), selection of Font Family (such as Arial, Calibri, Cambria). You can also specify the width of the grid line to be displayed on the widget.

Linking Widget
One big reason for placing more than one widget on a page is that widgets can be linked. When linked, selecting a record in one widget will cause another widget to update and show only the data related to the selected record.

Widget Delay Time
Dashboard can shift back all the data points of all the metrics present on the selected widget by a specified amount of time. There are many environments where the data scraping is not instantaneous and when monitors fetch the data, we get a few minutes of old data at the current time.

This feature is useful for visualizing the data for the metrics where data is coming with some delay and using this feature user can shift back their data to match with the delay applied in the monitors.

For example if there is a delay of 10 minutes in fetching data from the data source through monitors, then the data for a duration of say 11:10 - 12:10 hours will be ingested in our time series database with their actual time period of 11:00 - 12:00 hours, and if the user has applied the time period of 11:10 - 12:10 hour, then after applying the shift back time of 10 minutes they will see the data for the time duration of 11:00 - 12:00 hours.

Hide Chart Axis

You can hide the X axis and Y axis of the charts in the widget based on your requirements.

A honeycomb graph, also known as a hexagonal lattice or honeycomb lattice, is a type of graph structure that resembles the hexagonal cells of a honeycomb. The honeycomb chart type displays the health of a subject based on the alerts that are generated on the said subject. The lattices change their color as per the alerts generated. The color coding is described as follows:

Data Source

Data source defines the kind of data being collected. It could be metrics from a server, logs from an application, traces from a distributed system, or any other form of data that is relevant for monitoring and analysis. There are three dropdown tabs in datasource Log,Metric,Database.

Note: When you select data source as Database.

Query Type

In Query Type, users have options either Query builder or Text query after selecting Query Builder users will get another tab where users have to specify details of Query Builder as follows:

From

To modify the default database source and database, click on the Edit DB-source button select "External," add a name, choose the desired database source, select the specific database, and click on the OK OK button. After updating the default database configuration, navigate to the From dropdown, choose tables (for example: Table1, Table2, Table3,...).

Display Data (Y Axis)

Choose the column to be displayed on the Y-axis.this is typically the data you want to analyze or visualize.

Advance Settings

User click on the Advanced Settings button to display Data Advanced Settings.

• Select : Click on the dropdown menu under "Select Column" to choose the column you want to display and aggregate.
• Aggregate : Click on the dropdown menu under "Aggregate" to choose an aggregate function for the selected column.
• Alias : Enter a name in the "Alias" field to give the aggregated column a custom label.

Note: When you choose aggregate as 'None' then selected column is added in .

• Add Configuration : Click on the Add button to add another column and aggregate configuration. Repeat the process to add multiple configurations as needed.

Note:

• Click on the Delete button to remove the display data row.
• Click on the Edit button to edit the display data row.
• Click on the Save button to save the edited display data row.
• Display data Text Area : Displays the generated SQL SELECT clause based on the selected columns.

Note: Click on the OK OK button to save the advance display data settings & Advance settings button is changed to edit button. Click on the Cancel CANCEL button to discard any changes and close the dialog.

X Axis

To include time-related fields, simply click on the dropdown menu next to "Time Column" and choose the desired field. This allows users to effortlessly select the time-related information they want to incorporate into their analysis or reports.

Condition

In the condition setup, users can filter records based on specific criteria using the "Where" option. This is particularly useful for extracting only those records that meet a defined condition. To configure the condition:

• Select the column from the "Where" dropdown on which you want to apply the condition.
• Choose the operator you want to use from the "Operator" dropdown.
• For the value, either select any column from the "Value" dropdown or opt for a custom value. This feature empowers users to precisely filter and extract the data they need for analysis or reporting.

Advance Settings

User clicks on the Advanced settings to configure Query conditions.

• Where : Dropdown to select the table for the condition.
• Operator : Dropdown to select the comparison operator.
• Column : Dropdown to select the specific column within the selected table

Note:

• Click on the Delete button to remove the current condition row.
• Click on the Save button to save the edited condition row.
• Click on the Edit button to edit the condition row.
• Click on the Add button to add a new condition row.
• Condition Text Area : Displays the generated SQL WHERE clause based on the selected conditions.
• Order By : Dropdown to select the column by which the results should be ordered.

Note: Click on the OK OK button to save the advance conditions settings & Advance settings button is changed to Edit button. Click on the Cancel CANCEL button to discard any changes and close the dialog.

Note: Join is supported when more than two tables are selected.

Join

The "Join" feature allows users to merge data or rows from multiple tables based on a shared field. By selecting the desired join type (such as left, right, inner, or none) from the dropdown menu, users can efficiently combine information from different tables, enhancing the flexibility and accuracy of data integration based on their specific requirements.

Advance Settings

User click on the Advanced settings button to configure join advance settings.

• Join : This section will allow you to specify the type of join you want to perform (inner join, left join, etc).
• Column : This section will allow you to specify the columns from each table that you want to use to match the data.

Note:

• Click on the Delete button to remove the current join row.
• Click on the Edit button to edit the join row.
• Click on the Save button to save the edited join row.
• Click on the Add button to add a new join row.
• Join Text Area : Displays the generated SQL JOIN clause based on the selected joins.
• Once you select join as 'None' you cannot add more join row.

Note: Click on the OK OK button to save the advance join settings & Advance settings button is changed to Edit button. Click on the Cancel CANCEL button to discard any changes and close the dialog.

Note: Click on the Apply APPLY button to run the query. Click on the Reset RESET button to reset all fields.

Text Query

If a text query is selected then we have to write the whole query manually in the text box and then Click on the Apply APPLY button to RUN the query.

Edit DB-source

Users click on the Edit DB-source button to open the Edit DB-source tab to configure the database source for your application.

• Database Type :

There are two types database

• Postgres : Select this option if you are using a PostgreSQL database.
• NoSql : Select this option if you are using a NoSQL database.

Note: Incase of Nosql Collections drop-down is added,select collection from it.

• Cavisson Database : Dropdown to select the predefined Cavisson database configuration.
• Name : Displays the name of the selected database configuration. This field is read-only and auto-populated based on the selected Cavisson Database.
• Source : A text field where you can enter the database connection string. This string typically includes the IP address or hostname, port number, database name, and credentials.
• Get Database : User Click this button to fetch the list of available databases based on the provided connection string in the Source field.
• Database : Dropdown to select the specific database you want to connect to within your DB source.

Note: Click on the OK OK button to save the changes made to the database source configuration. Click on the Cancel CANCEL button to discard any changes and close the dialog.

Log Monitor

A Query Widget is a tool or component used in data visualization and log monitoring systems to create, execute, and display the results of queries. These queries can be constructed to filter, search, and analyze data from various sources such as logs, databases, or metrics.

User Flow:

Click on the widget settings option to open the widget settings UI. Then, go to the Advanced tab, select Data Source, and choose Log as your data source. This action indicates that the data to be visualized in a widget will be retrieved from a log query. Once selected, go to the General section and click on Log Monitor to configure the query.

The Log Monitor Configuration panel allows you to set up and customize log monitoring by specifying metrics, grouping, and queries to filter and analyze logs.

Metrics: Click the button to add a metric for monitoring. This defines the specific data points you want to track and analyze from your logs.We need at least one combination of aggregation and metric here.Additionally a field is required for sum, avg, min, and max aggregations. For example, if you select "avg" from the aggregation options and "response time" for the field, executing the query will plot the average response time from all samples on the widget.

• Aggregation: Select the type of aggregation for the metric. Common options include Count,Count/sec, Sum, Average, Min , Max , etc.

Group By: Click the button to add a grouping criterion. This organizes the log data based on a specified attribute, such as time, host, service, etc.

• Time: Select to group logs by their timestamp.
• Field: Specify the field by which to group the logs.

Note: To visualize data from other fields in the log, click on the icon to add a field. Then, click on the select field dropdown menu to see a list of available fields. Example: response time and httpstatus code ,etc

Note: If the User selects the widget type “Tabular”, then the Group By section showing Fields instead of Time and if the user wants to add "@timestamp" field, then the user needs to select it from the drop down.

• Select Logs Filter by Query: Input a query to filter the logs that will be monitored. Use this section to log based on specific criteria.Example: If you use index=* query=*, you will retrieve data from all log sources. However, if you specify a particular IP like index=*query=72.52.108.133, you will only get data from those log lines where the IP address 72.52.108.133 is present.
• Log Query: The corresponding NF query, reflecting the applied metrics, aggregations, group by operations, and filters from the log query, will be displayed in this section.
• Test: Click this button to test the current query and see a preview of the logs that match your criteria. This helps ensure your query is correct before applying it.

Note:

• OK Click this button to save your current configuration and close the panel.
• Reset Click this button to reset all fields to their default values.
• Apply Click this button to apply your current configuration without closing the panel.