io.envoyproxy.envoy.config.trace.v3.ZipkinConfigOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grpc-xds Show documentation
gRPC: XDS plugin
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: envoy/config/trace/v3/zipkin.proto

// Protobuf Java Version: 3.25.5
package io.envoyproxy.envoy.config.trace.v3;

public interface ZipkinConfigOrBuilder extends
    // @@protoc_insertion_point(interface_extends:envoy.config.trace.v3.ZipkinConfig)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The cluster manager cluster that hosts the Zipkin collectors.
   * 
   *
   * string collector_cluster = 1 [(.validate.rules) = { ... }
   * @return The collectorCluster.
   */
  java.lang.String getCollectorCluster();
  /**
   *    * The cluster manager cluster that hosts the Zipkin collectors.
   * 
   *
   * string collector_cluster = 1 [(.validate.rules) = { ... }
   * @return The bytes for collectorCluster.
   */
  com.google.protobuf.ByteString
      getCollectorClusterBytes();

  /**
   *    * The API endpoint of the Zipkin service where the spans will be sent. When
   * using a standard Zipkin installation.
   * 
   *
   * string collector_endpoint = 2 [(.validate.rules) = { ... }
   * @return The collectorEndpoint.
   */
  java.lang.String getCollectorEndpoint();
  /**
   *    * The API endpoint of the Zipkin service where the spans will be sent. When
   * using a standard Zipkin installation.
   * 
   *
   * string collector_endpoint = 2 [(.validate.rules) = { ... }
   * @return The bytes for collectorEndpoint.
   */
  com.google.protobuf.ByteString
      getCollectorEndpointBytes();

  /**
   *    * Determines whether a 128bit trace id will be used when creating a new
   * trace instance. The default value is false, which will result in a 64 bit trace id being used.
   * 
   *
   * bool trace_id_128bit = 3;
   * @return The traceId128bit.
   */
  boolean getTraceId128Bit();

  /**
   *    * Determines whether client and server spans will share the same span context.
   * The default value is true.
   * 
   *
   * .google.protobuf.BoolValue shared_span_context = 4;
   * @return Whether the sharedSpanContext field is set.
   */
  boolean hasSharedSpanContext();
  /**
   *    * Determines whether client and server spans will share the same span context.
   * The default value is true.
   * 
   *
   * .google.protobuf.BoolValue shared_span_context = 4;
   * @return The sharedSpanContext.
   */
  com.google.protobuf.BoolValue getSharedSpanContext();
  /**
   *    * Determines whether client and server spans will share the same span context.
   * The default value is true.
   * 
   *
   * .google.protobuf.BoolValue shared_span_context = 4;
   */
  com.google.protobuf.BoolValueOrBuilder getSharedSpanContextOrBuilder();

  /**
   *    * Determines the selected collector endpoint version.
   * 
   *
   * .envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;
   * @return The enum numeric value on the wire for collectorEndpointVersion.
   */
  int getCollectorEndpointVersionValue();
  /**
   *    * Determines the selected collector endpoint version.
   * 
   *
   * .envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;
   * @return The collectorEndpointVersion.
   */
  io.envoyproxy.envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion getCollectorEndpointVersion();

  /**
   *    * Optional hostname to use when sending spans to the collector_cluster. Useful for collectors
   * that require a specific hostname. Defaults to :ref:`collector_cluster <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_cluster>` above.
   * 
   *
   * string collector_hostname = 6;
   * @return The collectorHostname.
   */
  java.lang.String getCollectorHostname();
  /**
   *    * Optional hostname to use when sending spans to the collector_cluster. Useful for collectors
   * that require a specific hostname. Defaults to :ref:`collector_cluster <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_cluster>` above.
   * 
   *
   * string collector_hostname = 6;
   * @return The bytes for collectorHostname.
   */
  com.google.protobuf.ByteString
      getCollectorHostnameBytes();

  /**
   *    * If this is set to true, then Envoy will be treated as an independent hop in trace chain. A complete span pair will be created for a single
   * request. Server span will be created for the downstream request and client span will be created for the related upstream request.
   * This should be set to true in the following cases:
   *
   * * The Envoy Proxy is used as gateway or ingress.
   * * The Envoy Proxy is used as sidecar but inbound traffic capturing or outbound traffic capturing is disabled.
   * * Any case that the :ref:`start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` is set to true.
   *
   * .. attention::
   *
   *   If this is set to true, then the
   *   :ref:`start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>`
   *   SHOULD be set to true also to ensure the correctness of trace chain.
   *
   *   Both this field and ``start_child_span`` are deprecated by the
   *   :ref:`spawn_upstream_span <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.spawn_upstream_span>`.
   *   Please use that ``spawn_upstream_span`` field to control the span creation.
   * 
   *
   * bool split_spans_for_request = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
   * @deprecated envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated.
   *     See envoy/config/trace/v3/zipkin.proto;l=88
   * @return The splitSpansForRequest.
   */
  @java.lang.Deprecated boolean getSplitSpansForRequest();
}