forked from opensearch-project/OpenSearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds OLTP GRPC span exporter support
Signed-off-by: Gagan Juneja <gjjuneja@amazon.com>
- Loading branch information
Gagan Juneja
committed
Jul 4, 2023
1 parent
544b1ca
commit 4583a6f
Showing
6 changed files
with
150 additions
and
0 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
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
59 changes: 59 additions & 0 deletions
59
...try-otel/src/main/java/org/opensearch/telemetry/tracing/exporter/SpanExporterFactory.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,59 @@ | ||
/* | ||
* 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.exporter; | ||
|
||
import io.opentelemetry.exporter.logging.LoggingSpanExporter; | ||
import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter; | ||
import io.opentelemetry.sdk.trace.export.SpanExporter; | ||
import org.opensearch.common.settings.Setting; | ||
import org.opensearch.common.settings.Settings; | ||
|
||
import static org.opensearch.telemetry.OTelTelemetryPlugin.TRACER_EXPORTER_DELAY_SETTING; | ||
|
||
/** | ||
* Factory class to create the {@link SpanExporter} instance. | ||
*/ | ||
public class SpanExporterFactory { | ||
|
||
/** | ||
* Span Exporter type setting. | ||
*/ | ||
public static final Setting<SpanExporterType> TRACER_SPAN_EXPORTER_TYPE_SETTING = new Setting<>( | ||
"telemetry.tracer.span.exporter.type", | ||
SpanExporterType.LOGGING.name(), | ||
SpanExporterType::fromString, | ||
Setting.Property.NodeScope, | ||
Setting.Property.Dynamic | ||
); | ||
|
||
/** | ||
* Base constructor. | ||
*/ | ||
public SpanExporterFactory() { | ||
|
||
} | ||
|
||
/** | ||
* Creates the {@link SpanExporter} instaces based on the TRACER_SPAN_EXPORTER_TYPE_SETTING value. | ||
* @param settings settings. | ||
* @return SpanExporter instance. | ||
*/ | ||
public SpanExporter create(Settings settings) { | ||
SpanExporterType exporterType = TRACER_SPAN_EXPORTER_TYPE_SETTING.get(settings); | ||
switch (exporterType) { | ||
case OLTP_GRPC: | ||
//TODO: For now just giving default implementation, but we need to use otel autoconfigue to expose | ||
// all the configurations. | ||
return OtlpGrpcSpanExporter.builder().build(); | ||
case LOGGING: | ||
default: | ||
return LoggingSpanExporter.create(); | ||
} | ||
} | ||
} |
36 changes: 36 additions & 0 deletions
36
...emetry-otel/src/main/java/org/opensearch/telemetry/tracing/exporter/SpanExporterType.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,36 @@ | ||
/* | ||
* 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.exporter; | ||
|
||
import java.util.Arrays; | ||
|
||
/** | ||
* Span Exporter type. For now, we are just supporting the 2 main types. But the idea is to make it configurable | ||
* through otel autoconfigure. | ||
*/ | ||
public enum SpanExporterType { | ||
|
||
LOGGING, OLTP_GRPC; | ||
|
||
/** | ||
* Creates the {@link SpanExporterType} instance from the String. | ||
* @param name | ||
* @return | ||
*/ | ||
public static SpanExporterType fromString(String name) { | ||
for (SpanExporterType exporterType : values()) { | ||
if (exporterType.name().equalsIgnoreCase(name)) { | ||
return exporterType; | ||
} | ||
} | ||
throw new IllegalArgumentException( | ||
"invalid value for tracing level [" + name + "], " + "must be in " + Arrays.asList(SpanExporterType.values()) | ||
); | ||
} | ||
} |
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
44 changes: 44 additions & 0 deletions
44
...otel/src/test/java/org/opensearch/telemetry/tracing/exporter/SpanExporterFactoryTest.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,44 @@ | ||
/* | ||
* 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.exporter; | ||
|
||
import io.opentelemetry.exporter.logging.LoggingSpanExporter; | ||
import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter; | ||
import io.opentelemetry.sdk.trace.export.SpanExporter; | ||
import org.opensearch.common.settings.Settings; | ||
import org.opensearch.test.OpenSearchTestCase; | ||
|
||
|
||
public class SpanExporterFactoryTest extends OpenSearchTestCase { | ||
|
||
private final SpanExporterFactory spanExporterFactory = new SpanExporterFactory(); | ||
|
||
public void testSpanExporterDefault() { | ||
Settings settings = Settings.builder().build(); | ||
SpanExporter spanExporter = spanExporterFactory.create(settings); | ||
assertTrue(spanExporter instanceof LoggingSpanExporter); | ||
} | ||
|
||
public void testSpanExporterLogging() { | ||
Settings settings = Settings.builder().put(SpanExporterFactory.TRACER_SPAN_EXPORTER_TYPE_SETTING.getKey(), "logging").build(); | ||
SpanExporter spanExporter = spanExporterFactory.create(settings); | ||
assertTrue(spanExporter instanceof LoggingSpanExporter); | ||
} | ||
|
||
public void testSpanExporterGrpc() { | ||
Settings settings = Settings.builder().put(SpanExporterFactory.TRACER_SPAN_EXPORTER_TYPE_SETTING.getKey(), "OLTP_GRPC").build(); | ||
SpanExporter spanExporter = spanExporterFactory.create(settings); | ||
assertTrue(spanExporter instanceof OtlpGrpcSpanExporter); | ||
} | ||
|
||
public void testSpanExporterInvalid() { | ||
Settings settings = Settings.builder().put(SpanExporterFactory.TRACER_SPAN_EXPORTER_TYPE_SETTING.getKey(), "abc").build(); | ||
assertThrows(IllegalArgumentException.class, () -> spanExporterFactory.create(settings)); | ||
} | ||
} |