Open topic with navigation

# 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. See also, Catalog of Application Metrics.
client_label | string | When connecting to the FTL 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 reporting the metrics. 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 FTL 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 FTL 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 username 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 FTL 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 FTL server. For an FTL server, this IP address denotes the primary interface of the host computer.
server_uptime | long | Time (in seconds) that the FTL 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 FTL 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.

Required 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.
id | long | This internal ID number uniquely identifies the context of the metric.
context_type | long | This number categorizes the context of the metric, for example, as an endpoint or as a transport. Values are API constants. Programs can test these values (for example, in a switch clause).
type | long | This number identifies the type of metric. For a table of possible metrics, see Catalog of Application 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. (Note: Use `value_long` or `value_string` instead, when possible.)
long_value | long | This field contains the data value of the metric, for data type long (preferred over the `value` field above).
string_value | string | This field contains the data value of the metric, for data type string.

A sample submessage can also contain a subset of these fields.

Additional Fields
Field Name | Data Type | Description
--- | --- | ---
start_time | long | An individual monitored object stores its creation timestamp.
end_time | long | When FTL destroys a monitored object, it reports this destruction timestamp in the final monitoring messages for that object.
local_transport | string | Transport objects and sub-objects only. The name of the transport definition local to the monitored application.
remote_transport | string | Transport and connection objects only. The name of the transport definition at the opposite end of the transport bus.
remote_client_id | string | Transport objects and sub-objects only. The client ID of the FTL client process at the opposite end of the transport bus.
connection_id | long | Transport connection objects only. The identifier that represents a monitored object or sub-object.
endpoint_name | string | The name of the endpoint in the application definition.
endpoint_mon_id | long | An identifier that represents the endpoint. Within a client process, a one-to-one mapping pairs endpoint names with endpoint identifiers.
subscriber_label | string | The application can supply this label when it creates a subscriber.
publisher_label | string | The application can supply this label when it creates a publisher.
matcher_string | string | The content matcher (in JSON representation) of a subscriber.
mcast_send_id | long | Within a monitored sub-object, this identifier represents its super-object, which is a multicast publisher. (It is the connection identifier of the super-object.)
mcast_recv_id | long | Within a monitored sub-object, this identifier represents its super-object, which is a multicast subscriber. (It is the connection identifier of the super-object.)
mcast_group | string | Sub-objects of multicast transports only. A multicast send or listen group specified in the transport definition.
mcast_interface | string | Sub-objects of multicast transports only. Local interface that a multicast transport uses for communication.
remote_ip | string | Transport objects and their sub-objects only. IP address of the host at the opposite end of the transport bus
remote_port | string | Transport objects and their sub-objects only. Port number at the opposite of the transport bus.
local_ip | string | Transport objects and their sub-objects only. IP address of the host of the monitored application.
local_port | string | Transport objects and their sub-objects only. Port number at the local end of the transport bus.

## 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 FTL server.
2 | Disconnected A client process has disconnected from the FTL server.
3 | Status Change The status of a client process has changed. The client_status field indicates the new status.

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO FTL® - Enterprise Edition

Copyright © 2009-2024. Cloud Software Group, Inc. All Rights Reserved.