Contact Us 1-800-596-4880

SSE Logging Policy

Policy Name

SSE Logging

Summary

Logs every SSE event while streaming

Category

SSE

First Flex Gateway version available

v1.9.3

Returned Status Codes

No return codes exist for this policy.

Summary

The SSE Logging policy enables logging for SSE connections. The configured SSE logs appear in Flex Gateway logs.

This policy only provides logs for SSE events. To log non-SSE information, see Message Logging Policy.

Configuring Policy Parameters

Flex Gateway Local Mode

The SSE Logging policy isn’t supported in Local Mode.

Managed Flex Gateway and Flex Gateway Connected Mode

When you apply the policy to your API instance from the UI, the following parameters are displayed:

Element Description

Logs

List of logs executed on every SSE event.

DataWeave expression for SSE response messages

DataWeave Expression that extracts information from the SSE Event. Use [payload] for the event’s payload, [vars.data] for the event data, and #[vars.id] for the event ID.

Category

String prefix to add to each log message.

Level

Defines the level of message to log: INFO, WARN, ERROR, or DEBUG.
For more information, see Message Logging Severity Levels.

Message Logging Severity Levels

When you configure a Message Logging policy for your API instance, you can assign a severity level. Each severity level includes a specific set of information in the log report.

Log reports include the severity level you select and the following levels on the hierarchy.

For example, if you select DEBUG, the log reports include the DEBUG severity level as well as the INFO, WARN, and ERROR severity levels. However, if you select ERROR, the log reports include only error messages. The following table describes the type of information included in the logs for each severity level:

Log Severity Level Description

DEBUG

Tracing information used by application developers.

INFO

Informational messages that highlight the progress of the application.

WARN

Potentially harmful situations that indicate potential problems.

ERROR

Events that prevent normal program execution but might allow the application to continue running.