Package com.broadleafcommerce.common.error.validation.web

Class BroadleafExceptionHandlerProperties.Logging

java.lang.Object
com.broadleafcommerce.common.error.validation.web.BroadleafExceptionHandlerProperties.Logging
Enclosing class:
BroadleafExceptionHandlerProperties
public static class BroadleafExceptionHandlerProperties.Logging extends Object

  • Constructor Details

    • Logging

      public Logging()

  • Method Details

    • getTraceIdMdcKeys

      public List<String> getTraceIdMdcKeys()
      Prioritized ordered list of MDC keys checked by the logging utility to extract and propagate the active APM/observability Trace ID on the sanitized ApiError response body.

      Supported trace key mapping by industry APM tracers:

      • traceId: Standard camelCase key used by Spring Boot 3+ Micrometer Tracing, Spring Cloud Sleuth, and the OpenTelemetry Java SDK default logs exporter.
      • trace_id: Standard snake_case key used by W3C Trace Context specifications, Jaeger, Zipkin, and custom OpenTelemetry instrumentation.
      • dd.trace_id: Datadog APM default MDC injection key populated by the Datadog Java Tracer agent (dd-java-agent).
      • X-B3-TraceId: Zipkin B3 Propagation legacy format key used by older Sleuth and distributed tracing architectures.
      • trace.id: Elastic APM default dot-notation MDC key adhering to the Elastic Common Schema (ECS).
      • dt.trace_id: Dynatrace APM default OneAgent distributed log correlation key.

    • getErrorStatuses

      public List<Integer> getErrorStatuses()
      List of HTTP Status integers that should trigger ERROR level logs.

    • getWarnStatuses

      public List<Integer> getWarnStatuses()
      List of HTTP Status integers that should trigger WARN level logs.

    • isLegacyLoggingLevelEnabled

      public boolean isLegacyLoggingLevelEnabled()
      MASTER TOGGLE: Must be TRUE for any legacy system-logging severity fallbacks to trigger.

    • getLegacyLoggingLevelExceptionClasses

      public List<String> getLegacyLoggingLevelExceptionClasses()
      Targeted fully-qualified exception class names that should revert to legacy logging severities. Only evaluated if legacyLoggingLevelEnabled is true. If empty, all logging severities revert.

    • setTraceIdMdcKeys

      public void setTraceIdMdcKeys(List<String> traceIdMdcKeys)
      Prioritized ordered list of MDC keys checked by the logging utility to extract and propagate the active APM/observability Trace ID on the sanitized ApiError response body.

      Supported trace key mapping by industry APM tracers:

      • traceId: Standard camelCase key used by Spring Boot 3+ Micrometer Tracing, Spring Cloud Sleuth, and the OpenTelemetry Java SDK default logs exporter.
      • trace_id: Standard snake_case key used by W3C Trace Context specifications, Jaeger, Zipkin, and custom OpenTelemetry instrumentation.
      • dd.trace_id: Datadog APM default MDC injection key populated by the Datadog Java Tracer agent (dd-java-agent).
      • X-B3-TraceId: Zipkin B3 Propagation legacy format key used by older Sleuth and distributed tracing architectures.
      • trace.id: Elastic APM default dot-notation MDC key adhering to the Elastic Common Schema (ECS).
      • dt.trace_id: Dynatrace APM default OneAgent distributed log correlation key.

    • setErrorStatuses

      public void setErrorStatuses(List<Integer> errorStatuses)
      List of HTTP Status integers that should trigger ERROR level logs.

    • setWarnStatuses

      public void setWarnStatuses(List<Integer> warnStatuses)
      List of HTTP Status integers that should trigger WARN level logs.

    • setLegacyLoggingLevelEnabled

      public void setLegacyLoggingLevelEnabled(boolean legacyLoggingLevelEnabled)
      MASTER TOGGLE: Must be TRUE for any legacy system-logging severity fallbacks to trigger.

    • setLegacyLoggingLevelExceptionClasses

      public void setLegacyLoggingLevelExceptionClasses(List<String> legacyLoggingLevelExceptionClasses)
      Targeted fully-qualified exception class names that should revert to legacy logging severities. Only evaluated if legacyLoggingLevelEnabled is true. If empty, all logging severities revert.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object