Open topic with navigation

TIBCO GridServer® 7.1.0

# Configuration

To configure REST output for logging or server events, go to Admin > System Admin > Manager Configuration > Logging > Log to REST or Server Events to REST. This feature is only supported for Managers, and not Drivers or Engines.

## Log Message to REST Configuration

The following properties related to sending log messages to a REST endpoint:

Log Message to REST Configuration

Name | Description | Default
Enabled | If sending log messages to REST is enabled. | false
Server URL | The complete URL path of the location that receives the log messages. The following substitution variables are supported:
| • | `${hostname}` the short (not fully qualified) hostname
| • | `${managerId}` the Manager ID as found on the Admin section of the Manager Configuration page
| • | `${dateFormat:``format``}`, where `format` specifies a date according to the Java `SimpleDateFormat` class.
For example, `http://logdb.mycompany.com/datasynapse-${hostname}-${managerId}-${dateFormat:yyyy-MM-dd}/log` |
Username | User name, if using Basic Auth. |
Password | Password, if using Basic Auth. |
Max Log Level | The highest level of messages that is logged. This can only be used to restrict what is logged to the server from the default settings. Typically this is set to `ALL`, unless you want to send higher level messages to another logging device but restrict what is logged to this server. | `ALL`
Backlog | The number of messages that can be queued for send. | 1000
Discard when Backlogged | If true, subsequent messages are discarded when the backlog is reached. Otherwise, the caller is blocked. | `false`
Timestamp format | The format of the 'timestamp' property | `yyyy-MM-dd'T'HH:mm:ss.SSSZZ`
Time Zone | The time zone of the time stamp, currently only GMT and default time zone is supported. |
Excluded LogRecord Properties | A comma-delimited list of properties of the Java `LogRecord` class that is excluded. By default, the following are excluded: `sourceClassName`, `sourceMethodName` because they can impact performance; `millis` because a formatted timestamp is often preferred; `sequenceNumber` because it might not be useful. | `millis,sequenceNumber,sourceClassName,sourceMethodName`
HTTP Timeout | The connect and read HTTP timeouts, in milliseconds | 5000

## Server Event to REST Configuration

The following properties related to sending server events to a REST endpoint

Server Event to REST Configuration

Property | Description | Default
Enabled | If sending server events to REST is enabled. | false
Server URL | The complete URL path of the location that receives the log messages. The following substitution variables are supported:
| • | `${hostname}` the short (not fully qualified) hostname.
| • | `${managerId}` the Manager ID as found on the Admin section of the Manager Configuration page.
| • | `${dateFormat:``format``}`, where `format` specifies a date according to the Java `SimpleDateFormat` class.
For example, `http://logdb.mycompany.com/datasynapse-${hostname}-${managerId}-${dateFormat:yyyy-MM-dd}/log` |
Username | User name, if using Basic Auth. |
Password | Password, if using Basic Auth. |
Backlog | The number of messages that can be queued for send. | 1000
Discard when Backlogged | If true, subsequent messages are discarded when the backlog is hit. Otherwise, the caller blocks. | false
Timestamp format | The format of the 'timestamp' property | `yyyy-MM-dd'T'HH:mm:ss.SSSZZ`
Time Zone | The time zone of the time stamp, currently only GMT and default time zone is supported. |
Excluded Events | A comma-delimited list of integer event types that are excluded. |
Include Type | If true, the integer event type is included in the message. | true
Include Name | If true, the event name is included. For example, `TASK_SUBMITTED`. | false
HTTP Timeout | The connect and read HTTP timeouts, in milliseconds | 5000

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 GridServer®

Copyright © 2001-2022. TIBCO Software Inc. All Rights Reserved.