Skip to content

Commit

Permalink
Add @opensearch.internal annotation
Browse files Browse the repository at this point in the history
Signed-off-by: suranjay <surajkumar.tu@gmail.com>
  • Loading branch information
suranjay committed Jul 10, 2023
1 parent d8c5f6c commit a4b3dd6
Show file tree
Hide file tree
Showing 14 changed files with 32 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

/**
* Interface defining telemetry
*
* @opensearch.internal
*/
public interface Telemetry {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

/**
* Base span
*
* @opensearch.internal
*/
public abstract class AbstractSpan implements Span {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,10 @@

/**
* Default implementation of Scope
*
* @opensearch.internal
*/
public class DefaultSpanScope implements SpanScope {
final class DefaultSpanScope implements SpanScope {

private final Span span;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
* The default tracer implementation. It handles tracing context propagation between spans by maintaining
* current active span in its storage
*
*
* @opensearch.internal
*/
public class DefaultTracer implements Tracer {
class DefaultTracer implements Tracer {
static final String THREAD_NAME = "th_name";

private final TracingTelemetry tracingTelemetry;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@
/**
* An interface that represents a tracing span.
* Spans are created by the Tracer.startSpan method.
* Span must be ended by calling Tracer.endSpan which internally calls Span's endSpan.
* Span must be ended by calling SpanScope.close which internally calls Span's endSpan.
*
* @opensearch.internal
*/
public interface Span {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@

/**
* Wrapper class to hold reference of Span
*
* @opensearch.internal
*/
public class SpanReference {
final class SpanReference {

private Span span;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
* Storage interface used for storing tracing context
* @param <K> key type
* @param <V> value type
*
* @opensearch.internal
*/
public interface TracerContextStorage<K, V> {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

/**
* Interface defining the tracing related context propagation
*
* @opensearch.internal
*/
public interface TracingContextPropagator {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* Interface for tracing telemetry providers
*
* @opensearch.internal
*/
public interface TracingTelemetry extends Closeable {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* No-op implementation of SpanScope
*
* @opensearch.internal
*/
public final class NoopSpanScope implements SpanScope {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

/**
* No-op implementation of Tracer
*
* @opensearch.internal
*/
public class NoopTracer implements Tracer {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

/**
* No-op implementation of TracerFactory
*
* @opensearch.internal
*/
public class NoopTracerFactory extends TracerFactory {
public NoopTracerFactory() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

/**
* Core's ThreadContext based TracerContextStorage implementation
*
* @opensearch.internal
*/
public class ThreadContextBasedTracerContextStorage implements TracerContextStorage<String, Span>, ThreadContextStatePropagator {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,10 @@

/**
* Wrapper implementation of Tracer. This delegates call to right tracer based on the tracer settings
*
* @opensearch.internal
*/
public class WrappedTracer implements Tracer {
final class WrappedTracer implements Tracer {

private final Tracer defaultTracer;
private final TelemetrySettings telemetrySettings;
Expand Down

0 comments on commit a4b3dd6

Please sign in to comment.