Skip to content

MonitoringReportSocket

Tom Barbette edited this page Oct 3, 2018 · 2 revisions

MonitoringReportSocket Element Documentation

NAME

MonitoringReportSocket — Click element; a socket transport (user-level)

SYNOPSIS

MonitoringReportSocket("TCP", IP, PORTNUMBER [, KEYWORDS])
MonitoringReportSocket("UDP", IP, PORTNUMBER [, KEYWORDS])

Ports: none
Drivers: userlevel

DESCRIPTION

Transports timestamped values of elements' handlers via UDP or TCP sockets. This element is meant for monitoring purposes, thus it is useful for handlers that report numbers (e.g., latency or throughput counters etc.). Acts as a client socket. The actual structure of each message is <timestamp, handler value, handler name>. A timestamp is a 64bit integer (typically 8 bytes). A handler's value is a 64bit integer (typically 8 bytes). We reserve a static number of characters (25) for the handler's name. If this name is longer, then only 25 characters will be reported.

Keyword arguments are:

  • FREQUENCY — Unsigned Integer. The frequency in seconds to schedule this element, thus send data to the remote server.
  • CORE_NB — Unsigned Integer. CPU core ID to schedule this element.
  • SNDBUF — Unsigned integer. Sets the maximum size in bytes of the underlying socket send buffer. The default value is set by the wmem_default sysctl and the maximum allowed value is set by the wmem_max sysctl.
  • NODELAY — Boolean. Applies to TCP sockets only. If set, disable the Nagle algorithm. This means that segments are always sent as soon as possible, even if there is only a small amount of data. When not set, data is buffered until there is a sufficient amount to send out, thereby avoiding the frequent sending of small packets, which results in poor utilization of the network. Default is true.
  • VERBOSE — Boolean. When true, MonitoringReportSocket will print additional messages.

EXAMPLES

  // A TCP client socket
  MonitoringReportSocket(TCP, 1.2.3.4, 80);
 
  // A UDP client socket
  MonitoringReportSocket(UDP, 1.2.3.4, 7000);
 
  // A UDP client socket. Data is sent every 5 seconds
  MonitoringReportSocket(UDP, 1.2.3.4, 7000, FREQUENCY 5);

SEE ALSO

ControlSocket, Socket

Generated by click-elem2man from ../elements/userlevel/monitoringreportsocket.hh:14 on 2018/10/03.

Clone this wiki locally