Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Frequency Profiles

 

Frequency profiles are a central location in which sensor and rule time frequencies can be managed. To understand frequency profiles, consider the following.

When defining rules in Paragon Insights (formerly HealthBot) you can:

  • Define multiple rules that use the same sensor

  • Define different sensor frequencies for each of the rules

  • Apply all of these rules to the same device group/devices

This creates complexity in rule application and frequency adjustments within the individual rules:

  • A key, consisting of sensor-path for OpenConfig and Native GPB sensors, or the tuple of file and table for iAgent sensors is used to identify the specific rules.

  • Paragon Insights takes the minimum defined frequency for that sensor from the applied rules and uses it to subscribe to, or fetch, data from the devices.

  • This make it hard to identify what the data rate should be for that sensor. To do that, you would have to go through the all the applied rules.

  • A change in the sensor frequency of an applied rule might not take effect as intended.

To address these complexities, Paragon Insights needed a common place from which to control these frequencies.

Starting in HealthBot Release 3.0.0, frequency profiles can be created that allow you to manage sensor and rule frequencies from a single location and then apply the profiles in various locations in Paragon Insights. Application of these profiles allows for persistent and repeatable behavior in regard to frequencies for rules, sensors, triggers, formulas, references, learning periods, and hold times.

A sensor profile consists of a profile name and two optional sections: the sensors section and the non-sensors section. In each section, an entry consists of a sensor or rule name and a frequency. Frequency profiles are applied to device groups or network groups.

The steps for configuration are shown below.

Configuration Using Paragon Insights GUI

Frequency profiles are configured and managed in the Paragon Insights GUI or in the Paragon Insights CLI. In the GUI, they are managed by navigating to the Settings > Ingest Settings page and selecting the Frequency Profile tab from the left side of the page.

Note

While the sections of the frequency profile are both optional, at least one section must be filled out per frequency profile if you want the applied profile to be able to do anything.

Add a Frequency Profile

  1. Click the add (+) icon to add a profile.

    The Add Frequency Profile window appears.

  2. Give the profile a name such as Profile1
  3. Click the add (+) icon to add sensors.
  4. In the Sensor Name field, enter the sensor name as per the following guidelines:

    • OpenConfig Sensors: Enter the OpenConfig path for the desired sensor, such as /components or /interfaces.

    • iAgent Sensors: Enter the table name used in the sensor definition, such as ChassisAlarmTable or REutilizationTable

    • SNMP: Enter the sensor name such as npr_qmon_ext

    • BYOI: Enter <topic-name/rule-name/sensor-name>, such as topic1/rule1/sensor1

  5. In the Frequency field, enter the appropriate frequency, such as 30seconds, 1minute, 2hours, and so on.
  6. (Optional) Click the add (+) icon to add non-sensors.
  7. In the Rule Name field, enter the rule name such as check-chassis-alarms.
  8. In the Frequency field, enter the appropriate frequency, such as 45seconds, 3minutes, 1hour, and so on.

    Repeat steps 3 through 5 or 6 through 8 as desired for the profile.

  9. Click the SAVE & DEPLOY button to save and deploy the profile.

    The new sensor profile is added to the list.

Edit a Frequency Profile

To edit an existing frequency profile:

  1. Click the Frequency Profile tab to view the Frequency Profile page.
  2. Select the < Profile Name> that you want to modify.
  3. Click the edit (pencil) icon to edit the profile.

    The Edit Frequency Profile page appears, displaying the same fields that are presented when you add a frequency profile.

  4. Modify the parameters.
  5. Click the SAVE button to save the profile for later deployment or the SAVE & DEPLOY button to save and deploy immediately.

Delete a Frequency Profile

To delete a frequency profile:

  1. Click Settings > Ingest from the left-nav bar.

    The Ingest Settings page is displayed.

  2. Click the Frequency Profile tab to view the Frequency Profiles page.
  3. Select the frequency profile that you want to delete, and click the delete (trash can) icon.

    The CONFIRM DELETE FREQUENCY PROFILE pop-up appears.

    Figure 1: Confirm Delete Frequency Profile Pop-up
    Confirm Delete Frequency Profile Pop-up
  4. Do any one of the following:

    • Click Yes to delete the frequency profile from the database. However, the changes are not applied to the ingest service.

      Note

      • We recommended that you do not delete a frequency profile that is currently in use.

      • After you delete a frequency profile from the database, you cannot apply that frequency profile to another device group even if you have not deployed changes.

      • You can also deploy changes to the ingest service or roll back the changes that you have already deleted, from the PENDING CONFIGURATION page. For more information, see Commit or Roll Back Configuration Changes in Paragon Insights.

    • Select the Deploy changes check box and then click Yes to delete the frequency profile from the database, and to apply the changes to the ingest service.

    • (Optional) Click No to cancel this operation.

Clone a Frequency Profile

To clone a frequency profile:

  1. Click the Frequency Profile tab to view the Frequency Profile page
  2. Select the < Profile Name> that you want to clone and then click the Clone button at the top-right corner of the page.

    The Clone Frequency Profile page appears.

  3. Specify an appropriate name for the cloned profile.
  4. Click OK to save your changes.

    A clone of the profile is created and listed on the Frequency profile page.

Usage Notes:

  • Profile Entries–Multiple entries can be configured in each section.

  • Override–Sensor or rule frequency defined within an applied frequency profile overrides those defined within the individual rule or sensor.

  • Order of Precedence–If a sensor or rule is defined in multiple frequency profiles, each with different frequency settings, the minimum frequency value for the sensor or rule is used.

Configuration Using Paragon Insights CLI

In the Paragon Insights CLI, you can configure the same frequency profile described above. An example of the CLI configuration needed to complete the example above looks like:

user@mgd-69ab987fbc6-pt9sh> show configuration healthbot ingest-settings frequency-profile Profile1

Apply a Frequency Profile Using the Paragon Insights GUI

Frequency profiles are applied to Paragon Insights device groups or network groups. When you create or edit a device or network group, you apply frequency profiles by selecting them from the Ingest Frequency section of the Device Group definition. Figure 2 below shows an example of frequency profiles being applied to a device group.

Figure 2: Apply Frequency Profiles
Apply Frequency Profiles

Once you have applied the needed profiles, save and deploy the device group using the SAVE & DEPLOY button.

Best Practice

It is strongly recommended that you only apply frequency profiles to rules that make use of the Offset Time Unit feature.

Apply a Frequency Profile Using the Paragon Insights CLI

An example of a device group CLI configuration which includes a frequency profile and could be deployed in Paragon Insights is shown below.

user@mgd-69ab987fbc6-pt9sh> show configuration healthbot device-group lab-group