xref: /aosp_15_r20/external/federated-compute/fcp/tracing/tracing_span_ref.h (revision 14675a029014e728ec732f129a32e299b2da0601)
1 // Copyright 2019 Google LLC
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 //      http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef FCP_TRACING_TRACING_SPAN_REF_H_
16 #define FCP_TRACING_TRACING_SPAN_REF_H_
17 
18 #include <memory>
19 #include <utility>
20 
21 #include "fcp/tracing/tracing_span_id.h"
22 
23 namespace fcp {
24 
25 namespace tracing_internal {
26 class TracingRecorderImpl;
27 }
28 
29 // Reference to a tracing span.
30 class TracingSpanRef {
31   // Reference to the tracing recorder this reference was issued by:
32   std::shared_ptr<fcp::tracing_internal::TracingRecorderImpl> recorder_;
33   // Identifier of the span
34   TracingSpanId span_id_;
35 
36  public:
TracingSpanRef(std::shared_ptr<fcp::tracing_internal::TracingRecorderImpl> provider,TracingSpanId span_id)37   TracingSpanRef(
38       std::shared_ptr<fcp::tracing_internal::TracingRecorderImpl> provider,
39       TracingSpanId span_id)
40       : recorder_(std::move(provider)), span_id_(span_id) {}
41 
recorder()42   std::shared_ptr<tracing_internal::TracingRecorderImpl> recorder() {
43     return recorder_;
44   }
45 
span_id()46   TracingSpanId span_id() const { return span_id_; }
47 
48   // Returns reference to the top tracing span on the current
49   // thread/fiber. If there's no tracing span established, a
50   // reference to the root span of global tracing recorder is returned.
51   static TracingSpanRef Top();
52 };
53 
54 }  // namespace fcp
55 #endif  // FCP_TRACING_TRACING_SPAN_REF_H_
56