|
| 1 | +/* |
| 2 | + * Copyright 2012-2024 the original author or authors. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * https://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +package org.springframework.boot.actuate.autoconfigure.tracing; |
| 18 | + |
| 19 | +import java.util.List; |
| 20 | + |
| 21 | +import io.micrometer.tracing.SpanCustomizer; |
| 22 | +import io.micrometer.tracing.exporter.SpanExportingPredicate; |
| 23 | +import io.micrometer.tracing.exporter.SpanFilter; |
| 24 | +import io.micrometer.tracing.exporter.SpanReporter; |
| 25 | +import io.micrometer.tracing.otel.bridge.CompositeSpanExporter; |
| 26 | +import io.micrometer.tracing.otel.bridge.EventListener; |
| 27 | +import io.micrometer.tracing.otel.bridge.OtelBaggageManager; |
| 28 | +import io.micrometer.tracing.otel.bridge.OtelCurrentTraceContext; |
| 29 | +import io.micrometer.tracing.otel.bridge.OtelPropagator; |
| 30 | +import io.micrometer.tracing.otel.bridge.OtelSpanCustomizer; |
| 31 | +import io.micrometer.tracing.otel.bridge.OtelTracer; |
| 32 | +import io.micrometer.tracing.otel.bridge.OtelTracer.EventPublisher; |
| 33 | +import io.micrometer.tracing.otel.bridge.Slf4JEventListener; |
| 34 | +import io.opentelemetry.api.OpenTelemetry; |
| 35 | +import io.opentelemetry.api.metrics.MeterProvider; |
| 36 | +import io.opentelemetry.api.trace.Tracer; |
| 37 | +import io.opentelemetry.context.propagation.ContextPropagators; |
| 38 | +import io.opentelemetry.context.propagation.TextMapPropagator; |
| 39 | +import io.opentelemetry.sdk.resources.Resource; |
| 40 | +import io.opentelemetry.sdk.trace.SdkTracerProvider; |
| 41 | +import io.opentelemetry.sdk.trace.SdkTracerProviderBuilder; |
| 42 | +import io.opentelemetry.sdk.trace.SpanProcessor; |
| 43 | +import io.opentelemetry.sdk.trace.export.BatchSpanProcessor; |
| 44 | +import io.opentelemetry.sdk.trace.export.BatchSpanProcessorBuilder; |
| 45 | +import io.opentelemetry.sdk.trace.export.SpanExporter; |
| 46 | +import io.opentelemetry.sdk.trace.samplers.Sampler; |
| 47 | +import org.apache.commons.logging.Log; |
| 48 | +import org.apache.commons.logging.LogFactory; |
| 49 | + |
| 50 | +import org.springframework.beans.factory.ObjectProvider; |
| 51 | +import org.springframework.boot.SpringBootVersion; |
| 52 | +import org.springframework.boot.autoconfigure.AutoConfiguration; |
| 53 | +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; |
| 54 | +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; |
| 55 | +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; |
| 56 | +import org.springframework.boot.context.properties.EnableConfigurationProperties; |
| 57 | +import org.springframework.context.annotation.Bean; |
| 58 | +import org.springframework.context.annotation.Import; |
| 59 | +import org.springframework.util.CollectionUtils; |
| 60 | + |
| 61 | +/** |
| 62 | + * {@link EnableAutoConfiguration Auto-configuration} for OpenTelemetry tracing. |
| 63 | + * |
| 64 | + * @author Moritz Halbritter |
| 65 | + * @author Marcin Grzejszczak |
| 66 | + * @author Yanming Zhou |
| 67 | + * @since 3.0.0 |
| 68 | + */ |
| 69 | +@AutoConfiguration(value = "openTelemetryTracingAutoConfiguration", |
| 70 | + before = { MicrometerTracingAutoConfiguration.class, NoopTracerAutoConfiguration.class }) |
| 71 | +@ConditionalOnClass({ OtelTracer.class, SdkTracerProvider.class, OpenTelemetry.class }) |
| 72 | +@EnableConfigurationProperties(TracingProperties.class) |
| 73 | +@Import({ OpenTelemetryPropagationConfigurations.PropagationWithoutBaggage.class, |
| 74 | + OpenTelemetryPropagationConfigurations.PropagationWithBaggage.class, |
| 75 | + OpenTelemetryPropagationConfigurations.NoPropagation.class }) |
| 76 | +public class OpenTelemetryTracingAutoConfiguration { |
| 77 | + |
| 78 | + private static final Log logger = LogFactory.getLog(OpenTelemetryTracingAutoConfiguration.class); |
| 79 | + |
| 80 | + private final TracingProperties tracingProperties; |
| 81 | + |
| 82 | + OpenTelemetryTracingAutoConfiguration(TracingProperties tracingProperties) { |
| 83 | + this.tracingProperties = tracingProperties; |
| 84 | + if (!CollectionUtils.isEmpty(this.tracingProperties.getBaggage().getLocalFields())) { |
| 85 | + logger.warn("Local fields are not supported when using OpenTelemetry!"); |
| 86 | + } |
| 87 | + } |
| 88 | + |
| 89 | + @Bean |
| 90 | + @ConditionalOnMissingBean |
| 91 | + SdkTracerProvider otelSdkTracerProvider(Resource resource, SpanProcessors spanProcessors, Sampler sampler, |
| 92 | + ObjectProvider<SdkTracerProviderBuilderCustomizer> customizers) { |
| 93 | + SdkTracerProviderBuilder builder = SdkTracerProvider.builder().setSampler(sampler).setResource(resource); |
| 94 | + spanProcessors.forEach(builder::addSpanProcessor); |
| 95 | + customizers.orderedStream().forEach((customizer) -> customizer.customize(builder)); |
| 96 | + return builder.build(); |
| 97 | + } |
| 98 | + |
| 99 | + @Bean |
| 100 | + @ConditionalOnMissingBean |
| 101 | + ContextPropagators otelContextPropagators(ObjectProvider<TextMapPropagator> textMapPropagators) { |
| 102 | + return ContextPropagators.create(TextMapPropagator.composite(textMapPropagators.orderedStream().toList())); |
| 103 | + } |
| 104 | + |
| 105 | + @Bean |
| 106 | + @ConditionalOnMissingBean |
| 107 | + Sampler otelSampler() { |
| 108 | + Sampler rootSampler = Sampler.traceIdRatioBased(this.tracingProperties.getSampling().getProbability()); |
| 109 | + return Sampler.parentBased(rootSampler); |
| 110 | + } |
| 111 | + |
| 112 | + @Bean |
| 113 | + @ConditionalOnMissingBean |
| 114 | + SpanProcessors spanProcessors(ObjectProvider<SpanProcessor> spanProcessors) { |
| 115 | + return SpanProcessors.of(spanProcessors.orderedStream().toList()); |
| 116 | + } |
| 117 | + |
| 118 | + @Bean |
| 119 | + BatchSpanProcessor otelSpanProcessor(SpanExporters spanExporters, |
| 120 | + ObjectProvider<SpanExportingPredicate> spanExportingPredicates, ObjectProvider<SpanReporter> spanReporters, |
| 121 | + ObjectProvider<SpanFilter> spanFilters, ObjectProvider<MeterProvider> meterProvider) { |
| 122 | + BatchSpanProcessorBuilder builder = BatchSpanProcessor |
| 123 | + .builder(new CompositeSpanExporter(spanExporters.list(), spanExportingPredicates.orderedStream().toList(), |
| 124 | + spanReporters.orderedStream().toList(), spanFilters.orderedStream().toList())); |
| 125 | + meterProvider.ifAvailable(builder::setMeterProvider); |
| 126 | + return builder.build(); |
| 127 | + } |
| 128 | + |
| 129 | + @Bean |
| 130 | + @ConditionalOnMissingBean |
| 131 | + SpanExporters spanExporters(ObjectProvider<SpanExporter> spanExporters) { |
| 132 | + return SpanExporters.of(spanExporters.orderedStream().toList()); |
| 133 | + } |
| 134 | + |
| 135 | + @Bean |
| 136 | + @ConditionalOnMissingBean |
| 137 | + Tracer otelTracer(OpenTelemetry openTelemetry) { |
| 138 | + return openTelemetry.getTracer("org.springframework.boot", SpringBootVersion.getVersion()); |
| 139 | + } |
| 140 | + |
| 141 | + @Bean |
| 142 | + @ConditionalOnMissingBean(io.micrometer.tracing.Tracer.class) |
| 143 | + OtelTracer micrometerOtelTracer(Tracer tracer, EventPublisher eventPublisher, |
| 144 | + OtelCurrentTraceContext otelCurrentTraceContext) { |
| 145 | + List<String> remoteFields = this.tracingProperties.getBaggage().getRemoteFields(); |
| 146 | + List<String> tagFields = this.tracingProperties.getBaggage().getTagFields(); |
| 147 | + return new OtelTracer(tracer, otelCurrentTraceContext, eventPublisher, |
| 148 | + new OtelBaggageManager(otelCurrentTraceContext, remoteFields, tagFields)); |
| 149 | + } |
| 150 | + |
| 151 | + @Bean |
| 152 | + @ConditionalOnMissingBean |
| 153 | + OtelPropagator otelPropagator(ContextPropagators contextPropagators, Tracer tracer) { |
| 154 | + return new OtelPropagator(contextPropagators, tracer); |
| 155 | + } |
| 156 | + |
| 157 | + @Bean |
| 158 | + @ConditionalOnMissingBean |
| 159 | + EventPublisher otelTracerEventPublisher(List<EventListener> eventListeners) { |
| 160 | + return new OTelEventPublisher(eventListeners); |
| 161 | + } |
| 162 | + |
| 163 | + @Bean |
| 164 | + @ConditionalOnMissingBean |
| 165 | + OtelCurrentTraceContext otelCurrentTraceContext() { |
| 166 | + return new OtelCurrentTraceContext(); |
| 167 | + } |
| 168 | + |
| 169 | + @Bean |
| 170 | + @ConditionalOnMissingBean |
| 171 | + Slf4JEventListener otelSlf4JEventListener() { |
| 172 | + return new Slf4JEventListener(); |
| 173 | + } |
| 174 | + |
| 175 | + @Bean |
| 176 | + @ConditionalOnMissingBean(SpanCustomizer.class) |
| 177 | + OtelSpanCustomizer otelSpanCustomizer() { |
| 178 | + return new OtelSpanCustomizer(); |
| 179 | + } |
| 180 | + |
| 181 | + static class OTelEventPublisher implements EventPublisher { |
| 182 | + |
| 183 | + private final List<EventListener> listeners; |
| 184 | + |
| 185 | + OTelEventPublisher(List<EventListener> listeners) { |
| 186 | + this.listeners = listeners; |
| 187 | + } |
| 188 | + |
| 189 | + @Override |
| 190 | + public void publishEvent(Object event) { |
| 191 | + for (EventListener listener : this.listeners) { |
| 192 | + listener.onEvent(event); |
| 193 | + } |
| 194 | + } |
| 195 | + |
| 196 | + } |
| 197 | + |
| 198 | +} |
0 commit comments