Scroll to navigation

mfscli(1) This is part of MooseFS mfscli(1)

NAME

mfscli - CGI in TXT mode

SYNOPSIS

mfscli [-jpn28] [-H master_host] [-P master_port] [-f 0..3] -S(IN|IM|LI|IG|MU|IC|IL|MF|CS|MB|HD|EX|MS|RS|SC|PA|OF|AL|MO|QU|MC|CC) [-s separator] [-o order_id [-r]] [-m mode_id] [-i id] [-a master_data_count] [-b master_data_desc] [-c chunkserver_data_count] [-d chunkserver_data_desc]

mfscli [-pn28] [-H master_host] [-P master_port] [-f 0..3] -C(RC/ip/port|BW/ip/port|M[01]/ip/port|RS/sessionid|TR/ip/port)

mfscli -h

DESCRIPTION

mfscli is a commandline counterpart to MooseFS's CGI interface. All the information available in CGI (except for graphs) can be obtained via CLI using different "monitoring options"

OPTIONS

print help message and exit
print result in JSON format
force plain text format on tty devices
do not resolve ip addresses (default when output device is not tty)
field separator to use in plain text format on tty devices (forces -p)
-2
force 256-color terminal color codes
-8
force 8-color terminal color codes
master address (default: mfsmaster)
master client port (default: 9421)
set frame charset to be displayed as table frames in ttymode;
0
simple ascii frames '+','-','|' (default)
1
thick unicode frames
2
thin unicode frames
3
double unicode frames (dos style)
sort data by column specified by 'order id' (depends on data set)
reverse sort order
show data specified by 'mode id' (depends on data set)
sessionid for -SOF or inode for -SAL
how many chart entries should be shown for master (-SMC)
define chart columns for master; prefix with '+' for raw data, (pro only) prefix with 'ip:[port:]' for server choice (by default leader master will be used); use 'all' as a chart name for all available charts
how many chart entries should be shown for chunkserver
define chart columns for chunkserver; prefix with '+' for raw data, prefix with 'ip:[port:]' for server choice (by default all servers will be used); use 'all' as a chart name for all available charts

MONITORING OPTIONS

show full master info
show only masters states
(pro only) show only licence info
show only general master (in pro version: leader) info
show only master memory usage
show only chunks info (goal/copies matrices)
show only loop info (with messages)
show only missing chunks/files (report from last full chunk loop)
show connected chunk servers
show connected metadata backup servers
show hdd data
show exports
show active mounts
show resources (storage classes,patterns,open files,acquired locks)
show storage classes info
show patterns override data
show only open files
show only acquired locks
show operation counters
show quota info
show master charts data
show chunkserver charts data

MASTER CHART DATA COLUMNS

User cpu usage
System cpu usage
Number of chunk deletion attempts
Number of chunk replication attempts
Number of statfs operations
Number of getattr operations
Number of setattr operations
Number of lookup operations
Number of mkdir operations
Number of rmdir operations
Number of symlink operations
Number of readlink operations
Number of mknod operations
Number of unlink operations
Number of rename operations
Number of link operations
Number of readdir operations
Number of open operations
Number of chunk_read operations
Number of chunk_write operations
Resident memory usage
Received packets
Sent packets
Received bytes
Sent bytes
Virtual memory usage
RAW disk space usage
RAW disk space connected
Number of chunk creation attempts
Number of chunk internal operation attempts
Number of successful chunk deletions
Number of unsuccessful chunk deletions
Number of successful chunk replications
Number of unsuccessful chunk replications
Number of successful chunk creations
Number of unsuccessful chunk creations
Number of successful chunk internal operations
Number of unsuccessful chunk internal operations
Number of successful chunk split operations
Number of unsuccessful chunk split operations
Number of file objects
Number of non-file objects (directories,symlinks,etc.)
Total number of chunks stored in EC8 format
Total number of chunks stored in EC4 format
Total number of chunks stored in COPY format
Number of endangered chunks (mark for removal excluded)
Number of undergoal chunks (mark for removal excluded)
Number of endangered chunks (mark for removal included)
Number of undergoal chunks (mark for removal included)
Average number of bytes read per second by all clients
Average number of bytes written per second by all clients
Number of read operations
Number of write operations
Number of fsync operations
Number of lock operations
Number of snapshot operations
Number of truncate operations
Number of getxattr operations
Number of setxattr operations
Number of getfacl operations
Number of setfacl operations
Number of file create operations
Number of extra metadata operations (sclass,trashretention,eattr etc.)
(pro only) Master max delay in seconds
Number of all registered chunk servers (both connected and disconnected)
Number of disconnected chunk servers that are in maintenance mode
Number of disconnected chunk servers that are not in maintenance mode
Difference in space usage percent between the most and least used chunk server
Total cpu usage (scpu + ucpu)

CHUNKSERVER CHART DATA COLUMNS

User cpu usage
System cpu usage
Data received from master
Data sent to master
Data received by replicator
Data sent by replicator
Data received by csserv
Data sent by csserv
Bytes read (headers)
Bytes written (headers)
Low level reads (headers)
Low level writes (headers)
Bytes read (data)
Bytes written (data)
Low level reads (data)
Low level writes (data)
High level reads
High level writes
Read time
Write time
Replicate chunk ops
Create chunk ops
Delete chunk ops
Set version ops
Duplicate ops
Truncate ops
Duptrunc (duplicate+truncate) ops
Test chunk ops
Server load
Resident memory usage
Virtual memory usage
Low speed move ops
High speed move ops
Split ops
Used HDD space in bytes (mark for removal excluded)
Total HDD space in bytes (mark for removal excluded)
Number of stored chunks (mark for removal excluded)
Used HDD space in bytes on disks marked for removal
Total HDD space in bytes on disks marked for removal
Number of chunks stored on disks marked for removal
Number of chunks stored in copy format (all disks)
Number of chunk parts stored in EC4 format (all disks)
Number of chunk parts stored in EC8 format (all disks)
Number of valid folders (hard drives)
Number of folders (hard drives) that are marked for removal
Number of folders (hard drives) that are marked as damaged
Difference in usage percent between the most and least used disk
Total cpu usage (scpu + ucpu)

COMMANDS

remove selected chunkserver from list of active chunkservers
temporarily remove selected chunkserver from list of active chunkservers (master elect only)
send selected chunkserver back to work state (from grace state)
switch selected chunkserver to maintenance mode
switch selected chunkserver to standard mode (from maintenance mode)
remove selected session

EXAMPLES

shows table with chunk state matrix (number of chunks for each combination of valid copies and goal set by user) using extended terminal colors (256-colors)
shows table with all chunkservers using unicode thick frames
shows current sessions (mounts) using plain text format and coma as a separator
shows files open by processes using session (mount) with id 123
shows master cpu usage, amount of resident memory used by master, number of chunk deletions and number of chunk replications during last ten minutes
shows cpu usage of chunkservers located on machines with IP 192.168.1.10 and 192.168.1.11 during last fifteen minutes
shows resident memory usage of all connected chunkservers (old mfscli - before version 4.32.2)
shows resident memory usage of all connected chunkservers (current mfscli)
prints basic infos in JSON format

REPORTING BUGS

Report bugs to <bugs@moosefs.com>.

COPYRIGHT

Copyright (C) 2024 Jakub Kruszona-Zawadzki, Saglabs SA

This file is part of MooseFS.

MooseFS is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2 (only).

MooseFS is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with MooseFS; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02111-1301, USA or visit http://www.gnu.org/licenses/gpl-2.0.html

SEE ALSO

mfsmaster(8)

September 2024 MooseFS 4.56.6-1