Qumulo Activity Scanner

A utility for collecting real-time activity information from a Qumulo cluster. The script retrieves current activity data from Qumulo Analytics and resolves all file IDs to paths.

Features

• Collects read/write operations statistics for files
• Monitors both file I/O and metadata operations
• Resolves file IDs to full file paths
• Returns data in a structured format suitable for monitoring systems

Installation

# Clone the repository
git clone https://github.com/qumulo/qumulo-activity-scanner.git
cd qumulo-activity-scanner

# Set up a virtual environment (recommended)
python3 -m venv venv
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt

Usage

1. Generate an authentication token for your Qumulo cluster:

qq --host qumulo.example.com login -u ad\\username
qq --host qumulo.example.com auth_create_access_token \
  --file ~/.config/qumulo.example.com-monitoring.token \
  --expiration-time 'Oct 24 2030' ad\\username

2. Run the script:

python scan-activity.py

3. For integration with other applications:

from qumulo_activity_scanner import collect_activity
from qumulo.rest_client import RestClient
from qumulo.lib import auth

# Create a REST client
token = auth.get_credentials('path/to/token')
rest = RestClient('qumulo.example.com', 8000, credentials=token)

# Collect activity
activity = collect_activity(rest)

Configuration

You can customize the activity types to monitor by modifying the PERF_TYPES list in the script.

Recommended Environment Variables

• QUMULO_HOST: The hostname of your Qumulo cluster (default: qumulo.example.com)
• QUMULO_AUTH_TOKEN: Path to the authentication token file

License

This project is licensed under the MIT License - see the LICENSE file for details.

Security Considerations

For production use, create a restricted local user with minimal required permissions instead of using an AD user or admin account.