Package wt.log4j

Interface Log4jConstants

public interface Log4jConstants
This class declares a number of constants for use with log4j logging.

Supported API: true

Extendable: true

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    MDC_CLIENT_ADDR_KEY
    Name of log4j MDC (see org.apache.log4j.MDC) entry containing the client IP address.
    static final String
    MDC_CONTEXT_LABEL
    Name of log4j MDC (see org.apache.log4j.MDC) entry containing a label or identification of the current execution context, e.g.
    static final String
    MDC_CONTEXT_TYPE
    Name of log4j MDC (see org.apache.log4j.MDC) entry containing the type of execution context that MDC_CONTEXT_LABEL applies to, e.g.
    static final String
    MDC_EFFECTIVE_PRINCIPAL_KEY
    Name of log4j MDC (see org.apache.log4j.MDC) entry containing the current effective principal's authentication name.
    static final String
    MDC_IE_CONTEXT_ID
    Name of log4j MDC (see org.apache.log4j.MDC) entry containing the IeContext id.
    static final String
    MDC_METHOD_CONTEXT_DETAIL
    Name of log4j MDC (see org.apache.log4j.MDC) entry containing the method context detail.
    static final String
    MDC_METHOD_CONTEXT_ID
    Name of log4j MDC (see org.apache.log4j.MDC) entry containing the method context id.
    static final String
    MDC_PARENT_METHOD_CONTEXT_ID
    Name of log4j MDC (see org.apache.log4j.MDC) entry containing the parent method context id.
    static final String
    MDC_REMOTE_CALL_ID_KEY
    Name of log4j MDC (see org.apache.log4j.MDC) entry containing (callee generated) id of remote call that is currently being processed, e.g.
    static final String
    MDC_SAMPLE_START_TIME
    Name of log4j MDC (see org.apache.log4j.MDC) entry containing time at which an ongoing data sampling activity began.
    static final String
    MDC_SERVLET_REQUEST_ID_KEY
    Name of log4j MDC (see org.apache.log4j.MDC) entry containing an id like remoteCallId but specifically for servlet requests.
    static final String
    MDC_SESSION_PRINCIPAL_KEY
    Name of log4j MDC (see org.apache.log4j.MDC) entry containing the current session principal's authentication name.
    static final String
    MDC_USER_KEY
    Name of log4j MDC (see org.apache.log4j.MDC) entry containing the user authentication name.
    static final String
    MDC_WEB_APP_KEY
    Name of log4j MDC (see org.apache.log4j.MDC) entry containing the context path (e.g.
    static final String
    SYS_PROP_CANONICAL_HOST_KEY
    Name of system property in which the canonical host name is stored by LogR.initProperties().
    static final String
    SYS_PROP_JVM_HOST_KEY
    Name of system property in which the JVM host name (as per Java 5's RuntimeMXBean) is stored by LogR.initProperties().
    static final String
    SYS_PROP_JVM_ID_KEY
    Name of system property in which JVM id (process id on most platforms) is stored by LogR.initProperties().
    static final String
    SYS_PROP_JVM_START_TIME_KEY
    Name of system property in which the JVM start time (as a UTC long as per Java 5's RuntimeMXBean) is stored by LogR.initProperties().
    static final String
    SYS_PROP_JVM_START_TIME_SHORT_FORMAT_KEY
    Name of system property in which the JVM start time (formatted as yyMMddHHmm) is stored by LogR.initProperties().

  • Field Details

    • SYS_PROP_JVM_ID_KEY

      static final String SYS_PROP_JVM_ID_KEY
      Name of system property in which JVM id (process id on most platforms) is stored by LogR.initProperties().

      Supported API: true
      See Also:

    • SYS_PROP_JVM_HOST_KEY

      static final String SYS_PROP_JVM_HOST_KEY
      Name of system property in which the JVM host name (as per Java 5's RuntimeMXBean) is stored by LogR.initProperties().

      Supported API: true
      See Also:

    • SYS_PROP_JVM_START_TIME_KEY

      static final String SYS_PROP_JVM_START_TIME_KEY
      Name of system property in which the JVM start time (as a UTC long as per Java 5's RuntimeMXBean) is stored by LogR.initProperties().

      Supported API: true
      See Also:

    • SYS_PROP_JVM_START_TIME_SHORT_FORMAT_KEY

      static final String SYS_PROP_JVM_START_TIME_SHORT_FORMAT_KEY
      Name of system property in which the JVM start time (formatted as yyMMddHHmm) is stored by LogR.initProperties().

      Supported API: true
      See Also:

    • SYS_PROP_CANONICAL_HOST_KEY

      static final String SYS_PROP_CANONICAL_HOST_KEY
      Name of system property in which the canonical host name is stored by LogR.initProperties().

      Supported API: true
      See Also:

    • MDC_CONTEXT_TYPE

      static final String MDC_CONTEXT_TYPE
      Name of log4j MDC (see org.apache.log4j.MDC) entry containing the type of execution context that MDC_CONTEXT_LABEL applies to, e.g. "ServletRequest".

      The combination of MDC_CONTEXT_TYPE and MDC_CONTEXT_LABEL are intentionally broad to allow each execution context to provide appropriate labeling data in MDC_CONTEXT_LABEL namespaced by MDC_CONTEXT_TYPE.

      Supported API: true

      See Also:

    • MDC_CONTEXT_LABEL

      static final String MDC_CONTEXT_LABEL
      Name of log4j MDC (see org.apache.log4j.MDC) entry containing a label or identification of the current execution context, e.g. the HTTP request URI.

      The combination of MDC_CONTEXT_TYPE and MDC_CONTEXT_LABEL are intentionally broad to allow each execution context to provide appropriate labeling data in MDC_CONTEXT_LABEL namespaced by MDC_CONTEXT_TYPE.

      Supported API: true

      See Also:

    • MDC_USER_KEY

      static final String MDC_USER_KEY
      Name of log4j MDC (see org.apache.log4j.MDC) entry containing the user authentication name.

      Supported API: true
      See Also:

    • MDC_CLIENT_ADDR_KEY

      static final String MDC_CLIENT_ADDR_KEY
      Name of log4j MDC (see org.apache.log4j.MDC) entry containing the client IP address.

      Supported API: true
      See Also:

    • MDC_REMOTE_CALL_ID_KEY

      static final String MDC_REMOTE_CALL_ID_KEY
      Name of log4j MDC (see org.apache.log4j.MDC) entry containing (callee generated) id of remote call that is currently being processed, e.g. the method context id.

      Supported API: true
      See Also:

    • MDC_SERVLET_REQUEST_ID_KEY

      static final String MDC_SERVLET_REQUEST_ID_KEY
      Name of log4j MDC (see org.apache.log4j.MDC) entry containing an id like remoteCallId but specifically for servlet requests. This is important within the method server as the servlet request id there is quite different than the RMI or I*E IPC request id.

      Supported API: true
      See Also:

    • MDC_WEB_APP_KEY

      static final String MDC_WEB_APP_KEY
      Name of log4j MDC (see org.apache.log4j.MDC) entry containing the context path (e.g. /Windchill) of the web application. This is useful for collecting logs from multiple web applications into a single output location while allowing each application's contribution to be distinguished.

      Supported API: true
      See Also:

    • MDC_SESSION_PRINCIPAL_KEY

      static final String MDC_SESSION_PRINCIPAL_KEY
      Name of log4j MDC (see org.apache.log4j.MDC) entry containing the current session principal's authentication name.

      Supported API: true
      See Also:

    • MDC_EFFECTIVE_PRINCIPAL_KEY

      static final String MDC_EFFECTIVE_PRINCIPAL_KEY
      Name of log4j MDC (see org.apache.log4j.MDC) entry containing the current effective principal's authentication name.

      Supported API: true
      See Also:

    • MDC_IE_CONTEXT_ID

      static final String MDC_IE_CONTEXT_ID
      Name of log4j MDC (see org.apache.log4j.MDC) entry containing the IeContext id.

      Supported API: true
      See Also:

    • MDC_METHOD_CONTEXT_ID

      static final String MDC_METHOD_CONTEXT_ID
      Name of log4j MDC (see org.apache.log4j.MDC) entry containing the method context id.

      Supported API: true
      See Also:

    • MDC_PARENT_METHOD_CONTEXT_ID

      static final String MDC_PARENT_METHOD_CONTEXT_ID
      Name of log4j MDC (see org.apache.log4j.MDC) entry containing the parent method context id.

      Supported API: true
      See Also:

    • MDC_METHOD_CONTEXT_DETAIL

      static final String MDC_METHOD_CONTEXT_DETAIL
      Name of log4j MDC (see org.apache.log4j.MDC) entry containing the method context detail.

      Supported API: true
      See Also:

    • MDC_SAMPLE_START_TIME

      static final String MDC_SAMPLE_START_TIME
      Name of log4j MDC (see org.apache.log4j.MDC) entry containing time at which an ongoing data sampling activity began.

      Supported API: true
      See Also: