zipkin2.storage.ServiceAndSpanNames Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of zipkin Show documentation

There is a newer version: 3.4.2

/*
 * Copyright The OpenZipkin Authors
 * SPDX-License-Identifier: Apache-2.0
 */
package zipkin2.storage;

import java.util.List;
import zipkin2.Call;
import zipkin2.Endpoint;
import zipkin2.Span;

/**
 * Provides autocomplete functionality by providing values for service and span names, usually
 * derived from {@link SpanConsumer}.
 */
public interface ServiceAndSpanNames {

  /**
   * Retrieves all {@link Span#localEndpoint() local} {@link Endpoint#serviceName() service names},
   * sorted lexicographically.
   */
  Call> getServiceNames();

  /**
   * Retrieves all {@link Span#remoteEndpoint() remote} {@link Endpoint#serviceName() service names}
   * recorded by a {@link Span#localEndpoint() service}, sorted lexicographically.
   */
  Call> getRemoteServiceNames(String serviceName);

  /**
   * Retrieves all {@link Span#name() span names} recorded by a {@link Span#localEndpoint()
   * service}, sorted lexicographically.
   */
  Call> getSpanNames(String serviceName);
}