mgetinfo
The mgetinfo command retrieves information about a cell.
mgetinfo syntax
[-h|?] [-l<HomeLocation>] [-n <cellName> | -n @Host[/Port[#Key]]]
{-p <Var Value>} [-q] [-v] [-z] <Information>
The -n option is required if the cell is remote and defined in the mcell.dir file, or if the cell is local and named something other than Host.
The following table lists the command-specific options for mgetinfo. For a list of common command options that apply to all CLI commands, see Common options for event management CLI commands.
mgetinfo options
Option | Description |
|---|---|
Information | Specifies the Information option to use. |
The following table describes the mgetinfo Information options:
mgetinfo options
Option | Description |
|---|---|
Information | Specifies the Information option to use. |
The following table describes the mgetinfo Information options:
Information | Description |
activity|
Retrieves the activity status of the cell
0 = standby
1 = limited
2 = full activity
config|
Retrieves configuration of a cell, including the cell name, home directory, Knowledge Base directory, and the full paths of all configuration files the cell uses
connect|
Retrieves information about the current connections that are open from and to the cell; see the following table for description of that information
kbmodules|
Lists KB modules with version information from the cell's loaded KB; information is displayed in raw format. When combined with the -v switch, it is returned in a more verbose and readable format.
kbsources|
Lists KB source files with version information from the cell's loaded KB; information is displayed in raw format. When combined with the -v switch, information is returned in a more verbose and readable format.
metrics|
Reports the metrics, collected by the cell. The metrics are stored in MC_CELL_METRIC data objects.
metrics output consists of following values:
- Metric name
- Metric description
- Short term, medium term, and long term metric, each consisting of
- Period of time for which the metric is counted (in seconds)
- Total count of metric items during the period
- Average occurrence of the metric item over the time period (in items per second)
The following metrics are defined:
- ReceivedEvents-Number of received event messages
- ErrorEvents-Number of received event messages that are incorrect (for example, causing a parse error)
- DroppedEvents-Number of events that are dropped during processing through the rules
- StoredEvents-Number of events that have passed all the rules and are stored in the Event database
- RemovedEvents-Number of events that have been removed from the Event database by a database cleanup
- DeletedEvents-Number of events that have been deleted by clients, such as CLI or the console
- PropagatedEvents-Number of events that have been propagated to another destination
- ConnectedSources-Number of adapter clients that are connected to the cell
param|
Retrieves the options found in the mcell.conf file.
This information does not necessarily represent the effective values of these options. If the value is set to an out-of-range value, that value is returned, but the effective value used internally will be the range boundary.
NOTE: All parameter settings are returned in order of definition. There can be multiple settings for the same parameter. Only the last setting reported is effective.
pid|
Displays the process ID, parent process ID, and session ID of the cell process.
On Microsoft Windows, parent process ID, and session ID are not available and are displayed as 0.
profiling|
Displays the time spent to run each rule.
When used with the -v option, mgetinfo profiling displays the following information:
- The first lines indicate the current state of profiling data collection (on or off) which is controlled by the mcontrol profiling command. (For more information, see mcontrol.)
- The second line indicates the total number of seconds over which the data was collected.
- The first column of the table (from the left) indicates the total time in seconds spent in the part of the rule described in the rest of the columns of that row.
- The second column indicates the number of invocations.
- The third column indicates whether the triggering condition was either a "new event" or "event change."
- The fourth column lists the part of the rule, "selector," "rule," or "when."
- The fifth column indicates the rule phase.
- The sixth column provides the rule name.
- The seventh column provides the MRL source file name.
- The eighth column indicates the line number of the MRL source file.
When mgetinfo profiling is run without the -v option, the output is same data except for the first two lines which are summarized in one line containing state and total collection time and lines with dashes are not output.
timer|
Lists the following information for all timers set on all events:
- Timer ID
- EventID on which the timer is set
- Timer information of associated timer rule
- Expiration time
services|
Reports service metrics counting the components and relationships
version|
Displays the version number of the cell
A connect request displays the information described in the following table.
mgetinfo connection information
Connect information | Description |
All Connections |
Client identifier | The identification number of the client as reported in the cell trace messages |
Direction | IN for incoming and OUT for outgoing |
Client type | The type of client, such as unknown, cell, browser, adapter, CLI, and EIF, which are reported as literal values |
Client name | the name of the connected program (for example: Impact Explorer, mposter, cellName) |
Source address | IP address/port of source side of the connection; for inbound connections, this is the client; for outbound, it is the cell |
Destination address | IP address/port of destination side of the connection; for inbound connections, this is the cell; for outbound, it is the destination |
Incoming Connections |
User ID | The name of the user; user@host |
Clock delta | The difference between the time clocks for the sender and receiver in seconds, to be added to time stamps coming in to convert to the cell time |
Last received message sequence number | Sequence number of the last incoming message |
Last answered message sequence number | Sequence number of the last answered message |
Number of open queries on event | Number of open queries on EVENT classes |
Number of open queries on data | Number of open queries on DATA classes |
Internal low level buffer size | Size of internal low-level buffer used for returning answers to requests |
Outgoing Connections |
Last connection trial at | Time stamp of last connection setup or trial |
Last message sent sequence number | Sequence number of last outgoing message |
Messages waiting for connection | Number of messages waiting for connection opening |
Messages sent, waiting for answer | Number of messages waiting for answer |