<?php

/**
 * Copyright 2014-Present Couchbase, Inc.
 *
 * Licensed 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.
 */

declare(strict_types=1);

namespace Couchbase;

use Couchbase\Exception\TracerException;

/**
 * Represents a tracer capable of creating trace spans.
 *
 */
interface RequestTracer
{
    /**
     * Creates a new request span.
     *
     * @param string $name The name of the span.
     * @param RequestSpan|null $parent The parent of the span, if one exists.
     * @param int|null $startTimestampNanoseconds The start timestamp of the span in nanoseconds.
     *
     * @return RequestSpan
     *
     * @throws TracerException
     */
    public function requestSpan(string $name, ?RequestSpan $parent = null, ?int $startTimestampNanoseconds = null): RequestSpan;

    public function close(): void;
}
