Package rst.monitoring

Not documented

Messages

digraph message_graph { fontname="Arial"; fontsize=11; stylesheet="../_static/graphs.css"; node [fontsize=11,fontname="Arial"] edge [fontsize=11,fontname="Arial"] "3" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCuesCollection" TITLE="Message rst.monitoring.ProcessCuesCollection" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message-sandbox.svg"></IMG></TD><TD ALIGN="left">ProcessCuesCollection</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues" TITLE="Message rst.monitoring.ProcessCues" TARGET="_parent">ProcessCues</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCuesCollection.element" TITLE="Field rst.monitoring.ProcessCuesCollection.element" TARGET="_parent" PORT="element">element</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"]; "4" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues" TITLE="Message rst.monitoring.ProcessCues" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message-sandbox.svg"></IMG></TD><TD ALIGN="left">ProcessCues</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-UINT32.html#UINT32" TITLE="Fundamental UINT32" TARGET="_parent">UINT32</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.pid" TITLE="Field rst.monitoring.ProcessCues.pid" TARGET="_parent" PORT="pid">pid</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-OCTET-VECTOR.html#OCTET-VECTOR" TITLE="Fundamental OCTET-VECTOR" TARGET="_parent">OCTET-VECTOR</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.name" TITLE="Field rst.monitoring.ProcessCues.name" TARGET="_parent" PORT="name">name</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-OCTET-VECTOR.html#OCTET-VECTOR" TITLE="Fundamental OCTET-VECTOR" TARGET="_parent">OCTET-VECTOR</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.host_name" TITLE="Field rst.monitoring.ProcessCues.host_name" TARGET="_parent" PORT="host_name">host_name</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-ASCII-STRING.html#ASCII-STRING" TITLE="Fundamental ASCII-STRING" TARGET="_parent">ASCII-STRING</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.command_line" TITLE="Field rst.monitoring.ProcessCues.command_line" TARGET="_parent" PORT="command_line">command_line</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-OCTET-VECTOR.html#OCTET-VECTOR" TITLE="Fundamental OCTET-VECTOR" TARGET="_parent">OCTET-VECTOR</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.unique_id" TITLE="Field rst.monitoring.ProcessCues.unique_id" TARGET="_parent" PORT="unique_id">unique_id</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues" TITLE="Message rst.monitoring.ProcessCues.Cues" TARGET="_parent">Cues</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.cues" TITLE="Field rst.monitoring.ProcessCues.cues" TARGET="_parent" PORT="cues">cues</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Thread" TITLE="Message rst.monitoring.ProcessCues.Thread" TARGET="_parent">Thread</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.threads" TITLE="Field rst.monitoring.ProcessCues.threads" TARGET="_parent" PORT="threads">threads</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues" TITLE="Message rst.monitoring.ProcessCues" TARGET="_parent">ProcessCues</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.children" TITLE="Field rst.monitoring.ProcessCues.children" TARGET="_parent" PORT="children">children</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"]; "6" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Thread" TITLE="Message rst.monitoring.ProcessCues.Thread" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message-sandbox.svg"></IMG></TD><TD ALIGN="left">Thread</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-OCTET-VECTOR.html#OCTET-VECTOR" TITLE="Fundamental OCTET-VECTOR" TARGET="_parent">OCTET-VECTOR</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Thread.name" TITLE="Field rst.monitoring.ProcessCues.Thread.name" TARGET="_parent" PORT="name">name</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-UINT32.html#UINT32" TITLE="Fundamental UINT32" TARGET="_parent">UINT32</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Thread.tid" TITLE="Field rst.monitoring.ProcessCues.Thread.tid" TARGET="_parent" PORT="tid">tid</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues" TITLE="Message rst.monitoring.ProcessCues.Cues" TARGET="_parent">Cues</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Thread.cues" TITLE="Field rst.monitoring.ProcessCues.Thread.cues" TARGET="_parent" PORT="cues">cues</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"]; "5" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues" TITLE="Message rst.monitoring.ProcessCues.Cues" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message-sandbox.svg"></IMG></TD><TD ALIGN="left">Cues</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-OCTET-VECTOR.html#OCTET-VECTOR" TITLE="Fundamental OCTET-VECTOR" TARGET="_parent">OCTET-VECTOR</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.source" TITLE="Field rst.monitoring.ProcessCues.Cues.source" TARGET="_parent" PORT="source">source</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-UINT64.html#UINT64" TITLE="Fundamental UINT64" TARGET="_parent">UINT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.utime" TITLE="Field rst.monitoring.ProcessCues.Cues.utime" TARGET="_parent" PORT="utime">utime</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-UINT64.html#UINT64" TITLE="Fundamental UINT64" TARGET="_parent">UINT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.stime" TITLE="Field rst.monitoring.ProcessCues.Cues.stime" TARGET="_parent" PORT="stime">stime</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-INT64.html#INT64" TITLE="Fundamental INT64" TARGET="_parent">INT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.num_threads" TITLE="Field rst.monitoring.ProcessCues.Cues.num_threads" TARGET="_parent" PORT="num_threads">num_threads</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-UINT64.html#UINT64" TITLE="Fundamental UINT64" TARGET="_parent">UINT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.vsize" TITLE="Field rst.monitoring.ProcessCues.Cues.vsize" TARGET="_parent" PORT="vsize">vsize</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-INT64.html#INT64" TITLE="Fundamental INT64" TARGET="_parent">INT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.rss" TITLE="Field rst.monitoring.ProcessCues.Cues.rss" TARGET="_parent" PORT="rss">rss</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-UINT64.html#UINT64" TITLE="Fundamental UINT64" TARGET="_parent">UINT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.wall_time" TITLE="Field rst.monitoring.ProcessCues.Cues.wall_time" TARGET="_parent" PORT="wall_time">wall_time</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-UINT64.html#UINT64" TITLE="Fundamental UINT64" TARGET="_parent">UINT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.virtual_time" TITLE="Field rst.monitoring.ProcessCues.Cues.virtual_time" TARGET="_parent" PORT="virtual_time">virtual_time</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-UINT64.html#UINT64" TITLE="Fundamental UINT64" TARGET="_parent">UINT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.etime" TITLE="Field rst.monitoring.ProcessCues.Cues.etime" TARGET="_parent" PORT="etime">etime</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-UINT64.html#UINT64" TITLE="Fundamental UINT64" TARGET="_parent">UINT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.utime_scaled" TITLE="Field rst.monitoring.ProcessCues.Cues.utime_scaled" TARGET="_parent" PORT="utime_scaled">utime_scaled</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-UINT64.html#UINT64" TITLE="Fundamental UINT64" TARGET="_parent">UINT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.stime_scaled" TITLE="Field rst.monitoring.ProcessCues.Cues.stime_scaled" TARGET="_parent" PORT="stime_scaled">stime_scaled</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-UINT64.html#UINT64" TITLE="Fundamental UINT64" TARGET="_parent">UINT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.wall_time_scaled" TITLE="Field rst.monitoring.ProcessCues.Cues.wall_time_scaled" TARGET="_parent" PORT="wall_time_scaled">wall_time_scaled</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-UINT64.html#UINT64" TITLE="Fundamental UINT64" TARGET="_parent">UINT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.start_time" TITLE="Field rst.monitoring.ProcessCues.Cues.start_time" TARGET="_parent" PORT="start_time">start_time</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-UINT64.html#UINT64" TITLE="Fundamental UINT64" TARGET="_parent">UINT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.rchar" TITLE="Field rst.monitoring.ProcessCues.Cues.rchar" TARGET="_parent" PORT="rchar">rchar</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-UINT64.html#UINT64" TITLE="Fundamental UINT64" TARGET="_parent">UINT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.wchar" TITLE="Field rst.monitoring.ProcessCues.Cues.wchar" TARGET="_parent" PORT="wchar">wchar</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-UINT64.html#UINT64" TITLE="Fundamental UINT64" TARGET="_parent">UINT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.read_bytes" TITLE="Field rst.monitoring.ProcessCues.Cues.read_bytes" TARGET="_parent" PORT="read_bytes">read_bytes</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-UINT64.html#UINT64" TITLE="Fundamental UINT64" TARGET="_parent">UINT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.write_bytes" TITLE="Field rst.monitoring.ProcessCues.Cues.write_bytes" TARGET="_parent" PORT="write_bytes">write_bytes</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-UINT32.html#UINT32" TITLE="Fundamental UINT32" TARGET="_parent">UINT32</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.open_fds" TITLE="Field rst.monitoring.ProcessCues.Cues.open_fds" TARGET="_parent" PORT="open_fds">open_fds</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-UINT32.html#UINT32" TITLE="Fundamental UINT32" TARGET="_parent">UINT32</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.open_files" TITLE="Field rst.monitoring.ProcessCues.Cues.open_files" TARGET="_parent" PORT="open_files">open_files</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-UINT32.html#UINT32" TITLE="Fundamental UINT32" TARGET="_parent">UINT32</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.open_connections" TITLE="Field rst.monitoring.ProcessCues.Cues.open_connections" TARGET="_parent" PORT="open_connections">open_connections</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-UINT64.html#UINT64" TITLE="Fundamental UINT64" TARGET="_parent">UINT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.received_bytes" TITLE="Field rst.monitoring.ProcessCues.Cues.received_bytes" TARGET="_parent" PORT="received_bytes">received_bytes</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-UINT64.html#UINT64" TITLE="Fundamental UINT64" TARGET="_parent">UINT64</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessCues.Cues.sent_bytes" TITLE="Field rst.monitoring.ProcessCues.Cues.sent_bytes" TARGET="_parent" PORT="sent_bytes">sent_bytes</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"]; "1" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessAnomalyCollection" TITLE="Message rst.monitoring.ProcessAnomalyCollection" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message-sandbox.svg"></IMG></TD><TD ALIGN="left">ProcessAnomalyCollection</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessAnomaly" TITLE="Message rst.monitoring.ProcessAnomaly" TARGET="_parent">ProcessAnomaly</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessAnomalyCollection.element" TITLE="Field rst.monitoring.ProcessAnomalyCollection.element" TARGET="_parent" PORT="element">element</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"]; "2" [label=<<TABLE BORDER="0"><TR><TD COLSPAN="2" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessAnomaly" TITLE="Message rst.monitoring.ProcessAnomaly" TARGET="_parent"><TABLE BORDER="0"><TR><TD ALIGN="right"><IMG SRC="../_static/message-sandbox.svg"></IMG></TD><TD ALIGN="left">ProcessAnomaly</TD></TR></TABLE></TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-UINT32.html#UINT32" TITLE="Fundamental UINT32" TARGET="_parent">UINT32</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessAnomaly.pid" TITLE="Field rst.monitoring.ProcessAnomaly.pid" TARGET="_parent" PORT="pid">pid</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-OCTET-VECTOR.html#OCTET-VECTOR" TITLE="Fundamental OCTET-VECTOR" TARGET="_parent">OCTET-VECTOR</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessAnomaly.name" TITLE="Field rst.monitoring.ProcessAnomaly.name" TARGET="_parent" PORT="name">name</TD></TR><TR><TD ALIGN="left" HREF="../generated/stable/package-__rosetta-OCTET-VECTOR.html#OCTET-VECTOR" TITLE="Fundamental OCTET-VECTOR" TARGET="_parent">OCTET-VECTOR</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessAnomaly.host_name" TITLE="Field rst.monitoring.ProcessAnomaly.host_name" TARGET="_parent" PORT="host_name">host_name</TD></TR><TR><TD ALIGN="left" HREF="../generated/sandbox/package-__rosetta-ASCII-STRING.html#ASCII-STRING" TITLE="Fundamental ASCII-STRING" TARGET="_parent">ASCII-STRING</TD><TD ALIGN="left" HREF="../generated/sandbox/package-rst-monitoring.html#rst.monitoring.ProcessAnomaly.reasons" TITLE="Field rst.monitoring.ProcessAnomaly.reasons" TARGET="_parent" PORT="reasons">reasons</TD></TR></TABLE>>,shape=box,style=filled,fillcolor="white"]; "3":element -> "4"[]; "4" -> "6"[dir=both,arrowtail=odiamond]; "4" -> "5"[dir=both,arrowtail=odiamond]; "4":children -> "4"[]; "4":threads -> "6"[]; "4":cues -> "5"[]; "6":cues -> "5"[]; "1":element -> "2"[]; }

