/*
 *  Copyright (c) 2019, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
 *
 *  WSO2 Inc. licenses this file to you under the Apache License,
 *  Version 2.0 (the "License"); you may not use this file except
 *  in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */

package org.apache.synapse.aspects.flow.statistics.tracing.opentelemetry.management;

import io.opentelemetry.api.metrics.Meter;
import io.opentelemetry.api.trace.Tracer;
import org.apache.synapse.aspects.flow.statistics.tracing.opentelemetry.management.handling.span.OpenTelemetrySpanHandler;

/**
 * The interface for the manager, which coordinates OpenTelemetry.
 */
public interface OpenTelemetryManager {

    /**
     * Initialize the exporter, configure an openTelemetry instance and create the tracer from it.
     */
    void init();

    /**
     * Return the OpenTelemetry tracer from the initialized openTelemetry instance.
     *
     * @return OpenTelemetry tracer.
     */
    Tracer getTelemetryTracer();

    /**
     * Return the OpenTelemetry meter from the initialized openTelemetry instance.
     *
     * @return OpenTelemetry meter.
     */
    Meter getTelemetryMeter();

    /**
     * Shutdown the SDK cleanly at JVM exit.
     */
    void close();

    /**
     * Return the service name.
     *
     * @return service name.
     */
    String getServiceName();

    /**
     * Returns the OpenTelemetry compatible span handler.
     *
     * @return An OpenTelemetry compatible span handler.
     */
    OpenTelemetrySpanHandler getHandler();

}
