xrootdlib.structs.XrdXrootdMon.fstat module¶

class FileCLS(flags: int, size: int, fileid: int, read: int, readv: int, write: int, ops: Optional[xrootdlib.structs.XrdXrootdMon.fstat.StatOPS], ssq: Optional[xrootdlib.structs.XrdXrootdMon.fstat.StatSSQ])¶

Bases: object

XrdXrootdMonFileCLS indicating that a client closed a file

Parameters:	flags – indicator for fields present and close type fileid – file identifier (see `Map`) read – bytes read using `read()` readv – bytes read using `readv()` write – bytes written ops – file operation statistics ssq – file operation statistic deviations

fileid¶

flags¶

classmethod from_buffer(buffer: bytes)¶

ops¶

read¶

readv¶

size¶

ssq¶

struct_parser = <Struct object>¶

write¶

xfr¶

class FileDSC(flags: int, dictid: int)¶

Bases: object

XrdXrootdMonFileDSC indicating that a client disconnected from the server

Parameters:	flags – unused for this record type dictid – client identifier (see `Map`)

dictid¶

flags¶

classmethod from_buffer(buffer: bytes)¶

size = 8¶

struct_parser = <Struct object>¶

class FileLFNView(file_opn: xrootdlib.structs.XrdXrootdMon.fstat.FileOPN)¶

Bases: object

lfn¶

user¶

class FileOPN(flags: int, size: int, fileid: int, filesize: int, user: Optional[int] = None, lfn: Optional[bytes] = None)¶

Bases: object

XrdXrootdMonFileOPN indicating that a client opened a file

Parameters:	flags – indicator for fields present and access type size – size of the struct in bytes fileid – file identifier (see `Map`) filesize – size of the file in bytes user – client identifier (see `Map`) lfn – the (logical) path of the file

The fileid, user and lfn are closely related and should be interpreted together. If not rec_flag & hasLFN then fileid points to user info that contains both user and lfn information. Otherwise, the user info should be constructed from user and lfn information for the given fileid as the corresponding FileCLS expects this information.

fileid¶

filesize¶

flags¶

classmethod from_buffer(buffer: bytes)¶

fsz¶

lfn¶

size¶

struct_parser = <Struct object>¶

ufn¶

user¶

FileRecord = typing.Union[xrootdlib.structs.XrdXrootdMon.fstat.FileTOD, xrootdlib.structs.XrdXrootdMon.fstat.FileDSC, xrootdlib.structs.XrdXrootdMon.fstat.FileOPN, xrootdlib.structs.XrdXrootdMon.fstat.FileCLS, xrootdlib.structs.XrdXrootdMon.fstat.FileXFR]¶: Type of records in the f stream

class FileTOD(flags: int, records_xfr: int, records_total: int, start: int, end: int, sid: int)¶

Bases: object

XrdXrootdMonFileTOD identifying the sender and time range

Parameters:	flags – indicator for fields present records_xfr – number of `FileXFR` records in the packet records_total – number of `FileRecord` records in the packet start – timestamp of the first record end – timestamp the packet was sent sid – server identifier (see `Map`)

end¶

flags¶

classmethod from_buffer(buffer: bytes)¶

records_total¶

records_xfr¶

sid¶

size = 24¶

start¶

struct_parser = <Struct object>¶

class FileXFR(flags: int, fileid: int, read: int, readv: int, write: int)¶

Bases: object

XrdXrootdMonFileXFR indicating file transfer statistics

Parameters:	flags – unused fileid – client identifier (see `Map`) read – bytes read using `read()` readv – bytes read using `readv()` write – bytes written

fileid¶

flags¶

classmethod from_buffer(buffer: bytes)¶

read¶

readv¶

size = 32¶

struct_parser = <Struct object>¶

write¶

xfr¶

class StatOPS(read: int, readv: int, write: int, rsmin: int, rsmax: int, rsegs: int, rdmin: int, rdmax: int, rvmin: int, rvmax: int, wrmin: int, wrmax: int)¶

Bases: object

XrdXrootdMonStatOPS describing file operation statistics

classmethod from_buffer(buffer: bytes)¶

rdmax¶

rdmin¶

read¶

readv¶

rsegs¶

rsmax¶

rsmin¶

rvmax¶

rvmin¶

size = 48¶

struct_parser = <Struct object>¶

write¶

wrmax¶

wrmin¶

class StatSSQ(read: int, readv: int, rsegs: int, write: int)¶

Bases: object

XrdXrootdMonStatSSQ describing file operation statistic deviations

classmethod from_buffer(buffer: bytes)¶

read¶

readv¶

rsegs¶

size = 32¶

struct_parser = <Struct object>¶

write¶

class StatXFRView(file_struct: Union[xrootdlib.structs.XrdXrootdMon.fstat.FileCLS, xrootdlib.structs.XrdXrootdMon.fstat.FileXFR])¶

Bases: object

read¶

readv¶

write¶

class recFval¶

Bases: int, enum.Enum

Record flags for the f stream

forced = 1¶: Disconnect prior to close

hasLFN = 1¶: XrdXroodMonFileLFN present

hasOPS = 2¶: XrdXroodMonFileOPS present

hasRW = 2¶: FileRecord opened for reads & writes

hasSID = 1¶: The sID member is present

hasSSQ = 4¶: XrdXroodMonFileSSQ present (implies hasOPS)

class recType¶

Bases: int, enum.Enum

Record type identifiers for the f stream

isClose = 0¶: XrdXrootdMonFileCLS

isDisc = 4¶: XrdXrootdMonFileDSC

isOpen = 1¶: XrdXrootdMonFileOPN

isTime = 2¶: XrdXrootdMonFileTOD

isXFR = 3¶: XrdXrootdMonFileXFR