clearer: should be made invisible via css

Message ProcessAnomalyCollection

class rst.monitoring.ProcessAnomalyCollection

Collection of ProcessAnomaly instances.

Auto-generated.

element
Type:array of rst.monitoring.ProcessAnomaly

The individual elements of the collection.

Constraints regarding the empty collection, sorting, duplicated entries etc. are use case specific.

Download this file

message ProcessAnomalyCollection {

    /**
     * The individual elements of the collection.
     *
     * Constraints regarding the empty collection, sorting, duplicated
     * entries etc. are use case specific.
     */
    repeated ProcessAnomaly element = 1;

}

Message ProcessCuesCollection

class rst.monitoring.ProcessCuesCollection

Collection of ProcessCues instances.

Auto-generated.

element
Type:array of rst.monitoring.ProcessCues

The individual elements of the collection.

Constraints regarding the empty collection, sorting, duplicated entries etc. are use case specific.

Download this file

message ProcessCuesCollection {

    /**
     * The individual elements of the collection.
     *
     * Constraints regarding the empty collection, sorting, duplicated
     * entries etc. are use case specific.
     */
    repeated ProcessCues element = 1;

}

Message ProcessAnomaly

class rst.monitoring.ProcessAnomaly

A message to describe a detected anomaly inside a system-level process.

