W E K A
4.1
4.1
  • WEKA v4.1 documentation
  • WEKA System Overview
    • About the WEKA system
    • SSD capacity management
    • Filesystems, object stores, and filesystem groups
    • WEKA networking
    • Data lifecycle management
    • WEKA client and mount modes
    • WEKA containers architecture overview
    • Glossary
  • Getting Started with WEKA
    • Quick installation guide
    • Manage the system using the WEKA CLI
    • Manage the system using the WEKA GUI
    • Run first IOs with WEKA filesystem
    • Getting started with WEKA REST API
  • Planning and Installation
    • Prerequisites for installation
    • WEKA installation on bare metal
      • Plan the WEKA system Installation
      • Prepare the system for WEKA software installation
        • Enable the SR-IOV
      • Obtain the WEKA software installation package
      • WEKA cluster installation
        • WEKA legacy system installation process
      • Add clients
    • WEKA installation on AWS
      • Self-service portal
      • CloudFormation template generator
      • Deployment types
      • AWS outposts deployment
      • Supported EC2 instance types
      • Add clients
      • Auto scaling group
      • Troubleshooting
    • WEKA installation on Azure
    • WEKA installation on GCP
      • WEKA project description
      • Deployment on GCP using Terraform
      • GCP Terraform package description
      • Required services and supported regions
      • Supported machine types and storage
      • Auto-scale instances in GCP
      • Add clients
      • Troubleshooting
  • Performance
    • WEKA performance tests
      • Test environment details
  • WEKA Filesystems & Object Stores
    • Manage object stores
      • Manage object stores using the GUI
      • Manage object stores using the CLI
    • Manage filesystem groups
      • Manage filesystem groups using the GUI
      • Manage filesystem groups using the CLI
    • Manage filesystems
      • Manage filesystems using the GUI
      • Manage filesystems using the CLI
    • Attach or detach object store buckets
      • Attach or detach object store bucket using the GUI
      • Attach or detach object store buckets using the CLI
    • Advanced data lifecycle management
      • Advanced time-based policies for data storage location
      • Data management in tiered filesystems
      • Transition between tiered and SSD-only filesystems
      • Manual fetch and release of data
    • Mount filesystems
    • Snapshots
      • Manage snapshots using the GUI
      • Manage snapshots using the CLI
    • Snap-To-Object
      • Manage Snap-To-Object using the GUI
      • Manage Snap-To-Object using the CLI
    • Quota management
      • Manage quotas using the GUI
      • Manage quotas using the CLI
  • Additional Protocols
    • Manage the NFS protocol
      • Supported NFS client mount options
      • Manage NFS networking using the GUI
      • Manage NFS networking using the CLI
    • Manage the SMB protocol
      • Manage SMB using the GUI
      • Manage SMB using the CLI
    • Manage the S3 protocol
      • S3 cluster management
        • Manage the S3 service using the GUI
        • Manage the S3 service using the CLI
      • S3 buckets management
        • Manage S3 buckets using the GUI
        • Manage S3 buckets using the CLI
      • S3 users and authentication
        • Manage S3 users and authentication using the CLI
        • Manage S3 service accounts using the CLI
      • S3 rules information lifecycle management (ILM)
        • Manage S3 lifecycle rules using the GUI
        • Manage S3 lifecycle rules using the CLI
      • Audit S3 APIs
        • Configure audit webhook using the GUI
        • Configure audit webhook using the CLI
        • Example: How to use Splunk to audit S3
      • S3 supported APIs and limitations
      • S3 examples using boto3
  • Operation Guide
    • Alerts
      • Manage alerts using the GUI
      • Manage alerts using the CLI
      • List of alerts and corrective actions
    • Events
      • Manage events using the GUI
      • Manage events using the CLI
      • List of events
    • Statistics
      • Manage statistics using the GUI
      • Manage statistics using the CLI
      • List of statistics
    • System congestion
    • Security management
      • Obtain authentication tokens
      • KMS management
        • Manage KMS using the GUI
        • Manage KMS using the CLI
      • TLS certificate management
        • Manage the TLS certificate using the GUI
        • Manage the TLS certificate using the CLI
      • CA certificate management
        • Manage the CA certificate using the GUI
        • Manage the CA certificate using the CLI
      • Account lockout threshold policy management
        • Manage the account lockout threshold policy using GUI
        • Manage the account lockout threshold policy using CLI
      • Manage the login banner
        • Manage the login banner using the GUI
        • Manage the login banner using the CLI
    • User management
      • Manage users using the GUI
      • Manage users using the CLI
    • Organizations management
      • Manage organizations using the GUI
      • Manage organizations using the CLI
      • Mount authentication for organization filesystems
    • Expand and shrink cluster resources
      • Add a backend server in a multiple containers architecture
      • Add a backend server in a legacy architecture
      • Expand specific resources of a container
      • Shrink a cluster
    • Background tasks
    • Upgrade WEKA versions
  • Billing & Licensing
    • License overview
    • Classic license
    • Pay-As-You-Go license
  • Support
    • Prerequisites and compatibility
    • Get support for your WEKA system
    • Diagnostics management
      • Traces management
        • Manage traces using the GUI
        • Manage traces using the CLI
      • Protocols debug level management
        • Manage protocols debug level using the GUI
        • Manage protocols debug level using the CLI
      • Diagnostics data management
    • Weka Home - The WEKA support cloud
      • Local Weka Home overview
      • Local Weka Home deployment
      • Set the Local Weka Home to send alerts or events
      • Download the Usage Report or Analytics
  • Appendix
    • WEKA CSI Plugin
    • Set up the WEKAmon external monitoring
    • Set up the SnapTool external snapshots manager
  • REST API Reference Guide
