-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: suranjay <surajkumar.tu@gmail.com>
- Loading branch information
Showing
4 changed files
with
143 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
50 changes: 50 additions & 0 deletions
50
server/src/main/java/org/opensearch/telemetry/tracing/WrappedTracer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
/* | ||
* SPDX-License-Identifier: Apache-2.0 | ||
* | ||
* The OpenSearch Contributors require contributions made to | ||
* this file be licensed under the Apache-2.0 license or a | ||
* compatible open source license. | ||
*/ | ||
|
||
package org.opensearch.telemetry.tracing; | ||
|
||
import org.opensearch.telemetry.TelemetrySettings; | ||
import org.opensearch.telemetry.tracing.noop.NoopTracer; | ||
|
||
import java.io.IOException; | ||
|
||
/** | ||
* Wrapper implementation of Tracer. This delegates call to right tracer based on the tracer settings | ||
*/ | ||
public class WrappedTracer implements Tracer { | ||
|
||
private final Tracer defaultTracer; | ||
private final TelemetrySettings telemetrySettings; | ||
|
||
/** | ||
* Creates WrappedTracer instance | ||
* | ||
* @param telemetrySettings telemetry settings | ||
* @param defaultTracer default tracer instance | ||
*/ | ||
public WrappedTracer(TelemetrySettings telemetrySettings, Tracer defaultTracer) { | ||
this.defaultTracer = defaultTracer; | ||
this.telemetrySettings = telemetrySettings; | ||
} | ||
|
||
@Override | ||
public SpanScope startSpan(String spanName) { | ||
Tracer delegateTracer = getDelegateTracer(); | ||
return delegateTracer.startSpan(spanName); | ||
} | ||
|
||
@Override | ||
public void close() throws IOException { | ||
defaultTracer.close(); | ||
} | ||
|
||
// visible for testing | ||
Tracer getDelegateTracer() { | ||
return telemetrySettings.isTracingEnabled() ? defaultTracer : NoopTracer.INSTANCE; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
71 changes: 71 additions & 0 deletions
71
server/src/test/java/org/opensearch/telemetry/tracing/WrappedTracerTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
/* | ||
* SPDX-License-Identifier: Apache-2.0 | ||
* | ||
* The OpenSearch Contributors require contributions made to | ||
* this file be licensed under the Apache-2.0 license or a | ||
* compatible open source license. | ||
*/ | ||
|
||
package org.opensearch.telemetry.tracing; | ||
|
||
import org.opensearch.common.settings.ClusterSettings; | ||
import org.opensearch.common.settings.Setting; | ||
import org.opensearch.common.settings.Settings; | ||
import org.opensearch.common.util.FeatureFlags; | ||
import org.opensearch.telemetry.TelemetrySettings; | ||
import org.opensearch.telemetry.tracing.noop.NoopTracer; | ||
import org.opensearch.test.OpenSearchTestCase; | ||
|
||
import java.io.IOException; | ||
import java.util.HashSet; | ||
import java.util.List; | ||
import java.util.Set; | ||
|
||
import static org.mockito.Mockito.mock; | ||
import static org.mockito.Mockito.never; | ||
import static org.mockito.Mockito.spy; | ||
import static org.mockito.Mockito.verify; | ||
|
||
public class WrappedTracerTests extends OpenSearchTestCase { | ||
|
||
public void testStartSpanWithTracingDisabledInvokesNoopTracer() { | ||
Settings settings = Settings.builder().put(TelemetrySettings.TRACER_ENABLED_SETTING.getKey(), false).build(); | ||
TelemetrySettings telemetrySettings = new TelemetrySettings(settings, new ClusterSettings(settings, getClusterSettings())); | ||
DefaultTracer mockDefaultTracer = mock(DefaultTracer.class); | ||
|
||
WrappedTracer wrappedTracer = spy(new WrappedTracer(telemetrySettings, mockDefaultTracer)); | ||
|
||
wrappedTracer.startSpan("foo"); | ||
|
||
assertTrue(wrappedTracer.getDelegateTracer() instanceof NoopTracer); | ||
verify(mockDefaultTracer, never()).startSpan("foo"); | ||
} | ||
|
||
public void testStartSpanWithTracingEnabledInvokesDefaultTracer() { | ||
Settings settings = Settings.builder().put(TelemetrySettings.TRACER_ENABLED_SETTING.getKey(), true).build(); | ||
TelemetrySettings telemetrySettings = new TelemetrySettings(settings, new ClusterSettings(settings, getClusterSettings())); | ||
DefaultTracer mockDefaultTracer = mock(DefaultTracer.class); | ||
|
||
WrappedTracer wrappedTracer = spy(new WrappedTracer(telemetrySettings, mockDefaultTracer)); | ||
|
||
wrappedTracer.startSpan("foo"); | ||
|
||
assertTrue(wrappedTracer.getDelegateTracer() instanceof DefaultTracer); | ||
verify(mockDefaultTracer).startSpan("foo"); | ||
} | ||
|
||
public void testClose() throws IOException { | ||
DefaultTracer mockDefaultTracer = mock(DefaultTracer.class); | ||
WrappedTracer wrappedTracer = spy(new WrappedTracer(null, mockDefaultTracer)); | ||
|
||
wrappedTracer.close(); | ||
|
||
verify(mockDefaultTracer).close(); | ||
} | ||
|
||
private Set<Setting<?>> getClusterSettings() { | ||
Set<Setting<?>> allTracerSettings = new HashSet<>(); | ||
ClusterSettings.FEATURE_FLAGGED_CLUSTER_SETTINGS.get(List.of(FeatureFlags.TELEMETRY)).stream().forEach((allTracerSettings::add)); | ||
return allTracerSettings; | ||
} | ||
} |