Code author: Johannes Wienke <jwienke@techfak.uni-bielefeld.de>

Todo

this message requires serious abstraction once the
functionality of all cue providers is understood. Do not move it to stable!

@create_collection

pid
Type:UINT32

PID of the program.

name
Type:OCTET-VECTOR

Name of the program (argv[0]).

host_name
Type:OCTET-VECTOR

Name of the host the program is running on.

reasons
Type:array of ASCII-STRING

A use-case-dependent list of reasons for the detection of this anomaly.

Download this file

message ProcessAnomaly {

    /**
     * PID of the program.
     */
    required uint32 pid = 1000;

    /**
     * Name of the program (argv[0]).
     */
    optional bytes name = 1001;

    /**
     * Name of the host the program is running on.
     */
    optional bytes host_name = 1002;

    /**
     * A use-case-dependent list of reasons for the detection of this anomaly.
     */
    repeated string reasons = 1;

}

Message ProcessCues

class rst.monitoring.ProcessCues

Monitoring-relevant cues about a system process.

Code author: Johannes Wienke <jwienke@techfak.uni-bielefeld.de>

Todo

this message requires serious abstraction once the
functionality of all cue providers is understood. Do not move it to stable!

@create_collection

pid
Type:UINT32

PID of the program.

name
Type:OCTET-VECTOR

