"Active lists" widget

You can use the Active lists widget to get analytics based on SQL queries.

When creating this type of widget, you must set values for the following settings:

The tab:

• Graph is the type of the graph. The following graph types are available:
  • Bar chart.
  • Pie chart.
  • Counter.
  • Table.
• Tenant is the tenant for which data is displayed in the widget.

  You can select multiple tenants.

  By default, data is displayed for tenants that have been selected in layout settings.

• Correlator is the name of the correlator that contains the active list for which you want to receive data.
• Active list is the name of the active list for which you want to receive data.

  The same active list can be used by different correlators. However, a separate entity of the active list is created for each correlator. Therefore, the contents of the active lists used by different correlators differ even if the active lists have the same names and IDs.

• The SQL query field lets you manually enter a query for filtering and searching active list data.

  The query structure is similar to that used in event search.

  When creating a query based on active lists, you must consider the following:

  • For the FROM function, you must specify the `records` value.
  • If you want to receive data for fields whose names contain spaces and Cyrillic characters, you must also enclose such names in quotes in the query:
    • In the SELECT function, enclose aliases in double quotes or backticks: "alias", `another alias`.
    • In the ORDER BY function, enclose aliases in backticks: `another alias`.
    • Event field values ​​are enclosed in straight quotes: WHERE DeviceProduct = 'Microsoft'.

    Names of event fields do not need to be enclosed in quotes.

    If the name of an active list field begins or ends with spaces, these spaces are not displayed by the widget. The field name must not contain spaces only.

    If the values of the active list fields contain trailing or leading spaces, it is recommended to use the LIKE '%field value%' function to search by them.

  • In your query, you can use service fields: _key (the field with the keys of active list records) and _count (the number of times this record has been added to the active list), as well as custom fields.
  • The "metric" and "value" aliases in SQL queries cannot be edited for any type of active lists analytics widget, except tables.
  • If a date and time conversion function is used in an SQL query (for example, fromUnixTimestamp64Milli) and the field being processed does not contain a date and time, an error will be displayed in the widget. To avoid this, use functions that can handle a null value. Example: SELECT _key, fromUnixTimestamp64Milli(toInt64OrNull(DateTime)) as Date FROM `records` LIMIT 250.
  • Large values for the LIMIT function may lead to browser errors.
  • If you select Counter as the graph type, you must specify the method of data processing for the values of the SELECT function: count, max, min, avg, sum.
  • You can get the names of the tenants in the widget instead of their IDs.

    If you want the names of tenants to be displayed in active list widgets instead of tenant IDs, in correlation rules of the correlator, configure the function for populating the active list with information about the corresponding tenant. The configuration process involves the following steps:

    1. Export the list of tenants.
    2. Create a dictionary of the Table type and import the previously obtained list of tenants into the dictionary.
    3. Add a local variable with the dict function for mapping the tenant name to tenant ID to the correlation rule.

       Example:

       • Variable: TenantName
       • Value: dict ('<Name of the previously created dictionary with tenants>', TenantID)
    4. Add an action with active lists to the correlation rule. This action will write the value of the previously created variable in the key-value format to the active list using the Set function. As the key, specify the field of the active list (for example, Tenant), and in the value field, reference the previously created variable (for example, $TenantName).

    When this rule triggers, the name of the tenant mapped by the dict function to the ID from the tenant dictionary is placed in the active list. When creating widgets for active lists, you can get the name of the tenant by referring to the name of the field of the active list (in the example above, Tenant).

    The method described above can be applied to other event fields with IDs.

  Special considerations apply when using aliases in SQL functions and SELECT, you can use double quotes and backticks: ", `.

  If you selected Counter as the graph type, aliases can contain Latin and Cyrillic characters, as well as spaces. When using spaces or Cyrillic, the alias must be enclosed in quotation marks: "An alias with a space", `Another alias`.

  When displaying data for the previous period, sorting by the count(ID) parameter may not work correctly. It is recommended to sort by the metric parameter. For example, SELECT count(ID) AS "metric", Name AS "value" FROM `events` GROUP BY Name ORDER BY metric ASC LIMIT 250.

  Sample SQL queries for receiving analytics based on active lists: SELECT * FROM `records` WHERE "Event source" = 'Johannesburg' LIMIT 250 This query returns the key of the active list where the field name is "Event source" and the value of this field is "Johannesburg". SELECT count(_key) AS metric, Status AS value FROM `records` GROUP BY value ORDER BY metric DESC LIMIT 250 Query for a pie chart, which returns the number of keys in the active list ('count' aggregation over the '_key' field) and all variants of the Status custom field. The widget displays a pie chart with the total number of records in the active list, divided proportionally by the number of possible values for the Status field. SELECT Name, Status, _count AS Number FROM `records` WHERE Description ILIKE '%ftp%' ORDER BY Name DESC LIMIT 250 Query for a table, which returns the values ​​of the Name and Status custom fields, as well as the service field '_count' for those records of the active list in which the value of the Description custom field matches ILIKE '%ftp%'. The widget displays a table with the Status, Name, and Number columns.

The tab:

This tab is displayed if on the tab, in the Graph field, you have selected Bar chart.

• The Y-min and Y-max values set the scale of the Y axis.
• The X-min and X-max values set the scale of the X axis.

  Negative values can be displayed on chart axes. This is due to the scaling of charts on the widget and can be fixed by setting zero as the minimum chart values instead of Auto.

The tab:

• Name is the name of the widget.
• Description is the description of the widget.
• Color is a drop-down list where you can select the color for displaying information:
  • default for your browser's default font color
  • green
  • red
  • blue
  • yellow
• Horizontal makes the histogram horizontal instead of vertical.

  When this setting is enabled, all available information is fitted into the configured widget size. If the amount of data is great, you can increase the size of the widget to display it optimally.

• Show total shows sums total of the values.
• Legend displays a legend for analytics.

  The toggle switch is turned on by default.

• Show nulls in legend displays parameters with a null value in the legend for analytics.

  The toggle switch is turned off by default.