myarmtcpd

myarmtcpd -- network based ARM data collection server

This myarmtcpd program waits for incoming connections from instrumented applications and receives any ARM data generated by the instrumentation.

Command line options

Usage:

myarmtcpd [options]

Options

In addition to the options listed below, the myarmtcpd command supports standard options described in appendix "Standard options" and Windows service options described in section "Agent servers as a Windows service".

-p port, --port port

specifies the port number to wait for incoming connections. Overwriting any configuration.

Configuration

The myarmtcpd program can be configured using the following properties in the configuration file.

tcpd.sink.name

specifies the data sink the received ARM data is written to. (See appendix "Configuring data sink component" for more details)

tcpd.host

defines the host/interface where the daemon listens for incoming data connections. Default host is localhost.

tcpd.port

defines the port number where incoming connections are accepted. Default port is 5557.

tcpd.max_clients

defines the maximal number of TCP clients. Note: This number should always be less than the number of allowed open files of the process. Otherwise the stability of the myarmtcpd can not be guaranteed! Default is 100.

tcpd.pidfile

defines the file where the myarmtcpd program writes its process id to. Default is /tmp/myarmtcpd.pid.

tcpd.user, tcpd.group

user and group identification for the running myarmtcpd. (See configuration section for more details)

tcpd.log.*

defines the logging message options and destination for the myarmtcpd program. (See appendix "Configuring Log facility" for more details)

tcpd.cmd.enable

boolean which indicates if the command channel is enabled (true) or disabled (false). Default is true.

tcpd.cmd.host

host/interface myarmtcpd is listening for incoming command connections. Default is localhost.

tcpd.cmd.port

myarmtcpd command server port. Default is 5567.

tcpd.client.thread.number

(Obsolete since "1.4.x.2")

tcpd.sink.thread.queue.size

(Obsolete since "1.4.x.2")

tcpd.sink.thread.queue.info_level

(Obsolete since "1.4.x.2")

tcpd.sink.thread.queue.warn_level

(Obsolete since "1.4.x.2")

Configuration example

# myarmtcpd daemon process user name
tcpd.user = myarm
# myarmtcpd daemon process group name
tcpd.group = myarm
# myarmtcpd daemon configuration section
tcpd.pidfile = /opt/myarm/var/tcpd.pid
# set up host myarmtcpd is listening for incoming data connections
tcpd.host  = localhost
# set up port myarmtcpd is listening for incoming data connections
tcpd.port = 5557
# maximal number of allowed data clients (connections) 
tcpd.max_clients = 100
# enable myarmtcpd command channel
tcpd.cmd.enable = true
# set up host myarmtcpd is listening for incoming command connections
tcpd.cmd.host  = localhost
# setup tcpd command server port
tcpd.cmd.port = 5567

Server commands

The myarmtcpd program currently supports the standard server commands as described in section server command tool and the following commands:

status

queries current status information from the myarmtcpd process. It supports following options:

clients

shows detailed information about TCP client threads.

sinks

shows detailed information about data sink threads.

all

shows all available information.

long

output more detailed infomation about each sink thread.

See Also