Name of the program (argv[0]).

host_name
Type:OCTET-VECTOR

Name of the host the program is running on.

command_line
Type:ASCII-STRING

The complete command line of the program (might include the name, too).

unique_id
Type:OCTET-VECTOR

A unique id that identifies the exact version of the program that was monitored. One source for this kind of information might be the build id from the ELF format on Linux.

cues
Type:array of rst.monitoring.ProcessCues.Cues

Cues from different sources.

threads
Type:array of rst.monitoring.ProcessCues.Thread

Thread-specific performance data of requested.

children
Type:array of rst.monitoring.ProcessCues

Child processes of this process and their data. The hierarchy of processes is linearized in this field.

Download this file

syntax = "proto2";

package rst.monitoring;

option java_outer_classname = "ProcessCuesType";

/**
 * Monitoring-relevant cues about a system process.
 *
 * @author Johannes Wienke <jwienke@techfak.uni-bielefeld.de>
 * @todo "this message requires serious abstraction once the
 *       functionality of all cue providers is understood. Do not move
 *       it to stable!"
 */
// @create_collection
message ProcessCues {

    /**
     * PID of the program.
     */
    required uint32 pid = 1000;

    /**
     * Name of the program (argv[0]).
     */
    optional bytes name = 1001;

    /**
     * Name of the host the program is running on.
     */
    optional bytes host_name = 1002;

    /**
     * The complete command line of the program (might include the name, too).
     */
    optional string command_line = 1003;

    /**
     * A unique id that identifies the exact version of the program that was
     * monitored. One source for this kind of information might be the build id
     * from the ELF format on Linux.
     */
    optional bytes unique_id = 10004;

    /**
     * Cues from a single source.
     */
    message Cues {

        /**
         * Short description of the cue source.
         */
        required bytes source = 1000;

        /**
         * Amount of time that this process has been scheduled in user
         * mode, [usec], for taskstats this is ac_utime.
         */
        optional uint64 utime = 1;

        /**
         * Amount of time that this process has been scheduled in
         * kernel mode, [usec], for taskstats this is ac_stime
         */
        optional uint64 stime = 2;

        /**
         * Number of threads in this process.
         */
        optional int64 num_threads = 3;

        /**
         * Virtual memory size in bytes.
         */
        optional uint64 vsize = 4;

        /**
         * Resident Set Size: number of pages the process has in real
         * memory.
         */
        optional int64 rss = 5;

        /**
         * Wall-clock time used by this process since
         * start. [nanoseconds]
         */
        optional uint64 wall_time = 6;

        /**
         * Processing time used by this process since start.
         * [nanoseconds]
         */
        optional uint64 virtual_time = 7;

        /**
         * Elapsed time (from taskstats). [usec]
         */
        optional uint64 etime = 8;

        optional uint64 utime_scaled = 9;

        optional uint64 stime_scaled = 10;

        optional uint64 wall_time_scaled = 11;

        /**
         * Start time of the process or thread. [usec] since unix epoche.
         */
        optional uint64 start_time = 12;

        // IO stuff

        /**
         * The number of bytes which this task has caused to be read
         * from storage. This is simply the sum of bytes which this
         * process passed to read() and pread(). It includes things
         * like tty IO and it is unaffected by whether or not actual
         * physical disk IO was required
         */
        optional uint64 rchar = 30;

        /**
         * The number of bytes which this task has caused, or shall
         * cause to be written to disk.
         *
         * Similar caveats apply here as with rchar.
         */
        optional uint64 wchar = 31;

        /**
         * Attempt to count the number of bytes which this process
         * really did cause to be fetched from the storage layer. Done
         * at the submit_bio() level, so it is accurate for
         * block-backed filesystems.
         */
        optional uint64 read_bytes = 32;

        /**
         * Attempt to count the number of bytes which this process
         * caused to be sent to the storage layer. This is done at
         * page-dirtying time.
         */
        optional uint64 write_bytes = 33;

        /**
         * The number of open file descriptors including everything like
         * sockets and pipes.
         */
        optional uint32 open_fds = 50;

        /**
         * The number of open files (real files, not sockets etc) a process
         * possesses.
         */
        optional uint32 open_files = 51;

        /**
         * The number of open network connections. This includes TCP/IP and UDP
         * traffic on IPv4 and IPv6.
         */
        optional uint32 open_connections = 60;

        /**
         * Number of bytes received via network.
         */
        optional uint64 received_bytes = 70;

        /**
         * Number of bytes sent via network.
         */
        optional uint64 sent_bytes = 71;

    }

    /**
     * Cues from different sources.
     */
    repeated Cues cues = 1;

    message Thread {
        optional bytes name = 1;
        optional uint32 tid = 2;
        repeated Cues cues = 10;
    }

    /**
     * Thread-specific performance data of requested.
     */
    repeated Thread threads = 10;

    /**
     * Child processes of this process and their data. The hierarchy of
     * processes is linearized in this field.
     */
    repeated ProcessCues children = 20;

}

