Class TracingUtils


  • public final class TracingUtils
    extends java.lang.Object
    Utilities for tracing support.
    Since:
    2.3
    • Field Detail

      • SUMMARY_HEADERS

        private static final java.util.List<java.lang.String> SUMMARY_HEADERS
      • DEFAULT_CONFIGURATION_TYPE

        private static final TracingConfig DEFAULT_CONFIGURATION_TYPE
    • Constructor Detail

      • TracingUtils

        private TracingUtils()
    • Method Detail

      • initTracingSupport

        public static void initTracingSupport​(TracingConfig type,
                                              TracingLogger.Level appThreshold,
                                              ContainerRequest containerRequest)
        According to configuration/request header it initialize TracingLogger and put it to the request properties.
        Parameters:
        type - application-wide tracing configuration type.
        appThreshold - application-wide tracing level threshold.
        containerRequest - request instance to get runtime properties to store TracingLogger instance to if tracing support is enabled for the request.
      • logStart

        public static void logStart​(ContainerRequest request)
        Log tracing messages START events.
        Parameters:
        request - container request instance to get runtime properties to check if tracing support is enabled for the request.
      • isTracingSupportEnabled

        private static boolean isTracingSupportEnabled​(TracingConfig type,
                                                       ContainerRequest containerRequest)
        Test if application and request settings enabled tracing support.
        Parameters:
        type - application tracing configuration type.
        containerRequest - request instance to check request headers.
        Returns:
        true if tracing support is switched on for the request.
      • getTracingConfig

        static TracingConfig getTracingConfig​(javax.ws.rs.core.Configuration configuration)
        Return configuration type of tracing support according to application configuration. By default tracing support is switched OFF.
        Parameters:
        configuration - application configuration.
        Returns:
        configuration type, transformed text value to enum read from configuration or default.
      • getTracingLoggerNameSuffix

        private static java.lang.String getTracingLoggerNameSuffix​(ContainerRequest request)
        Get request header specified JDK logger name suffix.
        Parameters:
        request - container request instance to get request header TracingLogger.HEADER_LOGGER value.
        Returns:
        Logger name suffix or null if not set.
      • getTracingThreshold

        static TracingLogger.Level getTracingThreshold​(javax.ws.rs.core.Configuration configuration)
        Get application-wide tracing level threshold.
        Parameters:
        configuration - application configuration.
        Returns:
        tracing level threshold.
      • toStringOrNA

        private static java.lang.String toStringOrNA​(java.lang.Object object)