Package io.envoyproxy.envoy.config.trace.v3

Interface OpenCensusConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    OpenCensusConfig, OpenCensusConfig.Builder
    public interface OpenCensusConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasTraceConfig

        boolean hasTraceConfig()
         Configures tracing, e.g. the sampler, max number of annotations, etc.
        .opencensus.proto.trace.v1.TraceConfig trace_config = 1;
        Returns:
        Whether the traceConfig field is set.

      • getTraceConfig

        TraceConfig getTraceConfig()
         Configures tracing, e.g. the sampler, max number of annotations, etc.
        .opencensus.proto.trace.v1.TraceConfig trace_config = 1;
        Returns:
        The traceConfig.

      • getTraceConfigOrBuilder

        TraceConfigOrBuilder getTraceConfigOrBuilder()
         Configures tracing, e.g. the sampler, max number of annotations, etc.
        .opencensus.proto.trace.v1.TraceConfig trace_config = 1;

      • getStdoutExporterEnabled

        boolean getStdoutExporterEnabled()
         Enables the stdout exporter if set to true. This is intended for debugging
 purposes.
        bool stdout_exporter_enabled = 2;
        Returns:
        The stdoutExporterEnabled.

      • getStackdriverExporterEnabled

        boolean getStackdriverExporterEnabled()
         Enables the Stackdriver exporter if set to true. The project_id must also
 be set.
        bool stackdriver_exporter_enabled = 3;
        Returns:
        The stackdriverExporterEnabled.

      • getStackdriverProjectId

        String getStackdriverProjectId()
         The Cloud project_id to use for Stackdriver tracing.
        string stackdriver_project_id = 4;
        Returns:
        The stackdriverProjectId.

      • getStackdriverProjectIdBytes

        com.google.protobuf.ByteString getStackdriverProjectIdBytes()
         The Cloud project_id to use for Stackdriver tracing.
        string stackdriver_project_id = 4;
        Returns:
        The bytes for stackdriverProjectId.

      • getStackdriverAddress

        String getStackdriverAddress()
         (optional) By default, the Stackdriver exporter will connect to production
 Stackdriver. If stackdriver_address is non-empty, it will instead connect
 to this address, which is in the gRPC format:
 https://github.com/grpc/grpc/blob/master/doc/naming.md
        string stackdriver_address = 10;
        Returns:
        The stackdriverAddress.

      • getStackdriverAddressBytes

        com.google.protobuf.ByteString getStackdriverAddressBytes()
         (optional) By default, the Stackdriver exporter will connect to production
 Stackdriver. If stackdriver_address is non-empty, it will instead connect
 to this address, which is in the gRPC format:
 https://github.com/grpc/grpc/blob/master/doc/naming.md
        string stackdriver_address = 10;
        Returns:
        The bytes for stackdriverAddress.

      • hasStackdriverGrpcService

        boolean hasStackdriverGrpcService()
         (optional) The gRPC server that hosts Stackdriver tracing service. Only
 Google gRPC is supported. If :ref:`target_uri <envoy_v3_api_field_config.core.v3.GrpcService.GoogleGrpc.target_uri>`
 is not provided, the default production Stackdriver address will be used.
        .envoy.config.core.v3.GrpcService stackdriver_grpc_service = 13;
        Returns:
        Whether the stackdriverGrpcService field is set.

      • getStackdriverGrpcService

        GrpcService getStackdriverGrpcService()
         (optional) The gRPC server that hosts Stackdriver tracing service. Only
 Google gRPC is supported. If :ref:`target_uri <envoy_v3_api_field_config.core.v3.GrpcService.GoogleGrpc.target_uri>`
 is not provided, the default production Stackdriver address will be used.
        .envoy.config.core.v3.GrpcService stackdriver_grpc_service = 13;
        Returns:
        The stackdriverGrpcService.

      • getStackdriverGrpcServiceOrBuilder

        GrpcServiceOrBuilder getStackdriverGrpcServiceOrBuilder()
         (optional) The gRPC server that hosts Stackdriver tracing service. Only
 Google gRPC is supported. If :ref:`target_uri <envoy_v3_api_field_config.core.v3.GrpcService.GoogleGrpc.target_uri>`
 is not provided, the default production Stackdriver address will be used.
        .envoy.config.core.v3.GrpcService stackdriver_grpc_service = 13;

      • getZipkinExporterEnabled

        @Deprecated
