io.github.logcontext.LoggingContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of logging-context-api Show documentation

The primary API for the logging context wrapper.

There is a newer version: 0.0.3

package io.github.logcontext;

import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * The LoggingContext annotation identifies a section of code as having a specific contextual value
 * associated with logging statements. The annotation can be applied to classes, methods, and method
 * parameters. When applied to a class or method, it associates the scope of the class or method
 * with a Nested Diagnostic Context (NDC). When applied to method parameters, the parameter and its
 * value are associated with the Mapped Diagnostic Context (MDC).
 *
 * If no value is supplied to the annotation, it is assumed that the intended context is the name
 * of the class, method, or parameter. Nested contexts allow for multiple contexts to be added at
 * once by providing an array of context values.
 *
 * 
 *   @LoggingContext("ORDERS")
 *   public class OrdersService {
 *     public static final Logger LOG = LogFactory.getLogger(OrdersService.class);
 *
 *     @LoggingContext("REFUND")
 *     public void issueRefund(@LoggingContext("order_number") String orderNumber) {
 *       LOG.atInfo().log("With NDC [ORDERS, REFUND] and MDC order_number={}", orderNumber);
 *     }
 *
 *     @LoggingContext()
 *     public void cancel(@LoggingContext() String orderNumber) {
 *       LOG.atInfo().log("With NDC [ORDERS, cancel] and MDC orderNumber={}", orderNumber);
 *     }
 *   }
 * 
 */
@Target({ElementType.METHOD, ElementType.TYPE, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface LoggingContext {
  String[] value() default {};
}