Getting Hub Information

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

CodeSonar^® 9.2p0

CONFIDENTIAL

CodeSecure Inc

Getting Hub Information

General Hub Information

General information about the hub can be accessed through the CodeSonar web GUI, through the CodeSonar configuration tool, and with a command line.

[-force]

When this is specified, the command will return a minimal set of hub information if the authorizing user does not have G_HUB_INFO permission.
Otherwise, the command will return an error message in this case.

[[protocol://]host:port | hubdir]

You can identify the hub of interest by hub location (host:port or protocol://host:port) or hub directory (hubdir).
If you specify neither host:port nor hubdir, CodeSonar will determine a hub location using the steps described in Hub Location: How CodeSonar Determines Hub Location.

[-auth authtype],
[-hubuser username],
[-hubpwfile pwfile],
[-hubbearerfile bearerfile],
[-hubcert certfile],
[-hubkey privatekeyfile]

Specify how CodeSonar should attempt to authenticate this command. For details, see Hub Authentication: Authenticated codesonar Subcommands.

Hub Processes

For information about the processes running on a hub, use one of the following command lines.

$CSONAR/codesonar/bin/cshub_inspect directory

Writes (to stdout) an overview of the current slaves for the hub whose hub directory is directory.

TERMINATE	The master is in the process of exiting (probably waiting for slaves to exit).
STARVING	There are no idle slaves: any idle connection that is tying up a slave may be disconnected.
SIGNALED	A slave has made a request of the master, but the master has not satisfied the request yet.
STILL INITIALIZING	The hub hasn't fully started yet. This condition will hold until MIN_IDLE slaves have started for the first time.

TERMINATE

The master is in the process of exiting (probably waiting for slaves to exit).

STARVING

There are no idle slaves: any idle connection that is tying up a slave may be disconnected.

SIGNALED

A slave has made a request of the master, but the master has not satisfied the request yet.

STILL INITIALIZING

The hub hasn't fully started yet. This condition will hold until MIN_IDLE slaves have started for the first time.

STARTING	The number of slave processes that are currently starting. This value should generally be either 0 or 1.
IDLE	The number of slave processes that are not currently connected or connecting to an HTTP client.
BUSY	The number of slave processes that are currently connected or connecting to an HTTP client.
HEALTH	An overall indication of how frequently slaves are crashing. Positive HEALTH is good, zero is neutral, and negative is undesirable. If HEALTH drops to -MIN_IDLE, the master will give up and exit.
MIN_IDLE	If IDLE drops below than this value and fewer than MAX slaves are running, the hub will start another slave (subject to throttling).
MAX_IDLE	If IDLE is above this value, the hub will have one idle slave exit, and repeat as necessary until IDLE is no longer too high.
MAX	Maximum number of slaves that can be running at one time.

STARTING

The number of slave processes that are currently starting. This value should generally be either 0 or 1.

IDLE

The number of slave processes that are not currently connected or connecting to an HTTP client.

BUSY

The number of slave processes that are currently connected or connecting to an HTTP client.

HEALTH

An overall indication of how frequently slaves are crashing. Positive HEALTH is good, zero is neutral, and negative is undesirable. If HEALTH drops to -MIN_IDLE, the master will give up and exit.

MIN_IDLE

If IDLE drops below than this value and fewer than MAX slaves are running, the hub will start another slave (subject to throttling).

MAX_IDLE

If IDLE is above this value, the hub will have one idle slave exit, and repeat as necessary until IDLE is no longer too high.

MAX

Maximum number of slaves that can be running at one time.

PID	The process identifier.
LOG	The amount of unflushed log data from the process.
STATE	One of STARTING, IDLE, BUSY.
TIME	The time at which the process STATUS was last updated.
STATUS	Describes what the process is currently doing. The most-frequently seen STATUS values are: <host>:<port> <http_req> : the process is handling the specified HTTP request, which came from the specified address. LISTEN : the process is idle, and is listening for an incoming request. <host>:<port> IDLE : the process is tied up by an idle connection to the specified address.

PID

The process identifier.

LOG

The amount of unflushed log data from the process.

STATE

One of STARTING, IDLE, BUSY.

TIME

The time at which the process STATUS was last updated.

STATUS

Describes what the process is currently doing. The most-frequently seen STATUS values are:

<host>:<port> <http_req> : the process is handling the specified HTTP request, which came from the specified address.
LISTEN : the process is idle, and is listening for an incoming request.
<host>:<port> IDLE : the process is tied up by an idle connection to the specified address.

$CSONAR/codesonar/bin/cshub_inspect directory timespan outfile

Every timespan milliseconds, rewrites outfile to contain an overview of the current slaves for the hub whose hub directory is directory. The periodic rewriting continues until the command is terminated. The overview structure is as described above for cshub_inspect directory.