io.opentelemetry.instrumentation.log4j.contextdata.v2_17.OpenTelemetryContextDataProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentelemetry-log4j-context-data-2.17-autoconfigure Show documentation

Instrumentation of Java libraries using OpenTelemetry.

There is a newer version: 2.10.0-alpha

Show newest version

/*
 * Copyright The OpenTelemetry Authors
 * SPDX-License-Identifier: Apache-2.0
 */

package io.opentelemetry.instrumentation.log4j.contextdata.v2_17;

import io.opentelemetry.api.baggage.Baggage;
import io.opentelemetry.api.baggage.BaggageEntry;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanContext;
import io.opentelemetry.context.Context;
import io.opentelemetry.instrumentation.api.incubator.log.LoggingContextConstants;
import io.opentelemetry.instrumentation.api.internal.ConfigPropertiesUtil;
import io.opentelemetry.javaagent.bootstrap.internal.ConfiguredResourceAttributesHolder;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.apache.logging.log4j.core.util.ContextDataProvider;

/**
 * Implementation of Log4j 2's {@link ContextDataProvider} which is loaded via SPI. {@link
 * #supplyContextData()} is called when a log entry is created.
 */
public class OpenTelemetryContextDataProvider implements ContextDataProvider {
  private static final boolean BAGGAGE_ENABLED =
      ConfigPropertiesUtil.getBoolean("otel.instrumentation.log4j-context-data.add-baggage", false);
  private static final String TRACE_ID_KEY =
      ConfigPropertiesUtil.getString(
          "otel.instrumentation.common.logging.trace-id", LoggingContextConstants.TRACE_ID);
  private static final String SPAN_ID_KEY =
      ConfigPropertiesUtil.getString(
          "otel.instrumentation.common.logging.span-id", LoggingContextConstants.SPAN_ID);
  private static final String TRACE_FLAGS_KEY =
      ConfigPropertiesUtil.getString(
          "otel.instrumentation.common.logging.trace-flags", LoggingContextConstants.TRACE_FLAGS);
  private static final boolean configuredResourceAttributeAccessible =
      isConfiguredResourceAttributeAccessible();
  private static final Map staticContextData = getStaticContextData();

  private static Map getStaticContextData() {
    if (configuredResourceAttributeAccessible) {
      return ConfiguredResourceAttributesHolder.getResourceAttributes();
    }
    return Collections.emptyMap();
  }

  /**
   * Checks whether {@link ConfiguredResourceAttributesHolder} is available in classpath. The result
   * is true if {@link ConfiguredResourceAttributesHolder} can be loaded, false otherwise.
   *
   * @return A boolean
   */
  private static boolean isConfiguredResourceAttributeAccessible() {
    try {
      Class.forName(
          "io.opentelemetry.javaagent.bootstrap.internal.ConfiguredResourceAttributesHolder");
      return true;

    } catch (ClassNotFoundException ok) {
      return false;
    }
  }

  /**
   * Returns context from the current span when available.
   *
   * @return A map containing string versions of the traceId, spanId, and traceFlags, which can then
   *     be accessed from layout components
   */
  @Override
  public Map supplyContextData() {
    Context context = Context.current();
    Span currentSpan = Span.fromContext(context);
    if (!currentSpan.getSpanContext().isValid()) {
      return staticContextData;
    }

    Map contextData = new HashMap<>();
    contextData.putAll(staticContextData);

    SpanContext spanContext = currentSpan.getSpanContext();
    contextData.put(TRACE_ID_KEY, spanContext.getTraceId());
    contextData.put(SPAN_ID_KEY, spanContext.getSpanId());
    contextData.put(TRACE_FLAGS_KEY, spanContext.getTraceFlags().asHex());

    if (BAGGAGE_ENABLED) {
      Baggage baggage = Baggage.fromContext(context);
      for (Map.Entry entry : baggage.asMap().entrySet()) {
        // prefix all baggage values to avoid clashes with existing context
        contextData.put("baggage." + entry.getKey(), entry.getValue().getValue());
      }
    }

    return contextData;
  }
}