org.opensearch.telemetry.tracing.TracingTelemetry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opensearch-telemetry Show documentation

OpenSearch subproject :libs:opensearch-telemetry

The newest version!

/*
 * 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.annotation.ExperimentalApi;

import java.io.Closeable;

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

    /**
     * Creates span with provided arguments
     *
     * @param spanCreationContext span creation context.
     * @param parentSpan parent span.
     * @return span instance
     */
    Span createSpan(SpanCreationContext spanCreationContext, Span parentSpan);

    /**
     * provides tracing context propagator
     * @return tracing context propagator instance
     */
    TracingContextPropagator getContextPropagator();

}