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
,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 type
envoy.config.trace.v3.ZipkinConfig
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Configuration for the Zipkin tracer.static enum
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>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
static final int
static final int
static final int
static final int
private Object
private Object
private int
private Object
private static final ZipkinConfig
private byte
private static final com.google.protobuf.Parser
<ZipkinConfig> private static final long
static final int
private com.google.protobuf.BoolValue
static final int
private boolean
static final int
private boolean
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
ZipkinConfig
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
The cluster manager cluster that hosts the Zipkin collectors.com.google.protobuf.ByteString
The cluster manager cluster that hosts the Zipkin collectors.The API endpoint of the Zipkin service where the spans will be sent.com.google.protobuf.ByteString
The API endpoint of the Zipkin service where the spans will be sent.Determines the selected collector endpoint version.int
Determines the selected collector endpoint version.Optional hostname to use when sending spans to the collector_cluster.com.google.protobuf.ByteString
Optional hostname to use when sending spans to the collector_cluster.static ZipkinConfig
static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Parser
<ZipkinConfig> int
com.google.protobuf.BoolValue
Determines whether client and server spans will share the same span context.com.google.protobuf.BoolValueOrBuilder
Determines whether client and server spans will share the same span context.boolean
Deprecated.envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated.boolean
Determines whether a 128bit trace id will be used when creating a new trace instance.int
hashCode()
boolean
Determines whether client and server spans will share the same span context.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static ZipkinConfig.Builder
static ZipkinConfig.Builder
newBuilder
(ZipkinConfig prototype) protected ZipkinConfig.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static ZipkinConfig
parseDelimitedFrom
(InputStream input) static ZipkinConfig
parseDelimitedFrom
(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
(InputStream input) static ZipkinConfig
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ZipkinConfig
parseFrom
(ByteBuffer data) static ZipkinConfig
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<ZipkinConfig> parser()
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
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
COLLECTOR_CLUSTER_FIELD_NUMBER
public static final int COLLECTOR_CLUSTER_FIELD_NUMBER- See Also:
-
collectorCluster_
-
COLLECTOR_ENDPOINT_FIELD_NUMBER
public static final int COLLECTOR_ENDPOINT_FIELD_NUMBER- See Also:
-
collectorEndpoint_
-
TRACE_ID_128BIT_FIELD_NUMBER
public static final int TRACE_ID_128BIT_FIELD_NUMBER- See Also:
-
traceId128Bit_
private boolean traceId128Bit_ -
SHARED_SPAN_CONTEXT_FIELD_NUMBER
public static final int SHARED_SPAN_CONTEXT_FIELD_NUMBER- See Also:
-
COLLECTOR_ENDPOINT_VERSION_FIELD_NUMBER
public static final int COLLECTOR_ENDPOINT_VERSION_FIELD_NUMBER- See Also:
-
collectorEndpointVersion_
private int collectorEndpointVersion_ -
COLLECTOR_HOSTNAME_FIELD_NUMBER
public static final int COLLECTOR_HOSTNAME_FIELD_NUMBER- See Also:
-
collectorHostname_
-
SPLIT_SPANS_FOR_REQUEST_FIELD_NUMBER
public static final int SPLIT_SPANS_FOR_REQUEST_FIELD_NUMBER- See Also:
-
splitSpansForRequest_
private boolean splitSpansForRequest_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
ZipkinConfig
private ZipkinConfig(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
ZipkinConfig
private ZipkinConfig()
-
-
Method Details
-
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
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
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.
-
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
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
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.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
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- 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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ZipkinConfig parseFrom(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
- Throws:
IOException
-
parseFrom
public static ZipkinConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ZipkinConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static ZipkinConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
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
-
parser
-
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
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-