Trace span representing a unit of work in distributed tracing. More...

#include <distributed_tracer.h>

Collaboration diagram for kcenon::monitoring::trace_span:

Public Types
enum class	status_code { unset , ok , error }

Public Member Functions
bool	is_finished () const
	Check if span has finished.

void	calculate_duration ()
	Calculate duration if span is finished.

Public Attributes
std::string	trace_id

std::string	span_id

std::string	parent_span_id

std::string	operation_name

std::string	service_name

std::chrono::system_clock::time_point	start_time

std::chrono::system_clock::time_point	end_time

std::chrono::microseconds	duration {0}

std::unordered_map< std::string, std::string >	tags

std::unordered_map< std::string, std::string >	baggage

status_code	status {status_code::unset}

std::string	status_message

Detailed Description

Trace span representing a unit of work in distributed tracing.

Examples: multi_service_tracing_example.cpp, and otlp_export_example.cpp.

Definition at line 48 of file distributed_tracer.h.

Member Enumeration Documentation

◆ status_code

enum class kcenon::monitoring::trace_span::status_code

strong

Enumerator
unset
ok
error

Definition at line 65 of file distributed_tracer.h.

                           {
        unset,
        ok,
        error
    };

Member Function Documentation

◆ calculate_duration()

void kcenon::monitoring::trace_span::calculate_duration ( )

inline

Calculate duration if span is finished.

Examples: multi_service_tracing_example.cpp, and otlp_export_example.cpp.

Definition at line 83 of file distributed_tracer.h.

                              {
        if (is_finished()) {
            duration = std::chrono::duration_cast<std::chrono::microseconds>(
                end_time - start_time
            );
        }
    }

References duration, end_time, is_finished(), and start_time.

Referenced by CacheService::cache_lookup(), create_sample_spans(), demonstrate_batch_export(), UserService::get_user_profile(), and AuthService::verify_token().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_finished()

bool kcenon::monitoring::trace_span::is_finished ( ) const

inline

Check if span has finished.

Definition at line 76 of file distributed_tracer.h.

                             {
        return end_time != std::chrono::system_clock::time_point{};
    }

References end_time.

Referenced by calculate_duration(), and TEST_F().

Here is the caller graph for this function:

Member Data Documentation

◆ baggage

std::unordered_map<std::string, std::string> kcenon::monitoring::trace_span::baggage

Examples: multi_service_tracing_example.cpp.

Definition at line 62 of file distributed_tracer.h.

Referenced by CacheService::cache_lookup(), ApiGatewayService::create_context(), UserService::get_user_profile(), ApiGatewayService::handle_request(), AuthService::verify_token(), and kcenon::monitoring::span_builder::with_baggage().

◆ duration

std::chrono::microseconds kcenon::monitoring::trace_span::duration {0}

Examples: multi_service_tracing_example.cpp.

Definition at line 58 of file distributed_tracer.h.

58{0};

Referenced by CacheService::cache_lookup(), calculate_duration(), display_span(), display_trace_tree(), UserService::get_user_profile(), and AuthService::verify_token().

◆ end_time

std::chrono::system_clock::time_point kcenon::monitoring::trace_span::end_time

◆ operation_name

std::string kcenon::monitoring::trace_span::operation_name

◆ parent_span_id

std::string kcenon::monitoring::trace_span::parent_span_id

Examples: multi_service_tracing_example.cpp, and otlp_export_example.cpp.

Definition at line 51 of file distributed_tracer.h.

Referenced by kcenon::monitoring::otlp_span_converter::build_span(), CacheService::cache_lookup(), kcenon::monitoring::jaeger_exporter::convert_span(), kcenon::monitoring::opentelemetry_tracer_adapter::convert_span(), kcenon::monitoring::zipkin_exporter::convert_span(), create_sample_spans(), TraceExportersTest::create_test_spans(), UserService::get_user_profile(), TEST_F(), AuthService::verify_token(), and kcenon::monitoring::span_builder::with_parent().

◆ service_name

std::string kcenon::monitoring::trace_span::service_name

Examples: multi_service_tracing_example.cpp, and otlp_export_example.cpp.

Definition at line 53 of file distributed_tracer.h.

Referenced by CacheService::cache_lookup(), kcenon::monitoring::jaeger_exporter::convert_span(), kcenon::monitoring::zipkin_exporter::convert_span(), create_sample_spans(), TraceExportersTest::create_test_spans(), demonstrate_batch_export(), display_span(), UserService::get_user_profile(), ApiGatewayService::handle_request(), TEST_F(), AuthService::verify_token(), and kcenon::monitoring::span_builder::with_service().

◆ span_id

std::string kcenon::monitoring::trace_span::span_id

◆ start_time

std::chrono::system_clock::time_point kcenon::monitoring::trace_span::start_time

◆ status

status_code kcenon::monitoring::trace_span::status {status_code::unset}

Examples: multi_service_tracing_example.cpp, and otlp_export_example.cpp.

Definition at line 70 of file distributed_tracer.h.

70{status_code::unset};

Referenced by CacheService::cache_lookup(), create_sample_spans(), demonstrate_batch_export(), UserService::get_user_profile(), and AuthService::verify_token().

◆ status_message

std::string kcenon::monitoring::trace_span::status_message

Definition at line 71 of file distributed_tracer.h.

◆ tags

std::unordered_map<std::string, std::string> kcenon::monitoring::trace_span::tags

◆ trace_id

std::string kcenon::monitoring::trace_span::trace_id

The documentation for this struct was generated from the following file:

include/kcenon/monitoring/tracing/distributed_tracer.h

Public Types

Public Member Functions

Public Attributes