Powered by GitBook
On this page
  • List statistics types
  • View statistics in real-time
  • View statistics over time
  • Set statistics retention
  1. Operation Guide
  2. Statistics

Manage statistics using the CLI

This page describes how to manage the statistics using the CLI.

PreviousManage statistics using the GUINextList of statistics

Last updated 2 years ago

Using the CLI, you can:

List statistics types

Command: weka stats list-types

Use the following command line to obtain statistics definition information: weka stats list-types [<name-or-category>] [--show-internal]

Parameters

Name

Type

Value

Limitations

Mandatory

Default

name-or-category

String

Name or category fo filter by

Valid name or category

No

show-internal

Boolean

Also displays internal statistics

No

False

View statistics in real-time

Command: weka stats realtime

Use the following command line to obtain the current performance-related statistics of the processes in a one-second interval: weka stats realtime [<process-ids>] [--raw-units] [--UTC]

Parameters

Name

Type

Value

Limitations

Mandatory

Default

process-ids

Comma-separated strings

Only show real-time stats of these processes

No

raw-units

Boolean

Print values in raw units (bytes, seconds, etc.)

No

Human-readable format, e.g 1KiB 234MiB 2GiB

UTC

Boolean

Print times in UTC

No

Server's local time

View statistics over time

Command: weka stats

The collected statistics can help analyze system performance and determine the source of issues that may occur during WEKA system runs. Statistics are divided according to categories. When selecting a category, a list of the possible statistics is displayed, from which you can select the specific statistics.

Note: WEKA averages all statistics over one-second intervals. Consequently, the total value or other aggregates relate to a specific minute.

Use the following command line to manage filters and read statistics:

weka stats [--start-time <start-time>] [--end-time <end-time>] [--interval interval] [--resolution-secs resolution-secs] [--category category][--stat stat] [--process-ids process-ids] [--param param] [--accumulated] [--per-process] [--no-zeros] [--show-internal] [--raw-units] [--UTC]

Parameters

Name

Type

Value

Limitations

Mandatory

Default

start-time

String

Start time of the reported period

Format: 5m, -5m, -1d, -1w, 1:00, 01:00, 18:30, 18:30:07, 2018-12-31 10:00, 2018/12/31 10:00, 2018-12-31T10:00, 9:15Z, 10:00+2:00

No

-1m

end-time

String

End time of the reported period

Format: 5m, -5m, -1d, -1w, 1:00, 01:00, 18:30, 18:30:07, 2018-12-31 10:00, 2018/12/31 10:00, 2018-12-31T10:00, 9:15Z, 10:00+2:00

No

Current time

interval

String

Period of time to be reported

Valid interval in seconds (positive integer number)

Yes

resolution-secs

String

Length of each interval in the reported period

Must be multiples of 60 seconds

No

60

category

String

Specific categories for retrieval of appropriate statistics

Valid existing categories: CPU, Object Store, Operations, Operations (NFS), Operations (Driver), SSD

No

All

stat

String

Statistics names

Valid statistics names

No

All

process-ids

String

Process id

Valid process-id

No

All

param

String

For parameterized statistics, retrieve only the instantiations where the specified parameter is of the specified value. Multiple values can be supplied for the same key, e.g. '--param method:putBlocks --param method:initBlock'

Format: key:val

No

accumulated

Boolean

Display accumulated statistics, not rate statistics

No

False

per-process

Boolean

Does not aggregate statistics across processes

No

False

no-zeros

Boolean

Filters results where the value is 0

No

False

show-internal

Boolean

Also displays internal statistics

No

False

raw-units

Boolean

Print values in raw units (bytes, seconds, etc.)

No

Human-readable format, e.g 1KiB 234MiB 2GiB

UTC

Boolean

Print times in UTC

No

Server's local time

Set statistics retention

Command: weka stats retention set

Use the following command line to set the statistics retention period. weka stats retention set <--days days> [--dry-run]

Parameters

Name

Type

Value

Limitations

Mandatory

Default

days

Number

The Number of days to keep the statistics

Should have enough free disk space per server

Yes

dry-run

Boolean

Only test the required capacity per the retention period

No

Use weka stats retention status to view the current retention and weka stats retention restore-default to restore the default retention settings.

List statistics types
View statistics in real-time
View statistics over time
Set statistics retention