dsmiley commented on code in PR #1168: URL: https://github.com/apache/solr/pull/1168#discussion_r1061895876
########## solr/modules/opentelemetry/src/java/org/apache/solr/opentelemetry/ClosableTracerShim.java: ########## @@ -0,0 +1,85 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.solr.opentelemetry; + +import io.opentelemetry.sdk.trace.SdkTracerProvider; +import io.opentracing.Scope; +import io.opentracing.ScopeManager; +import io.opentracing.Span; +import io.opentracing.SpanContext; +import io.opentracing.Tracer; +import io.opentracing.propagation.Format; +import java.lang.invoke.MethodHandles; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Delegate shim that forwards all calls to the actual {@link + * io.opentelemetry.opentracingshim.OpenTracingShim}, and in addition calls {@link + * SdkTracerProvider#close()} to really close the OTEL SDK tracer when the OT shim is closed. + * + * <p>TODO: This can be removed once we migrate Solr instrumentation from OpenTracing to + * OpenTelemetry + */ +public class ClosableTracerShim implements Tracer { + private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); + private final Tracer shim; + private final SdkTracerProvider sdkTracerProvider; + + public ClosableTracerShim(Tracer shim, SdkTracerProvider sdkTracerProvider) { + this.shim = shim; + this.sdkTracerProvider = sdkTracerProvider; + } + + @Override + public ScopeManager scopeManager() { + return shim.scopeManager(); + } + + @Override + public Span activeSpan() { + return shim.activeSpan(); + } + + @Override + public Scope activateSpan(Span span) { + return shim.activateSpan(span); + } + + @Override + public SpanBuilder buildSpan(String operationName) { + return shim.buildSpan(operationName); + } + + @Override + public <C> void inject(SpanContext spanContext, Format<C> format, C carrier) { + shim.inject(spanContext, format, carrier); + } + + @Override + public <C> SpanContext extract(Format<C> format, C carrier) { + return shim.extract(format, carrier); + } + + @Override + public void close() { + shim.close(); + log.info("Closing wrapped OTEL tracer instance."); Review Comment: Honestly seems like debug level of importance. If all our closeables logged they were closing.... ouch. ########## solr/modules/opentelemetry/src/java/org/apache/solr/opentelemetry/OtelTracerConfigurator.java: ########## @@ -0,0 +1,138 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.solr.opentelemetry; + +import io.opentelemetry.opentracingshim.OpenTracingShim; +import io.opentelemetry.sdk.OpenTelemetrySdk; +import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk; +import io.opentracing.Tracer; +import java.lang.invoke.MethodHandles; +import java.util.HashMap; +import java.util.Locale; +import java.util.Map; +import java.util.Objects; +import java.util.stream.Collectors; +import org.apache.solr.core.TracerConfigurator; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * OpenTracing TracerConfigurator implementation which exports spans to OpenTelemetry in OTLP + * format. This impl re-uses the existing OpenTracing instrumentation through a shim, and takes care + * of properly closing the backing Tracer when Solr shuts down. + */ +public class OtelTracerConfigurator extends TracerConfigurator { + private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); + // Copy of environment. Can be overridden by tests + Map<String, String> currentEnv = System.getenv(); + + @Override + public Tracer getTracer() { + setDefaultIfNotConfigured("OTEL_SERVICE_NAME", "solr"); + setDefaultIfNotConfigured("OTEL_TRACES_EXPORTER", "otlp"); + setDefaultIfNotConfigured("OTEL_EXPORTER_OTLP_PROTOCOL", "grpc"); + setDefaultIfNotConfigured("OTEL_TRACES_SAMPLER", "parentbased_always_on"); + + final String currentConfig = + String.join( + "; ", + getCurrentOtelConfig().entrySet().stream() + .map(e -> e.getKey() + "=" + e.getValue()) + .collect(Collectors.toSet())); + + log.info("OpenTelemetry tracer enabled with configuration: {}", currentConfig); Review Comment: Do you think outputting the config warrants INFO level? ... I have no doubt it was useful during development but we should consider our log levels when we ship. ########## solr/modules/opentelemetry/src/java/org/apache/solr/opentelemetry/OtelTracerConfigurator.java: ########## @@ -0,0 +1,138 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.solr.opentelemetry; + +import io.opentelemetry.opentracingshim.OpenTracingShim; +import io.opentelemetry.sdk.OpenTelemetrySdk; +import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk; +import io.opentracing.Tracer; +import java.lang.invoke.MethodHandles; +import java.util.HashMap; +import java.util.Locale; +import java.util.Map; +import java.util.Objects; +import java.util.stream.Collectors; +import org.apache.solr.core.TracerConfigurator; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * OpenTracing TracerConfigurator implementation which exports spans to OpenTelemetry in OTLP + * format. This impl re-uses the existing OpenTracing instrumentation through a shim, and takes care + * of properly closing the backing Tracer when Solr shuts down. + */ +public class OtelTracerConfigurator extends TracerConfigurator { + private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); + // Copy of environment. Can be overridden by tests + Map<String, String> currentEnv = System.getenv(); + + @Override + public Tracer getTracer() { + setDefaultIfNotConfigured("OTEL_SERVICE_NAME", "solr"); + setDefaultIfNotConfigured("OTEL_TRACES_EXPORTER", "otlp"); + setDefaultIfNotConfigured("OTEL_EXPORTER_OTLP_PROTOCOL", "grpc"); + setDefaultIfNotConfigured("OTEL_TRACES_SAMPLER", "parentbased_always_on"); + + final String currentConfig = + String.join( + "; ", + getCurrentOtelConfig().entrySet().stream() + .map(e -> e.getKey() + "=" + e.getValue()) + .collect(Collectors.toSet())); Review Comment: If the objective is to create a String (which I see it is), then it's better to use a `Collectors.joining("; ")` instead of producing a Set to then join it. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org For additional commands, e-mail: issues-h...@solr.apache.org
