W E K A
4.0
4.0
  • WEKA v4.0 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 WekaFS
    • Getting started with Weka REST API
  • Planning & Installation
    • Prerequisites for installation
    • Weka installation on bare metal
      • Planning a Weka System Installation
      • Prepare the system for Weka installation
        • SR-IOV enablement
      • 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
  • Performance
    • Weka performance tests
      • Test environment details
  • WekaFS 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
  • Additional Protocols
    • NFS
      • Manage NFS networking using the GUI
      • Manage NFS networking using the CLI
    • SMB
      • Manage SMB using the GUI
      • Manage SMB using the CLI
    • S3
      • 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 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
      • Expand and shrink overview
      • Workflow: Add a backend host
      • Expansion of specific resources
      • 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
      • Collect and upload diagnostics data
    • 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 Weka-mon external monitoring
    • Set up the SnapTool external snapshots manager
  • REST API Reference Guide
Powered by GitBook
On this page
  • Collect diagnostics
  • Upload diagnostics to Weka Home
  1. Support
  2. Diagnostics management

Collect and upload diagnostics data

This page describes the diagnostics CLI commands used for collecting and uploading the diagnostics data.

The diagnostics CLI command is used for collecting and uploading diagnostic data about clusters and hosts for analysis by the Customer Success Team and R&D team to help with troubleshooting. There are two relevant commands:

  • weka diags used for cluster-wide diagnostics from any host in the cluster.

  • weka local diags used for running diagnostics on a specific host, which should be used if the host cannot connect to the cluster.

Collect diagnostics

Command: weka diags collect

Use the following command to create diagnostics information about the Weka software and save it for further analysis by the Customer Success Team:

weka diags collect [--id id] [--timeout timeout] [--output-dir output-dir] [--core-limit core-limit] [--clients] [--tar]

If the command runs with the local keyword, information is collected only from the host on which the command is executed. Otherwise, information is collected from the whole cluster.

Parameters

Name

Type

Value

Limitations

Mandatory

Default

id

String

Specified ID for this dump

No

Auto-generated

timeout

String

How long to wait when downloading diags from all hosts

format: 3s, 2h, 4m, 1d, 1d5h, 1w

0 is infinite

No

10 minutes

output-dir

String

Directory to save the dump to

No

/opt/weka/diags

core-limit

Number

Limit to processing this number of core dumps, if found

No

1

clients

Boolean

Collect from client hosts as well

No

No

tar

Boolean

Create a TAR of all collected diags

No

No

Note: In the following situations the local option should be used: no functioning management process in the originating host or the hosts being addressed, no connectivity between the management process and the cluster leader, the cluster has no leader, the local container is down, the host cannot reach the leader or a remote host fails to respond to the weka diags remote command.

Upload diagnostics to Weka Home

Command: weka diags upload

Use the following command to create diagnostics information about the Weka software and save it for further analysis by the Customer Success Team:

weka diags upload [--timeout timeout] [--core-limit core-limit] [--dump-id dump-id] [--host-id host-id]... [--clients]

Parameters

Name

Type

Value

Limitations

Mandatory

Default

timeout

String

How long to wait for diags to upload

format: 3s, 2h, 4m, 1d, 1d5h, 1w

0 is infinite

No

10 minutes

core-limit

Number

Limit to processing this number of core dumps, if found

No

1

dump-id

String

ID of an existing dump to upload

This dump ID has to exist on this local machine

No

If an ID is not specified, a new dump is created

host-id

Comma-separated list of numbers

Host IDs to collect diags from

This flag causes --clients to be ignored

No

All hosts

clients

Boolean

Collect from client hosts as well

No

No

When running the command with the upload option, the information is uploaded to the Weka support cloud (Weka Home), and an access identifier is provided as an output. You send this access identifier to the Customer Success Team for retrieving the information from the Weka Home.

Note: The upload command requires HTTPS access to AWS S3 endpoints.

Note: The upload process is asynchronous. Therefore connectivity failures are reflected in failure events on the event log, while the command still exits successfully.the

PreviousManage protocols debug level using the CLINextWeka Home - The Weka support cloud

Last updated 2 years ago