Class ZipkinConfig
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessage
-
- io.envoyproxy.envoy.config.trace.v3.ZipkinConfig
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,ZipkinConfigOrBuilder
,java.io.Serializable
public final class ZipkinConfig extends com.google.protobuf.GeneratedMessage implements ZipkinConfigOrBuilder
Configuration for the Zipkin tracer. [#extension: envoy.tracers.zipkin] [#next-free-field: 8]
Protobuf typeenvoy.config.trace.v3.ZipkinConfig
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ZipkinConfig.Builder
Configuration for the Zipkin tracer.static class
ZipkinConfig.CollectorEndpointVersion
Available Zipkin collector endpoint versions.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description private int
bitField0_
static int
COLLECTOR_CLUSTER_FIELD_NUMBER
static int
COLLECTOR_ENDPOINT_FIELD_NUMBER
static int
COLLECTOR_ENDPOINT_VERSION_FIELD_NUMBER
static int
COLLECTOR_HOSTNAME_FIELD_NUMBER
private java.lang.Object
collectorCluster_
private java.lang.Object
collectorEndpoint_
private int
collectorEndpointVersion_
private java.lang.Object
collectorHostname_
private static ZipkinConfig
DEFAULT_INSTANCE
private byte
memoizedIsInitialized
private static com.google.protobuf.Parser<ZipkinConfig>
PARSER
private static long
serialVersionUID
static int
SHARED_SPAN_CONTEXT_FIELD_NUMBER
private com.google.protobuf.BoolValue
sharedSpanContext_
static int
SPLIT_SPANS_FOR_REQUEST_FIELD_NUMBER
private boolean
splitSpansForRequest_
static int
TRACE_ID_128BIT_FIELD_NUMBER
private boolean
traceId128Bit_
-
Constructor Summary
Constructors Modifier Constructor Description private
ZipkinConfig()
private
ZipkinConfig(com.google.protobuf.GeneratedMessage.Builder<?> builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.String
getCollectorCluster()
The cluster manager cluster that hosts the Zipkin collectors.com.google.protobuf.ByteString
getCollectorClusterBytes()
The cluster manager cluster that hosts the Zipkin collectors.java.lang.String
getCollectorEndpoint()
The API endpoint of the Zipkin service where the spans will be sent.com.google.protobuf.ByteString
getCollectorEndpointBytes()
The API endpoint of the Zipkin service where the spans will be sent.ZipkinConfig.CollectorEndpointVersion
getCollectorEndpointVersion()
Determines the selected collector endpoint version.int
getCollectorEndpointVersionValue()
Determines the selected collector endpoint version.java.lang.String
getCollectorHostname()
Optional hostname to use when sending spans to the collector_cluster.com.google.protobuf.ByteString
getCollectorHostnameBytes()
Optional hostname to use when sending spans to the collector_cluster.static ZipkinConfig
getDefaultInstance()
ZipkinConfig
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Parser<ZipkinConfig>
getParserForType()
int
getSerializedSize()
com.google.protobuf.BoolValue
getSharedSpanContext()
Determines whether client and server spans will share the same span context.com.google.protobuf.BoolValueOrBuilder
getSharedSpanContextOrBuilder()
Determines whether client and server spans will share the same span context.boolean
getSplitSpansForRequest()
Deprecated.envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated.boolean
getTraceId128Bit()
Determines whether a 128bit trace id will be used when creating a new trace instance.int
hashCode()
boolean
hasSharedSpanContext()
Determines whether client and server spans will share the same span context.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static ZipkinConfig.Builder
newBuilder()
static ZipkinConfig.Builder
newBuilder(ZipkinConfig prototype)
ZipkinConfig.Builder
newBuilderForType()
protected ZipkinConfig.Builder
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static ZipkinConfig
parseDelimitedFrom(java.io.InputStream input)
static ZipkinConfig
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ZipkinConfig
parseFrom(byte[] data)
static ZipkinConfig
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ZipkinConfig
parseFrom(com.google.protobuf.ByteString data)
static ZipkinConfig
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ZipkinConfig
parseFrom(com.google.protobuf.CodedInputStream input)
static ZipkinConfig
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ZipkinConfig
parseFrom(java.io.InputStream input)
static ZipkinConfig
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ZipkinConfig
parseFrom(java.nio.ByteBuffer data)
static ZipkinConfig
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ZipkinConfig>
parser()
ZipkinConfig.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
bitField0_
private int bitField0_
-
COLLECTOR_CLUSTER_FIELD_NUMBER
public static final int COLLECTOR_CLUSTER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
collectorCluster_
private volatile java.lang.Object collectorCluster_
-
COLLECTOR_ENDPOINT_FIELD_NUMBER
public static final int COLLECTOR_ENDPOINT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
collectorEndpoint_
private volatile java.lang.Object collectorEndpoint_
-
TRACE_ID_128BIT_FIELD_NUMBER
public static final int TRACE_ID_128BIT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
traceId128Bit_
private boolean traceId128Bit_
-
SHARED_SPAN_CONTEXT_FIELD_NUMBER
public static final int SHARED_SPAN_CONTEXT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
sharedSpanContext_
private com.google.protobuf.BoolValue sharedSpanContext_
-
COLLECTOR_ENDPOINT_VERSION_FIELD_NUMBER
public static final int COLLECTOR_ENDPOINT_VERSION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
collectorEndpointVersion_
private int collectorEndpointVersion_
-
COLLECTOR_HOSTNAME_FIELD_NUMBER
public static final int COLLECTOR_HOSTNAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
collectorHostname_
private volatile java.lang.Object collectorHostname_
-
SPLIT_SPANS_FOR_REQUEST_FIELD_NUMBER
public static final int SPLIT_SPANS_FOR_REQUEST_FIELD_NUMBER
- See Also:
- Constant Field Values
-
splitSpansForRequest_
private boolean splitSpansForRequest_
-
memoizedIsInitialized
private byte memoizedIsInitialized
-
DEFAULT_INSTANCE
private static final ZipkinConfig DEFAULT_INSTANCE
-
PARSER
private static final com.google.protobuf.Parser<ZipkinConfig> PARSER
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
getCollectorCluster
public java.lang.String getCollectorCluster()
The cluster manager cluster that hosts the Zipkin collectors.
string collector_cluster = 1 [(.validate.rules) = { ... }
- Specified by:
getCollectorCluster
in interfaceZipkinConfigOrBuilder
- Returns:
- The collectorCluster.
-
getCollectorClusterBytes
public com.google.protobuf.ByteString getCollectorClusterBytes()
The cluster manager cluster that hosts the Zipkin collectors.
string collector_cluster = 1 [(.validate.rules) = { ... }
- Specified by:
getCollectorClusterBytes
in interfaceZipkinConfigOrBuilder
- Returns:
- The bytes for collectorCluster.
-
getCollectorEndpoint
public 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) = { ... }
- Specified by:
getCollectorEndpoint
in interfaceZipkinConfigOrBuilder
- Returns:
- The collectorEndpoint.
-
getCollectorEndpointBytes
public com.google.protobuf.ByteString getCollectorEndpointBytes()
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) = { ... }
- Specified by:
getCollectorEndpointBytes
in interfaceZipkinConfigOrBuilder
- Returns:
- The bytes for collectorEndpoint.
-
getTraceId128Bit
public boolean getTraceId128Bit()
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;
- Specified by:
getTraceId128Bit
in interfaceZipkinConfigOrBuilder
- Returns:
- The traceId128bit.
-
hasSharedSpanContext
public 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;
- Specified by:
hasSharedSpanContext
in interfaceZipkinConfigOrBuilder
- Returns:
- Whether the sharedSpanContext field is set.
-
getSharedSpanContext
public 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;
- Specified by:
getSharedSpanContext
in interfaceZipkinConfigOrBuilder
- Returns:
- The sharedSpanContext.
-
getSharedSpanContextOrBuilder
public com.google.protobuf.BoolValueOrBuilder getSharedSpanContextOrBuilder()
Determines whether client and server spans will share the same span context. The default value is true.
.google.protobuf.BoolValue shared_span_context = 4;
- Specified by:
getSharedSpanContextOrBuilder
in interfaceZipkinConfigOrBuilder
-
getCollectorEndpointVersionValue
public int getCollectorEndpointVersionValue()
Determines the selected collector endpoint version.
.envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;
- Specified by:
getCollectorEndpointVersionValue
in interfaceZipkinConfigOrBuilder
- Returns:
- The enum numeric value on the wire for collectorEndpointVersion.
-
getCollectorEndpointVersion
public ZipkinConfig.CollectorEndpointVersion getCollectorEndpointVersion()
Determines the selected collector endpoint version.
.envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;
- Specified by:
getCollectorEndpointVersion
in interfaceZipkinConfigOrBuilder
- Returns:
- The collectorEndpointVersion.
-
getCollectorHostname
public 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;
- Specified by:
getCollectorHostname
in interfaceZipkinConfigOrBuilder
- Returns:
- The collectorHostname.
-
getCollectorHostnameBytes
public com.google.protobuf.ByteString getCollectorHostnameBytes()
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;
- Specified by:
getCollectorHostnameBytes
in interfaceZipkinConfigOrBuilder
- Returns:
- The bytes for collectorHostname.
-
getSplitSpansForRequest
@Deprecated public boolean getSplitSpansForRequest()
Deprecated.envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated. See envoy/config/trace/v3/zipkin.proto;l=88If 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"];
- Specified by:
getSplitSpansForRequest
in interfaceZipkinConfigOrBuilder
- Returns:
- The splitSpansForRequest.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ZipkinConfig parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ZipkinConfig parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ZipkinConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ZipkinConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ZipkinConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ZipkinConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ZipkinConfig parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static ZipkinConfig parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static ZipkinConfig parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static ZipkinConfig parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static ZipkinConfig parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static ZipkinConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public ZipkinConfig.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static ZipkinConfig.Builder newBuilder()
-
newBuilder
public static ZipkinConfig.Builder newBuilder(ZipkinConfig prototype)
-
toBuilder
public ZipkinConfig.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ZipkinConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
- Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
public static ZipkinConfig getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<ZipkinConfig> parser()
-
getParserForType
public com.google.protobuf.Parser<ZipkinConfig> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
public ZipkinConfig getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-