TIBCO FTL®

Macros
logstream.h File Reference

This file defines constants related to LogStream data messages, their field names, and their field values. More...

## Macros
#define | TIB_LOGGING_ENDPOINT_NAME "_loggingEndpoint"
| Name of the special endpoint that carries FTL logging messages; string. More...
LogMsg Message Fields
Fields in LogMsg messages. See also TIB_LOGSTREAM_FIELD_LOGS
#define | TIB_LOGMSG_FIELD_COMPONENT "component"
#define | TIB_LOGMSG_FIELD_CONTEXT "context"
#define | TIB_LOGMSG_FIELD_EXCEPTION "exception"
#define | TIB_LOGMSG_FIELD_IS_ADVISORY "is_advisory"
#define | TIB_LOGMSG_FIELD_LOG_LEVEL "level"
#define | TIB_LOGMSG_FIELD_STATEMENT "statement"
#define | TIB_LOGMSG_FIELD_TIMESTAMP "timestamp"
LogStream Message Fields
Fields in LogStream messages.
#define | TIB_LOGSTREAM_FIELD_APP_INSTANCE "app_instance"
#define | TIB_LOGSTREAM_FIELD_APPLICATION "application"
#define | TIB_LOGSTREAM_FIELD_CLIENT_ID "client_id"
#define | TIB_LOGSTREAM_FIELD_CLIENT_LABEL "client_label"
#define | TIB_LOGSTREAM_FIELD_CLIENT_STATUS "client_status"
#define | TIB_LOGSTREAM_FIELD_EFFECTIVE_USER "effective_user"
#define | TIB_LOGSTREAM_FIELD_FTL_USER "ftl_user"
#define | TIB_LOGSTREAM_FIELD_HOST "host"
#define | TIB_LOGSTREAM_FIELD_IP "ip"
#define | TIB_LOGSTREAM_FIELD_LOGS "logs"
#define | TIB_LOGSTREAM_FIELD_PID "pid"
#define | TIB_LOGSTREAM_FIELD_REALM_SERVER_LABEL "realm_server_label"
#define | TIB_LOGSTREAM_FIELD_REALM_UUID "realm_uuid"
#define | TIB_LOGSTREAM_FIELD_RECORD_TYPE_LABEL "record_type_label"
#define | TIB_LOGSTREAM_FIELD_REPORTING_SERVER_ID "reporting_server_id"
#define | TIB_LOGSTREAM_FIELD_SERVER_ID "server_id"
#define | TIB_LOGSTREAM_FIELD_SERVER_UPTIME "server_uptime"
#define | TIB_LOGSTREAM_FIELD_TIMESTAMP "timestamp"
#define | TIB_LOGSTREAM_FIELD_VERSION "version"

## Detailed Description

This file defines constants related to LogStream data messages, their field names, and their field values.

LogStream data messages carry logging and advisory data about FTL programs. Programs can receive the stream of logging data messages by subscribing to the logging endpoint.

See also
  For more information, see the book TIBCO FTL Centralized Logging .

## Macro Definition Documentation

## ◆ TIB_LOGGING_ENDPOINT_NAME

#define TIB_LOGGING_ENDPOINT_NAME "_loggingEndpoint"

Name of the special endpoint that carries FTL logging messages; string.

To receive FTL logging messages, create a subscriber on this endpoint.

Subscribers on this endpoint receive the stream of LogStream data messages from the FTL server.

It is illegal to create a publisher on this endpoint.

## ◆ TIB_LOGMSG_FIELD_COMPONENT

#define TIB_LOGMSG_FIELD_COMPONENT "component"

Component which generated this log message (string value).

## ◆ TIB_LOGMSG_FIELD_CONTEXT

#define TIB_LOGMSG_FIELD_CONTEXT "context"

Context for this log message (string value).

## ◆ TIB_LOGMSG_FIELD_EXCEPTION

#define TIB_LOGMSG_FIELD_EXCEPTION "exception"

Exception associated with this log message (string value).

## ◆ TIB_LOGMSG_FIELD_IS_ADVISORY

#define TIB_LOGMSG_FIELD_IS_ADVISORY "is_advisory"

Indicates whether this log message is an advisory (boolean value).

## ◆ TIB_LOGMSG_FIELD_LOG_LEVEL

