Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Configure Data Summarization

 

You can improve the performance and disk space utilization of the HealthBot time series database (TSDB) by configuring data summarization methods to summarize the raw data collected by HealthBot. The data can be summarized as a function of time or when a change occurs.

For time-based data summarization, the raw data points are grouped together into user-defined time spans, and each group of data points is summarized into one data point using aggregate functions.

Table 1 provides a list of the supported data summarization algorithms and a description of their output:

Table 1: Descriptions of the Data Summarization Algorithms

Algorithm

Description of output

Latest

Value of the last data point collected within the time span.

Count

Total number of data points collected within the time span.

Mean

Average value of the data points collected within the time span.

Min

Minimum value of the data points collected within the time span.

Max

Maximum value of the data points within the time span.

On-change

Value of the data point whenever the value is different from the previous data point (occurs independently from the user-defined time span).

Stddev

Standard deviation of the data points collected within the time span.

Sum

Sum of the data points collected within the time span.

If no summarization algorithm is associated with the data, the following algorithms are used by default:

Data type

Data summarization algorithm

Float, integer, unsigned

Mean

Boolean, string

On-change

You can use data summarization profiles to apply specific summarization algorithms to the raw data collected by HealthBot for a specific device group:

Creating a Data Summarization Profile

To create a data summarization profile that can be applied to a device group:

  1. Click the Settings > Data Summarization Profiles link in the left-nav bar.
  2. Click the + Summarization Profile button.
  3. In the Name field, enter the name of the profile.
  4. Under Type Aggregate, click the + Add Type Aggregate button.
  5. Choose a data type name and associate it with a data summarization algorithm using the drop-down lists. Data types include: string, integer, boolean, and float. Note: The algorithm configured for a specific sensor path name overrides the algorithm configured for the corresponding data type.
  6. Repeat Step 5 and Step 6 for other data types, as needed. You can associate more than one algorithm with the same data type.
  7. Under Path Aggregate, click the + Add Path Aggregate button.
  8. Enter a sensor path name, and associate it with a data summarization algorithm using the drop-down list. Note: The algorithm configured for a specific sensor path name overrides the algorithm configured for the corresponding data type.

    You can enter a path name for a sensor that is not supported by HealthBot. For sensors supported by HealthBot, the path name must be entered in the following format:

    Sensor

    Path Name Format

    Example

    Open Config

    sensor-path

    /components/component/name

    Native GPB

    sensor-name:sensor-path

    jnpr_qmon_ext:queue_monitor_element_info.percentage

    iAgent

    yaml-table-name:sensor-path

    REutilizationTable:15_min_cpu_idle

    SNMP

    snmp-table-name:sensor-path

    .1.3.6.1.2.1.2.2:jnxLED1Index

    ospfNbrTable:ospfNbrIpAddr

    Syslog

    pattern-set: sensor-path

    interface_link_down:operational-status

    Flow (NetFlow)

    template-name:sensor-path

    hb-ipfix-ipv4-template:sourceIPv4Address

  9. Repeat Step 8 and Step 9 for other sensor paths, as needed. You can associate more than one algorithm with the same path name.
  10. Click Save to save the configuration or click Save and Deploy to save and deploy the configuration.
  11. Apply the data summarization profile to a specific device group. For more details, see Applying Data Summarization Profiles to a Device Group.

Applying Data Summarization Profiles to a Device Group

After creating a data summarization profile, you can apply the profile to a specific device group to start summarizing the raw sensor data:

  1. Click the Configuration > Device Group option in the left-nav bar.
  2. Click the name of the device group for which you want to apply the data summarization profile.
  3. Click the Edit Device Group (Pencil) icon.

    The Edit <device-group-name> window appears.

  4. Click the Summarization header to expand that section.,
  5. Enter the Time Span in seconds (s), minutes (m), hours (h), days (d), weeks (w), or years (y)
  6. Choose the data summarization profiles from the drop-down list for which you want to apply to the ingest data. To edit or view details about saved data summarization profiles, go to the Data Summarization page under the Settings menu option in the left-nav bar.

    If you select two or more profiles, the following guidelines apply:

    • If the same data type or sensor path name is configured in two or more profiles, the associated algorithms will be combined.

    • The table that stores the summarization output includes columns of summarized data for each algorithm associated with each data field collected by HealthBot. The naming convention for each column is as follows:

      Number of algorithms associated with a data field

      Column name for the summarized output

      1

      field-name

      Example: 5_sec_cpu_idle

      2

      field-name_first-algorithm-name, field-name_ second-algorithm-name

      Example: 5_sec_cpu_idle_MIN, 5_sec_cpu_idle_MAX

      3

      field-name_first-algorithm-name, field-name_ second-algorithm-name, field-name_ third-algorithm-name...

  7. Click Save to save the configuration or click Save and Deploy to save and deploy the configuration.