Package brave.rpc

Class RpcRuleSampler

java.lang.Object

brave.rpc.RpcRuleSampler

All Implemented Interfaces:

SamplerFunction<RpcRequest>

public final class RpcRuleSampler
extends Object
implements SamplerFunction<RpcRequest>

Assigns sample rates to RPC requests.

Ex. Here's a sampler that traces 100 "Report" requests per second. This doesn't start new traces for requests to the scribe service. Other requests will use a global rate provided by the tracing component.

 import static brave.rpc.RpcRequestMatchers.*;

 rpcTracingBuilder.serverSampler(RpcRuleSampler.newBuilder()
   .putRule(serviceEquals("scribe"), Sampler.NEVER_SAMPLE)
   .putRule(methodEquals("Report"), RateLimitingSampler.create(100))
   .build());
 

Implementation notes

Be careful when implementing matchers as RpcRequest methods can return null.

Since:

5.8

See Also:

RpcRequestMatchers

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RpcRuleSampler.Builder

Method Summary

Modifier and Type	Method	Description
static RpcRuleSampler.Builder	newBuilder()
Boolean	trySample(RpcRequest request)

Methods inherited from class java.lang.Object

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

Method Details

newBuilder

public static RpcRuleSampler.Builder newBuilder()

Since:

5.8

trySample

public Boolean trySample(RpcRequest request)

Specified by:

trySample in interface SamplerFunction<RpcRequest>