#define TIB_LOGMSG_FIELD_LOG_LEVEL "level"

Log level (string value).

## ◆ TIB_LOGMSG_FIELD_STATEMENT

#define TIB_LOGMSG_FIELD_STATEMENT "statement"

Log statement (string value).

## ◆ TIB_LOGMSG_FIELD_TIMESTAMP

#define TIB_LOGMSG_FIELD_TIMESTAMP "timestamp"

Time at which the log was generated (long value), expressed in milliseconds since the epoch.

## ◆ TIB_LOGSTREAM_FIELD_APP_INSTANCE

#define TIB_LOGSTREAM_FIELD_APP_INSTANCE "app_instance"

Application instance (string value).

## ◆ TIB_LOGSTREAM_FIELD_APPLICATION

#define TIB_LOGSTREAM_FIELD_APPLICATION "application"

Application name (string value).

## ◆ TIB_LOGSTREAM_FIELD_CLIENT_ID

#define TIB_LOGSTREAM_FIELD_CLIENT_ID "client_id"

Client ID (string value).

## ◆ TIB_LOGSTREAM_FIELD_CLIENT_LABEL

#define TIB_LOGSTREAM_FIELD_CLIENT_LABEL "client_label"

Client label (string value).

## ◆ TIB_LOGSTREAM_FIELD_CLIENT_STATUS

#define TIB_LOGSTREAM_FIELD_CLIENT_STATUS "client_status"

Client status (long value).

## ◆ TIB_LOGSTREAM_FIELD_EFFECTIVE_USER

#define TIB_LOGSTREAM_FIELD_EFFECTIVE_USER "effective_user"

Host effective user name (string value).

## ◆ TIB_LOGSTREAM_FIELD_FTL_USER

#define TIB_LOGSTREAM_FIELD_FTL_USER "ftl_user"

FTL user name (string value).

## ◆ TIB_LOGSTREAM_FIELD_HOST

#define TIB_LOGSTREAM_FIELD_HOST "host"

Hostname on which client is running (string value).

## ◆ TIB_LOGSTREAM_FIELD_IP

#define TIB_LOGSTREAM_FIELD_IP "ip"

IP address of client (string value).

## ◆ TIB_LOGSTREAM_FIELD_LOGS

#define TIB_LOGSTREAM_FIELD_LOGS "logs"

Logs message array (array of messages). Each message contains a single log entry.

## ◆ TIB_LOGSTREAM_FIELD_PID

#define TIB_LOGSTREAM_FIELD_PID "pid"

Process ID (long value).

## ◆ TIB_LOGSTREAM_FIELD_REALM_SERVER_LABEL

#define TIB_LOGSTREAM_FIELD_REALM_SERVER_LABEL "realm_server_label"

Realm service label (string value).

## ◆ TIB_LOGSTREAM_FIELD_REALM_UUID

#define TIB_LOGSTREAM_FIELD_REALM_UUID "realm_uuid"

Realm UUID (string value).

## ◆ TIB_LOGSTREAM_FIELD_RECORD_TYPE_LABEL

#define TIB_LOGSTREAM_FIELD_RECORD_TYPE_LABEL "record_type_label"

Record type label (string value).

## ◆ TIB_LOGSTREAM_FIELD_REPORTING_SERVER_ID

#define TIB_LOGSTREAM_FIELD_REPORTING_SERVER_ID "reporting_server_id"

ID of server to which the client belongs (string value).

## ◆ TIB_LOGSTREAM_FIELD_SERVER_ID

#define TIB_LOGSTREAM_FIELD_SERVER_ID "server_id"

Server ID (string value).

## ◆ TIB_LOGSTREAM_FIELD_SERVER_UPTIME

#define TIB_LOGSTREAM_FIELD_SERVER_UPTIME "server_uptime"

Server uptime in seconds (long value).

## ◆ TIB_LOGSTREAM_FIELD_TIMESTAMP

#define TIB_LOGSTREAM_FIELD_TIMESTAMP "timestamp"

Time at which the log was generated (long value), expressed in milliseconds since the epoch.

## ◆ TIB_LOGSTREAM_FIELD_VERSION

#define TIB_LOGSTREAM_FIELD_VERSION "version"

FTL version client is running (string value).