1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
// Copyright 2017 Palantir Technologies, Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. //! Trace contexts. use {SamplingFlags, SpanId, TraceId}; use sampling_flags; /// A `TraceContext` represents a distributed trace request. /// /// It consists of a trace ID, the ID of the parent span, the ID of the /// context's span, and flags dealing with the sampling of the span. /// /// The trace context is sent to remote services on requests. For example, /// it is included in a standard set of headers in HTTP requests. #[derive(Copy, Clone)] pub struct TraceContext { trace_id: TraceId, parent_id: Option<SpanId>, span_id: SpanId, pub(crate) flags: SamplingFlags, } impl TraceContext { /// Returns a builder used to construct a `TraceContext`. pub fn builder() -> Builder { Builder { parent_id: None, flags: SamplingFlags::builder(), } } /// Returns the ID of the trace associated with this context. pub fn trace_id(&self) -> TraceId { self.trace_id } /// Returns the ID of the parent of the span associated with this context. pub fn parent_id(&self) -> Option<SpanId> { self.parent_id } /// Returns the ID of the span associated with this context. pub fn span_id(&self) -> SpanId { self.span_id } /// Returns the sampling flags associated with this context. pub fn sampling_flags(&self) -> SamplingFlags { self.flags } /// Determines if sampling has been requested for this context. /// /// A value of `None` indicates that the service working in the context is /// responsible for determining if it should be sampled. pub fn sampled(&self) -> Option<bool> { self.flags.sampled() } /// Determines if this context is in debug mode. /// /// Debug contexts should always be sampled, regardless of the value of /// `sampled()`. pub fn debug(&self) -> bool { self.flags.debug() } } /// A builder type for `TraceContext`s. pub struct Builder { parent_id: Option<SpanId>, flags: sampling_flags::Builder, } impl Builder { /// Sets the ID of the parent span of this context. /// /// Defaults to `None`. pub fn parent_id(&mut self, parent_id: SpanId) -> &mut Builder { self.parent_id = Some(parent_id); self } /// Sets the sampling flags for this context. pub fn sampling_flags(&mut self, flags: SamplingFlags) -> &mut Builder { self.flags = flags.into(); self } /// Sets the sampling request for this context. /// /// Defaults to `None`. pub fn sampled(&mut self, sampled: bool) -> &mut Builder { self.flags.sampled(sampled); self } /// Sets the debug flag for this request. /// /// Defaults to `false`. pub fn debug(&mut self, debug: bool) -> &mut Builder { self.flags.debug(debug); self } /// Constructs a `TraceContext`. pub fn build(&self, trace_id: TraceId, span_id: SpanId) -> TraceContext { TraceContext { trace_id, parent_id: self.parent_id, span_id, flags: self.flags.build(), } } }