Fields of Monitoring Data Messages

The format of monitoring data messages includes many fields that are common to all monitoring messages, and some fields that are present only in certain types of monitoring messages. The following tables describe the fields and their values.

Top Level Fields

Field Name Data Type Description
msg_type long The type of a monitoring message indicates the variable portion of its contents.

For a table of possible values, see Message Type Values.

Each monitoring message type number is defined as a constant value in the TIBCO FTL API library.

client_label string When connecting to the realm server, a client program can supply a label that denotes that particular client. Unlike a client ID, which denotes a specific client process, this label remains unchanged even when the client restarts as a new process.

You can use this label to identify clients by their role within your enterprise.

client_status string This string denotes the status of the client.

For details, see the Status field in "Client Status Reference" in TIBCO FTL Administration.

metrics message array Each message in this array contains one data sample of one metric.

For a table of possible fields of these sample messages, see Data Sample Submessage.

This field contains a value only if the msg_type is client metric or server metric.

event_type long If the msg_type is event, this value indicates the type of event.

For a table of possible values, see Event Type Values.

Each event type number is defined as a constant value in the TIBCO FTL API library.

timestamp long The sampling time or event time (in microseconds after the epoch) for the metrics in this message.
application string The application name of the client.

This field contains a value only if the msg_type is client metric.

application_instance string The application instance name of the client.

This field contains a value only if the msg_type is client metric.

client_id string The client ID of the client process.

The realm server assigns each client process a unique client ID.

This field contains a value only if the msg_type is client metric.

server_id string The UUID of the realm server.

This field contains a value only if the msg_type is server metric.

pid long The process ID of the client process, as assigned by the operating system of the client's host computer.

This field contains a value only if the msg_type is client metric.

ftl_user string The client supplied this value for the username property in its realm connect call.
effective_user string The user name that started the client process, according its host computer's operating system. The client process inherits permissions from this user.
version string The version of the TIBCO FTL client library that the client or realm server process uses.
host string The host name of the computer where the client process is running.
ip string For a client process, this IP address denotes the network interface through which the client communicates with the realm server.

For a realm server, this IP address denotes the primary interface of the host computer.

server_uptime long Time (in seconds) that the realm server process has been running.

This field contains a value only if the msg_type is server metric.

Message Type Values

These values occur in the msg_type field of monitoring messages.

Each monitoring message type number is defined as a constant value in the TIBCO FTL API library.

Value Description
1 Client Metric

The message contains client metrics in an array of data sample submessages.

2 Server Metric

The message contains realm server metrics in an array of data sample submessages.

3 Event

The message contains information about an event, such as a new client connection or a state change.

The value of event_type field denotes the event.

Data Sample Submessage

Each sample submessage contains all of these fields.

Field Name Data Type Description
context string This human-readable string identifies the context of the metric within the client application. For example, if the metric measures some aspect of a specific endpoint, transport, or queue, then the context is the endpoint name, transport name, or queue name.
type long This number identifies the type of metric.

For a table of possible metrics, see Catalog of Client Metrics.

Each type number is defined as a constant value in the TIBCO FTL API library.

value long This field contains the data value of the metric.
id long This internal ID number uniquely identifies the context of the metric.

Event Type Values

If the msg_type is event, these values can occur in the event_type field to indicate the type of event.

Value Description
1 Connected

A client process has connected to the realm server.

2 Disconnected

A client process has disconnected from the realm server.

3 Status Change

The status of a client process has changed.

The client_status field indicates the new status.