Message Cues

class rst.monitoring.ProcessCues.Cues

Cues from a single source.

source
Type:OCTET-VECTOR

Short description of the cue source.

utime
Type:UINT64

Amount of time that this process has been scheduled in user mode, [usec], for taskstats this is ac_utime.

stime
Type:UINT64

Amount of time that this process has been scheduled in kernel mode, [usec], for taskstats this is ac_stime

num_threads
Type:INT64

Number of threads in this process.

vsize
Type:UINT64

Virtual memory size in bytes.

rss
Type:INT64

Resident Set Size: number of pages the process has in real memory.

wall_time
Type:UINT64

Wall-clock time used by this process since start. [nanoseconds]

virtual_time
Type:UINT64

Processing time used by this process since start. [nanoseconds]

etime
Type:UINT64

Elapsed time (from taskstats). [usec]

utime_scaled
Type:UINT64

Not documented

stime_scaled
Type:UINT64

Not documented

wall_time_scaled
Type:UINT64

Not documented

start_time
Type:UINT64

Start time of the process or thread. [usec] since unix epoche.

rchar
Type:UINT64

IO stuff The number of bytes which this task has caused to be read from storage. This is simply the sum of bytes which this process passed to read() and pread(). It includes things like tty IO and it is unaffected by whether or not actual physical disk IO was required

