span.hpp

Go to the documentation of this file.

#pragma once
 
 
#include <optional>
#include <string_view>
 
#include <userver/logging/log.hpp>
#include <userver/logging/log_extra.hpp>
#include <userver/tracing/scope_time.hpp>
#include <userver/tracing/tracer_fwd.hpp>
#include <userver/utils/impl/source_location.hpp>
#include <userver/utils/internal_tag_fwd.hpp>
 
USERVER_NAMESPACE_BEGIN
 
namespace tracing {
 
class Span final {
 public:
  class Impl;
 
  explicit Span(TracerPtr tracer, std::string name, const Span* parent,
                ReferenceType reference_type,
                logging::Level log_level = logging::Level::kInfo,
                utils::impl::SourceLocation source_location =
                    utils::impl::SourceLocation::Current());
 
  /* Use default tracer and implicit coro local storage for parent
   * identification */
  explicit Span(std::string name,
                ReferenceType reference_type = ReferenceType::kChild,
                logging::Level log_level = logging::Level::kInfo,
                utils::impl::SourceLocation source_location =
                    utils::impl::SourceLocation::Current());
 
  // For internal use only
  explicit Span(Span::Impl& impl);
 
  Span(Span&& other) noexcept;
 
  ~Span();
 
  Span& operator=(const Span&) = delete;
 
  Span& operator=(Span&&) = delete;
 
  static Span& CurrentSpan();
 
  static Span* CurrentSpanUnchecked();
 
  static Span MakeSpan(std::string name, std::string_view trace_id,
                       std::string_view parent_span_id);
 
  static Span MakeSpan(std::string name, std::string_view trace_id,
                       std::string_view parent_span_id, std::string link);
 
  Span CreateChild(std::string name) const;
 
  Span CreateFollower(std::string name) const;
 
  ScopeTime CreateScopeTime();
 
  ScopeTime CreateScopeTime(std::string name);
 
  ScopeTime::Duration GetTotalDuration(const std::string& scope_name) const;
 
  ScopeTime::DurationMillis GetTotalElapsedTime(
      const std::string& scope_name) const;
 
  void AddTag(std::string key, logging::LogExtra::Value value);
 
  void AddTagFrozen(std::string key, logging::LogExtra::Value value);
 
  void AddNonInheritableTag(std::string key, logging::LogExtra::Value value);
 
  void SetLogLevel(logging::Level log_level);
 
  logging::Level GetLogLevel() const;
 
  void SetLocalLogLevel(std::optional<logging::Level> log_level);
 
  std::optional<logging::Level> GetLocalLogLevel() const;
 
  void SetLink(std::string link);
 
  void SetParentLink(std::string parent_link);
 
  std::string GetLink() const;
 
  std::string GetParentLink() const;
 
  const std::string& GetTraceId() const;
  const std::string& GetSpanId() const;
  const std::string& GetParentId() const;
 
  void LogTo(logging::LogHelper& log_helper) const&;
 
  bool ShouldLogDefault() const noexcept;
 
  void DetachFromCoroStack();
 
  void AttachToCoroStack();
 
  void AddTags(const logging::LogExtra&, utils::InternalTag);
 
  impl::TimeStorage& GetTimeStorage();
 
 private:
  std::string GetTag(std::string_view tag) const;
 
  struct OptionalDeleter {
    void operator()(Impl*) const noexcept;
 
    static OptionalDeleter ShouldDelete() noexcept;
 
    static OptionalDeleter DoNotDelete() noexcept;
 
   private:
    explicit OptionalDeleter(bool do_delete) : do_delete(do_delete) {}
 
    const bool do_delete;
  };
 
  std::unique_ptr<Impl, OptionalDeleter> pimpl_;
};
 
logging::LogHelper& operator<<(logging::LogHelper& lh, const Span& span);
 
}  // namespace tracing
 
USERVER_NAMESPACE_END