org.springframework.cloud.sleuth

Class TraceKeys

java.lang.Object

org.springframework.cloud.sleuth.TraceKeys

@ConfigurationProperties(value="spring.sleuth.keys")
public class TraceKeys
extends Object

Well-known span tag keys.

Overhead of adding Trace Data

Overhead is directly related to the size of trace data exported out of process. Accordingly, it is better to tag what's important for latency troubleshooting, i.e. a whitelist vs. collecting everything and filtering downstream. The keys listed here are very common in tracing tools, and are considerate to the issue of overhead.

When evaluating new keys, consider how much additional data it implies, and if that data is critical to classifying, filtering or displaying traces. More data often means larger systems, less retention, or a lower sample rate.

For example, in zipkin, a thrift-encoded span with an "sr" annotation is 82 bytes plus the size of its name and associated service. The maximum size of an HTTP cookie is 4096 bytes, roughly 50x that. Even if compression helps, if you aren't analyzing based on cookies, storing them displaces resources that could be used for more traces. Meanwhile, you have another system storing private data! The takeaway isn't never store cookies, as there are valid cases for this. The takeaway is to be conscious about what's you are storing.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TraceKeys.Async Trace keys related to async processing
static class	TraceKeys.Http
static class	TraceKeys.Hystrix Trace keys related to Hystrix processing
static class	TraceKeys.Message
static class	TraceKeys.Mvc Trace keys related to MVC controller tags

Constructor Summary

Constructors

Constructor and Description
TraceKeys()

Method Summary

Modifier and Type	Method and Description
TraceKeys.Async	getAsync()
TraceKeys.Http	getHttp()
TraceKeys.Hystrix	getHystrix()
TraceKeys.Message	getMessage()
TraceKeys.Mvc	getMvc()
void	setAsync(TraceKeys.Async async)
void	setHttp(TraceKeys.Http http)
void	setHystrix(TraceKeys.Hystrix hystrix)
void	setMessage(TraceKeys.Message message)
void	setMvc(TraceKeys.Mvc mvc)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TraceKeys

public TraceKeys()

Method Detail

getHttp

public TraceKeys.Http getHttp()

getMessage

public TraceKeys.Message getMessage()

getHystrix

public TraceKeys.Hystrix getHystrix()

getAsync

public TraceKeys.Async getAsync()

getMvc

public TraceKeys.Mvc getMvc()

setHttp

public void setHttp(TraceKeys.Http http)

setMessage

public void setMessage(TraceKeys.Message message)

setHystrix

public void setHystrix(TraceKeys.Hystrix hystrix)

setAsync

public void setAsync(TraceKeys.Async async)

setMvc

public void setMvc(TraceKeys.Mvc mvc)