wchar
Type:UINT64

The number of bytes which this task has caused, or shall cause to be written to disk.

Similar caveats apply here as with rchar.

read_bytes
Type:UINT64

Attempt to count the number of bytes which this process really did cause to be fetched from the storage layer. Done at the submit_bio() level, so it is accurate for block-backed filesystems.

write_bytes
Type:UINT64

Attempt to count the number of bytes which this process caused to be sent to the storage layer. This is done at page-dirtying time.

open_fds
Type:UINT32

The number of open file descriptors including everything like sockets and pipes.

open_files
Type:UINT32

The number of open files (real files, not sockets etc) a process possesses.

open_connections
Type:UINT32

The number of open network connections. This includes TCP/IP and UDP traffic on IPv4 and IPv6.

received_bytes
Type:UINT64

Number of bytes received via network.

sent_bytes
Type:UINT64

Number of bytes sent via network.

Download this file

    message Cues {

        /**
         * Short description of the cue source.
         */
        required bytes source = 1000;

        /**
         * Amount of time that this process has been scheduled in user
         * mode, [usec], for taskstats this is ac_utime.
         */
        optional uint64 utime = 1;

        /**
         * Amount of time that this process has been scheduled in
         * kernel mode, [usec], for taskstats this is ac_stime
         */
        optional uint64 stime = 2;

        /**
         * Number of threads in this process.
         */
        optional int64 num_threads = 3;

        /**
         * Virtual memory size in bytes.
         */
        optional uint64 vsize = 4;

        /**
         * Resident Set Size: number of pages the process has in real
         * memory.
         */
        optional int64 rss = 5;

        /**
         * Wall-clock time used by this process since
         * start. [nanoseconds]
         */
        optional uint64 wall_time = 6;

        /**
         * Processing time used by this process since start.
         * [nanoseconds]
         */
        optional uint64 virtual_time = 7;

        /**
         * Elapsed time (from taskstats). [usec]
         */
        optional uint64 etime = 8;

        optional uint64 utime_scaled = 9;

        optional uint64 stime_scaled = 10;

        optional uint64 wall_time_scaled = 11;

        /**
         * Start time of the process or thread. [usec] since unix epoche.
         */
        optional uint64 start_time = 12;

        // IO stuff

        /**
         * The number of bytes which this task has caused to be read
         * from storage. This is simply the sum of bytes which this
         * process passed to read() and pread(). It includes things
         * like tty IO and it is unaffected by whether or not actual
         * physical disk IO was required
         */
        optional uint64 rchar = 30;

        /**
         * The number of bytes which this task has caused, or shall
         * cause to be written to disk.
         *
         * Similar caveats apply here as with rchar.
         */
        optional uint64 wchar = 31;

        /**
         * Attempt to count the number of bytes which this process
         * really did cause to be fetched from the storage layer. Done
         * at the submit_bio() level, so it is accurate for
         * block-backed filesystems.
         */
        optional uint64 read_bytes = 32;

        /**
         * Attempt to count the number of bytes which this process
         * caused to be sent to the storage layer. This is done at
         * page-dirtying time.
         */
        optional uint64 write_bytes = 33;

        /**
         * The number of open file descriptors including everything like
         * sockets and pipes.
         */
        optional uint32 open_fds = 50;

        /**
         * The number of open files (real files, not sockets etc) a process
         * possesses.
         */
        optional uint32 open_files = 51;

        /**
         * The number of open network connections. This includes TCP/IP and UDP
         * traffic on IPv4 and IPv6.
         */
        optional uint32 open_connections = 60;

        /**
         * Number of bytes received via network.
         */
        optional uint64 received_bytes = 70;

        /**
         * Number of bytes sent via network.
         */
        optional uint64 sent_bytes = 71;

    }

Message Thread

class rst.monitoring.ProcessCues.Thread

Not documented

name
Type:OCTET-VECTOR

Not documented

tid
Type:UINT32

Not documented

cues
Type:array of rst.monitoring.ProcessCues.Cues

Not documented

Download this file

    message Thread {
        optional bytes name = 1;
        optional uint32 tid = 2;
        repeated Cues cues = 10;
    }