OmniFaces Showcase

The FacesRequestLogger is a PhaseListener which logs the Faces request detail as Level.INFO. The log format is as below:

method{url, user, action, params, messages, timer}

Where:

• method: the HTTP request method, usually GET or POST.
• url: the request URI with query string.
• user: the user detail, composed of:
  • ip: the user IP, as obtained by Faces.getRemoteAddr().
  • login: the user login, as obtained by Faces.getRemoteUser().
  • session: the session ID, as obtained by Faces.getSessionId().
  • viewState: the server side Faces view state identifier, if any.
• action: the action detail, composed of:
  • source: the action source, as obtained by Components.getCurrentActionSource().
  • event: the action event name, if any.
  • methods: the action methods, as obtained by Components.getActionExpressionsAndListeners(UIComponent)
  • validationFailed: whether Faces validation has failed.
• params: the HTTP request parameters whereby any parameters whose name matches jakarta.faces.* are skipped, and whose name ends with password or token are masked with value ********.
• messages: all Faces messages added so far.
• timer: the duration of each phase measured in milliseconds, or -1 if the phase has been skipped, composed of:
  • 0: total time.
  • 1: duration of PhaseId.RESTORE_VIEW.
  • 2: duration of PhaseId.APPLY_REQUEST_VALUES.
  • 3: duration of PhaseId.PROCESS_VALIDATIONS.
  • 4: duration of PhaseId.UPDATE_MODEL_VALUES.
  • 5: duration of PhaseId.INVOKE_APPLICATION.
  • 6: duration of PhaseId.RENDER_RESPONSE.

Installation

Register it as <phase-listener> in faces-config.xml.

<lifecycle>
    <phase-listener>org.omnifaces.eventlistener.FacesRequestLogger</phase-listener>
</lifecycle>