boolean getZipkinExporterEnabled()
        Deprecated.
        envoy.config.trace.v3.OpenCensusConfig.zipkin_exporter_enabled is deprecated. See envoy/config/trace/v3/opencensus.proto;l=77
         Enables the Zipkin exporter if set to true. The url and service name must
 also be set. This is deprecated, prefer to use Envoy's :ref:`native Zipkin
 tracer <envoy_v3_api_msg_config.trace.v3.ZipkinConfig>`.
        bool zipkin_exporter_enabled = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        The zipkinExporterEnabled.

      • getZipkinUrl

        @Deprecated
String getZipkinUrl()
        Deprecated.
        envoy.config.trace.v3.OpenCensusConfig.zipkin_url is deprecated. See envoy/config/trace/v3/opencensus.proto;l=83
         The URL to Zipkin, e.g. "http://127.0.0.1:9411/api/v2/spans". This is
 deprecated, prefer to use Envoy's :ref:`native Zipkin tracer
 <envoy_v3_api_msg_config.trace.v3.ZipkinConfig>`.
        string zipkin_url = 6 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        The zipkinUrl.

      • getZipkinUrlBytes

        @Deprecated
com.google.protobuf.ByteString getZipkinUrlBytes()
        Deprecated.
        envoy.config.trace.v3.OpenCensusConfig.zipkin_url is deprecated. See envoy/config/trace/v3/opencensus.proto;l=83
         The URL to Zipkin, e.g. "http://127.0.0.1:9411/api/v2/spans". This is
 deprecated, prefer to use Envoy's :ref:`native Zipkin tracer
 <envoy_v3_api_msg_config.trace.v3.ZipkinConfig>`.
        string zipkin_url = 6 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        The bytes for zipkinUrl.

      • getOcagentExporterEnabled

        boolean getOcagentExporterEnabled()
         Enables the OpenCensus Agent exporter if set to true. The ocagent_address or
 ocagent_grpc_service must also be set.
        bool ocagent_exporter_enabled = 11;
        Returns:
        The ocagentExporterEnabled.

      • getOcagentAddress

        String getOcagentAddress()
         The address of the OpenCensus Agent, if its exporter is enabled, in gRPC
 format: https://github.com/grpc/grpc/blob/master/doc/naming.md
 [#comment:TODO: deprecate this field]
        string ocagent_address = 12;
        Returns:
        The ocagentAddress.

      • getOcagentAddressBytes

        com.google.protobuf.ByteString getOcagentAddressBytes()
         The address of the OpenCensus Agent, if its exporter is enabled, in gRPC
 format: https://github.com/grpc/grpc/blob/master/doc/naming.md
 [#comment:TODO: deprecate this field]
        string ocagent_address = 12;
        Returns:
        The bytes for ocagentAddress.

      • hasOcagentGrpcService

        boolean hasOcagentGrpcService()
         (optional) The gRPC server hosted by the OpenCensus Agent. Only Google gRPC is supported.
 This is only used if the ocagent_address is left empty.
        .envoy.config.core.v3.GrpcService ocagent_grpc_service = 14;
        Returns:
        Whether the ocagentGrpcService field is set.

      • getOcagentGrpcService

        GrpcService getOcagentGrpcService()
         (optional) The gRPC server hosted by the OpenCensus Agent. Only Google gRPC is supported.
 This is only used if the ocagent_address is left empty.
        .envoy.config.core.v3.GrpcService ocagent_grpc_service = 14;
        Returns:
        The ocagentGrpcService.

      • getOcagentGrpcServiceOrBuilder

        GrpcServiceOrBuilder getOcagentGrpcServiceOrBuilder()
         (optional) The gRPC server hosted by the OpenCensus Agent. Only Google gRPC is supported.
 This is only used if the ocagent_address is left empty.
        .envoy.config.core.v3.GrpcService ocagent_grpc_service = 14;

      • getIncomingTraceContextList

        List<OpenCensusConfig.TraceContext> getIncomingTraceContextList()
         List of incoming trace context headers we will accept. First one found
 wins.
        repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext incoming_trace_context = 8;
        Returns:
        A list containing the incomingTraceContext.

      • getIncomingTraceContextCount

        int getIncomingTraceContextCount()
         List of incoming trace context headers we will accept. First one found
 wins.
        repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext incoming_trace_context = 8;
        Returns:
        The count of incomingTraceContext.

      • getIncomingTraceContext

        OpenCensusConfig.TraceContext getIncomingTraceContext​(int index)
         List of incoming trace context headers we will accept. First one found
 wins.
        repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext incoming_trace_context = 8;
        Parameters:
        index - The index of the element to return.
        Returns:
        The incomingTraceContext at the given index.

      • getIncomingTraceContextValueList

        List<Integer> getIncomingTraceContextValueList()
         List of incoming trace context headers we will accept. First one found
 wins.
        repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext incoming_trace_context = 8;
        Returns:
        A list containing the enum numeric values on the wire for incomingTraceContext.

      • getIncomingTraceContextValue

        int getIncomingTraceContextValue​(int index)
         List of incoming trace context headers we will accept. First one found
 wins.
        repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext incoming_trace_context = 8;
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of incomingTraceContext at the given index.

      • getOutgoingTraceContextList

        List<OpenCensusConfig.TraceContext> getOutgoingTraceContextList()
         List of outgoing trace context headers we will produce.
        repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext outgoing_trace_context = 9;
        Returns:
        A list containing the outgoingTraceContext.

      • getOutgoingTraceContextCount

        int getOutgoingTraceContextCount()
         List of outgoing trace context headers we will produce.
        repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext outgoing_trace_context = 9;
        Returns:
        The count of outgoingTraceContext.

      • getOutgoingTraceContext

        OpenCensusConfig.TraceContext getOutgoingTraceContext​(int index)
         List of outgoing trace context headers we will produce.
        repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext outgoing_trace_context = 9;
        Parameters:
        index - The index of the element to return.
        Returns:
        The outgoingTraceContext at the given index.

      • getOutgoingTraceContextValueList

        List<Integer> getOutgoingTraceContextValueList()
         List of outgoing trace context headers we will produce.
        repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext outgoing_trace_context = 9;
        Returns:
        A list containing the enum numeric values on the wire for outgoingTraceContext.

      • getOutgoingTraceContextValue

        int getOutgoingTraceContextValue​(int index)
         List of outgoing trace context headers we will produce.
        repeated .envoy.config.trace.v3.OpenCensusConfig.TraceContext outgoing_trace_context = 9;
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of outgoingTraceContext at the given index.