Skip to main content

Settings

Settings

This chapter covers the customer-configurable system and session settings: how capacity numbers are displayed, how CLI output is formatted, and anomaly detection thresholds for capacity monitoring.

Capacity display units

Every capacity value StorONE displays —— drive sizes, pool capacity, volume capacity, performance statistics —— can be shown using either binary units (mebibyte, gibibyte, tebibyte... base-1024) or decimal units (megabyte, gigabyte, terabyte... base-1000). This is a display preference only; it doesn't change how capacity is actually allocated. It also affects how single-letter capacity units (G, T, and so on) are interpreted when you type them into other commands —— see the note on --capacity in Volumes.

Using the web interface

  1. Open Administration > Settings.
  2. Under Unit Selection, choose Binary Units or Decimal Units.
  3. Confirm the change.

Using the CLI

settings capacity_units [--binaryUnits | --decimalUnits]
Option Description
--binaryUnits Use binary (base-1024) units: mebibyte, gibibyte, tebibyte, pebibyte...
--decimalUnits Use decimal (base-1000) units: megabyte, gigabyte, terabyte, petabyte...

Example

settings capacity_units --decimalUnits

CLI output format

By default, the CLI prints command output as a readable tree. You can switch to a different format —— useful when you're piping output into another tool, or want a specific structured format for scripting. You can also redirect output to a file instead of (or in addition to) the console.

This setting only affects how the CLI itself renders output for the rest of your session. It isn't available through the REST API (API responses have their own format), and it has no dedicated web interface control, since the web interface renders its own views rather than displaying raw command output.

Using the CLI

settings output --tree|--table|--csv|--json|--xml|--yaml|--prometheus [--noOutputRedirection|--outputRedirectionPath=<text>]
Option Description
--tree Change output type to tree mode.
--table Change output type to table.
--csv Change output type to CSV.
--json Change output type to JSON.
--xml Change output type to XML.
--yaml Change output type to YAML.
--prometheus Change output type to Prometheus.
--noOutputRedirection Disable output redirection.
--outputRedirectionPath=<text> File redirection path for the CLI output.

Examples

Switch to JSON output, for piping into a script:

settings output --json

Switch to CSV and also redirect all further output to a file:

settings output --csv --outputRedirectionPath "C:\logs\s1-output.csv"

Anomaly detection

Anomaly detection watches your system's historic capacity statistics and alerts your configured notification targets when a day's change is unusually large compared to recent history —— for example, a sudden spike in consumption that might indicate a runaway process or an unexpected workload change.

It works off two settings:

  • Timeframe —— how many days of historic statistics to consider when establishing what's "normal."
  • Change threshold —— how large a day's change has to be, as a percentage of the timeframe's observed min/max range, before it's flagged as abnormal. For example, a threshold of 300 means today's change must be 3 times (300%) above the max or below the min seen in the timeframe before it's flagged.

Setting either value to 0 disables anomaly detection.

Viewing anomaly detection settings

Viewing the current settings is CLI/API-only; there's no dedicated web interface page for it (the settings can still be changed from the web interface —— see below).

Using the CLI

settings anomaly_detection show

This command takes no parameters.

Updating anomaly detection settings

Using the web interface

  1. Open Administration > Settings.
  2. Under Anomaly Detection, enter the Timeframe (days) and the Change percentage threshold.
  3. Confirm the change.

Using the CLI

settings anomaly_detection edit --timeframe_days=<numbers> --change=<numbers>
Option Description
--timeframe_days=<numbers> Number of days to consider for historic statistics (1-60 days). Setting 0 disables anomaly detection.
--change=<numbers> Percentage of capacity change to consider as "abnormal" for notification. For example, 300 means today's change is 3 times (300%) above the max or below the min in the timeframe. Setting 0 disables anomaly detection.

Examples

Watch the last 14 days, and alert on a change 3x beyond the observed range:

settings anomaly_detection edit --timeframe_days 14 --change 300

Disable anomaly detection:

settings anomaly_detection edit --timeframe_days 0 --change 0

See also: Users & Permissions ·· License