Skip to main content
Versa Networks

Configure the Analytics Storage Resource Handler

Versa-logo-release-icon.png For supported software information, click here.

The log collector exporter program on Analytics nodes includes a storage resource handler that monitors overall disk usage. When disk usage reaches high levels on Analytics nodes, the operation of the node can be severely impacted and it may become inoperative. The resource handler takes actions to reduce negative impacts when disk usage is high, and also raises alarms to notify administrators.

The resource handler evaluates disk usage based on two thresholds:

  • Low threshold—When disk usage on the Analytics node surpasses this threshold, the resource handler performs warning actions and raises a system alarm. By default, the low threshold is set to 80% disk usage. Also by default, logs of all types continue to be stored on disk and processed into the database and search engine for the Analytics cluster unless the high threshold is also surpassed. 
  • High threshold—When disk usage surpasses this threshold, the resource handler performs critical actions and raises a system alarm. By default, the high threshold is set to 90% disk usage. Also by default, all logs except alarm logs are no longer written to disk or processed. 

This article describes how to modify resource handler settings using CLI commands. 

Note: The storage resource handler only affects logs that are written to disk on the local Analytics node. It does not affect logs that are streamed to remote systems using log exporter rules.

To modify settings for the storage resource handler on an Analytics node:

  1. Login to the shell on the Analytics node, start the CLI, and then change to configuration mode. For information about accessing the CLI, see Access the Versa CLI.
admin@Analytics$ cli
admin@Analytics> configure
admin@Analytics% 
  1. To view the configurable options for the storage resource handler, issue the set log-collector-exporter settings storage resource-handler ? command, as shown in the example below.
admin@Analytics% set log-collector-exporter settings storage resource-handler ?
Description: Disk utilization resource handler configuration
Possible completions:
  enable         - Enable resource handler
  high-threshold - Resource handler high threshold configuration
  low-threshold  - Resource handler low threshold configuration
  1. To modify storage resource handler settings, use the following options to the set log-collector-exporter settings storage resource-handler command.
     

    Command Option

    Description

    enable true/false

    Set to true to enable, or false to disable, the storage resource handler:

    Versa Networks recommends that you keep the resource handler enabled.

    For example, the following command enables the storage resource handler:

    admin@Analytics% set log-collector-exporter settings storage resource-handler enabled true

     

    Default: true

    low-threshold or high-threshold

    To change the low threshold, high threshold, and the actions they trigger, include the low-threshold or high-threshold option, followed by the options listed below.

    • allow-logs [ alarm-log ]

    • allow-logs [ ]

    Store only the listed log types when the threshold limit is surpassed. Logs of other types are dropped. Set this option to  [ alarm-log ] to store only alarm logs to disk, or set to [ ] to store all logs on disk.

     

    For example:

    • The following command configures the resource handler to store only alarm logs if the low threshold is surpassed.
      admin@Analytics% set log-collector-exporter settings storage resource-handler low-threshold allow-logs [ alarm-log ]
    • The following command configures the resource handler to store only alarm logs if the high threshold is surpassed.
      admin@Analytics% set log-collector-exporter settings storage resource-handler high-threshold allow-logs [ alarm-log ]

     

    Low-threshold default: All log types are allowed

    High-threshold default: Only logs of type alarm-log are allowed

    • drop-all-connections true/false

    Set to true to enable dropping all local collector connections if the threshold limit is surpassed. These are the LEF connections that the Analytics node uses to receive logs from VOS device. Connections continue to be dropped until disk usage falls below the threshold. Set to false to disable. 

     

    For example, the following command configures the resource handler to drop all connections if the high threshold is surpassed.

    admin@Analytics% set log-collector-exporter settings storage resource-handler high-threshold drop-all-connections true

     

    Low-threshold default: false

    High-threshold default: false

    • enable true/false

    Set to true to enable, or false to disable, low-threshold or high-threshold monitoring.

    Low-threshold default: true

    High-threshold default: true

    • limit disk-usage-percentage

    Enter a value for the threshold, in percentage of disk in use. 

     

    For example, the following command sets the low threshold to 75.

    admin@Analytics% set log-collector-exporter settings storage resource-handler low-threshold limit 75

     

    Low-threshold default: 80

    High-threshold default: 90

     

  2. To list settings for the storage resource handler, issue the following command. These settings override the defaults.

admin@Analytics% show log-collector-exporter settings storage resource-handler                       
low-threshold {
    limit 75;
}
high-threshold {
    limit 88;
}
  1. Issue the commit command to save your changes, and then exit the CLI.

admin@Analytics% commit
admin@Analytics% exit
admin@Analytics> exit
admin@Analytics$

 

Supported Software Information

Releases 22.1.1 and later support all content described in this article. 

  • Was this article helpful?