Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
clean up
  • Loading branch information
Liudmila Molkova committed Jan 6, 2025
commit 1031d6d529d14844282a6f21662bc15ae9ecc495
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
* Options for configuring library-specific telemetry settings.
*
* <p><strong>This class is intended to be used by the client libraries only. Library options must not be provided or modified
* by application code</strong>
* <p>
* by application code</strong></p>
*
* Library options describe the client library - it's name, version, and schema URL.
* Schema URL describes telemetry schema and version.
* <p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import static io.clientcore.core.telemetry.NoopTelemetryProvider.NOOP_PROVIDER;

/**
* Provides observability capabilities (distributed tracing, metrics, etc.) with OpenTelemetry to the client library.
* A container that can resolve observability provider and its components. Only OpenTelemetry is supported.
*
* <p><strong>This interface is intended to be used by client libraries. Application developers
* should use OpenTelemetry API directly</strong></p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,7 @@

/**
* A {@code Span} represents a single operation within a trace. Spans can be nested to form a trace tree.
* <p>
*
* This span is a wrapper over OpenTelemetry's span,
* <p>
*
* <strong>Classes in this package are not intended to be used by client libraries. Application developers
* should use OpenTelemetry API directly</strong>
* <p><strong>This interface is intended to be used by client libraries only. Application developers should use OpenTelemetry API directly</strong></p>
*/
public interface Span {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@

/**
* Represents a span builder.
* <p>
*
* <strong>Classes in this package are not intended to be used by client libraries. Application developers
* should use OpenTelemetry API directly</strong>
* <p><strong>This interface is intended to be used by client libraries only. Application developers should use OpenTelemetry API directly</strong></p>
*/
public interface SpanBuilder {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,8 @@
/**
* Uniquely identifies span in a trace. It is propagated over the wire and
* is used to correlated spans across different services.
* <p>
*
* <strong>Classes in this package are not intended to be used by client libraries. Application developers
* should use OpenTelemetry API directly</strong>
* <p><strong>This interface is intended to be used by client libraries only. Application developers
* should use OpenTelemetry API directly</strong></p>
*/
public interface SpanContext {

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

/**
* Represents the span kind.
* <p>
*
* <strong>This enum is intended to be used by client libraries. Application developers
* should use OpenTelemetry API directly</strong>
* <p><strong>This enum is intended to be used by client libraries only. Application developers
* should use OpenTelemetry API directly</strong></p>
*/
public enum SpanKind {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

/**
* A {@code TextMapGetter} retrieves context fields from a carrier, such as {@link io.clientcore.core.http.models.HttpRequest}.
* <p><strong>This interface is intended to be used by client libraries only. Application developers should use OpenTelemetry API directly</strong></p>
*
* @param <C> the type of the carrier.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
/**
* A {@code TextMapPropagator} injects and extracts tracing context from a carrier,
* such as {@link io.clientcore.core.http.models.HttpRequest}.
* <p><strong>This interface is intended to be used by client libraries only. Application developers should use OpenTelemetry API directly</strong></p>
*/
public interface TextMapPropagator {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

/**
* A {@code TextMapSetter} sets context fields on a carrier, such as {@link io.clientcore.core.http.models.HttpRequest}.
* <p><strong>This interface is intended to be used by client libraries only. Application developers should use OpenTelemetry API directly</strong></p>
*
* @param <C> the type of the carrier.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,7 @@

/**
* Represents a tracer - a component that creates spans.
* <p>
*
* <strong>This interface is intended to be used by client libraries. Application developers
* should use OpenTelemetry API directly</strong>
* <p><strong>This interface is intended to be used by client libraries only. Application developers should use OpenTelemetry API directly</strong></p>
*/
public interface Tracer {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,8 @@
* <p>
*
* The scope MUST be closed. It also MUST be closed on the same thread it was created.
* <p>
*
* <strong>This interface is intended to be used by client libraries. Application developers
* should use OpenTelemetry API directly</strong>
* <p><strong>This interface is intended to be used by client libraries only. Application developers should use OpenTelemetry API directly</strong></p>
*/
@FunctionalInterface
public interface TracingScope extends AutoCloseable {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* Package containing core tracing primitives to be used by client libraries.
* <p>
*
* <strong>Classes in this package are not intended to be used by client libraries. Application developers
* <strong>Classes in this package are intended to be used by client libraries only. Application developers
* should use OpenTelemetry API directly</strong>
*/
package io.clientcore.core.telemetry.tracing;