fc::zipkin_config Class Reference

#include <zipkin.hpp>

Static Public Member Functions
static bool	is_enabled ()
	Thread safe only if init() called from main thread before spawning of any threads.
static void	init (const std::string &url, const std::string &service_name, uint32_t timeout_us)
static zipkin &	get_zipkin ()
static void	shutdown ()
static uint64_t	get_next_unique_id ()
	Starts with a random id and increments on each call, will not return 0.

Detailed Description

Definition at line 26 of file zipkin.hpp.

Member Function Documentation

get_next_unique_id()

uint64_t fc::zipkin_config::get_next_unique_id ( )

static

Definition at line 39 of file zipkin.cpp.

                                           {
   if( !get().zip ) {
      FC_THROW_EXCEPTION( fc::assert_exception, "uninitialized zipkin" );
   }
   return get().zip->get_next_unique_id();
}

Here is the call graph for this function:

get_zipkin()

zipkin & fc::zipkin_config::get_zipkin ( )

static

Thread safe only if init() called from main thread before spawning of any threads

Exceptions

assert_exception

if called before init()

Definition at line 26 of file zipkin.cpp.

                                  {
   if( !get().zip ) {
      FC_THROW_EXCEPTION( fc::assert_exception, "uninitialized zipkin" );
   }
   return *get().zip;
}

Here is the caller graph for this function:

init()

void fc::zipkin_config::init ( const std::string & url, const std::string & service_name, uint32_t timeout_us )

static

Not thread safe, call from main thread before spawning any threads that might use zipkin.

Parameters

url	the url endpoint of zipkin server. e.g. http://127.0.0.1:9411/api/v2/spans
service_name	the service name to include in each zipkin span
timeout_us	the timeout in microseconds for each http call (9 consecutive failures and zipkin is disabled)

Definition at line 22 of file zipkin.cpp.

                                                                                                   {
   get().zip = std::make_unique<zipkin>( url, service_name, timeout_us );
}

is_enabled()

static bool fc::zipkin_config::is_enabled ( )

inlinestatic

Definition at line 29 of file zipkin.hpp.

{ return get_zipkin_() != nullptr; }

Here is the caller graph for this function:

shutdown()

void fc::zipkin_config::shutdown ( )

static

Thread safe only if init() called from main thread before spawning of any threads

Exceptions

assert_exception

if called before init()

Definition at line 33 of file zipkin.cpp.

                             {
   if( zipkin* z = get_zipkin_() ) {
      z->shutdown();
   }
}

---

The documentation for this class was generated from the following files:

• libraries/fc/include/fc/log/zipkin.hpp
• libraries/fc/src/log/zipkin.cpp