span.h

Go to the documentation of this file.

#ifndef OPENTRACINGC_SPAN_H
#define OPENTRACINGC_SPAN_H

#include <opentracing-c/config.h>
#include <opentracing-c/destructible.h>
#include <opentracing-c/value.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

typedef struct opentracing_span_context {
    opentracing_destructible base;

    void (*foreach_baggage_item)(struct opentracing_span_context* span_context,
                                 opentracing_bool (*f)(void* arg,
                                                       const char* key,
                                                       const char* value),
                                 void* arg);

    const void* type_descriptor;

    unsigned int type_descriptor_length;
} opentracing_span_context;

typedef struct opentracing_log_field {
    const char* key;
    opentracing_value value;
} opentracing_log_field;

typedef struct opentracing_log_record {
    opentracing_timestamp timestamp;
    opentracing_log_field* fields;
    int num_fields;
} opentracing_log_record;

typedef enum opentracing_span_reference_type {
    opentracing_span_reference_child_of = 1,

    opentracing_span_reference_follows_from = 2
} opentracing_span_reference_type;

typedef struct opentracing_span_reference {
    opentracing_span_reference_type type;
    opentracing_span_context* referenced_context;
} opentracing_span_reference;

#define OPENTRACINGC_CHILD_OF(span_context)                  \
    {                                                        \
        opentracing_span_reference_child_of, &(span_context) \
    }

#define OPENTRACINGC_FOLLOWS_FROM(span_context)                  \
    {                                                            \
        opentracing_span_reference_follows_from, &(span_context) \
    }

typedef struct opentracing_finish_span_options {
    opentracing_duration finish_time;

    const opentracing_log_record* log_records;

    int num_log_records;
} opentracing_finish_span_options;

/* Forward declaration. */
struct opentracing_tracer;

typedef struct opentracing_span {
    opentracing_destructible base;

    void (*finish)(struct opentracing_span* span) OPENTRACINGC_NONNULL_ALL;

    void (*finish_with_options)(struct opentracing_span* span,
                                const opentracing_finish_span_options* options)
        OPENTRACINGC_NONNULL(1);

    opentracing_span_context* (*span_context)(struct opentracing_span* span)
        OPENTRACINGC_NONNULL_ALL;

    void (*set_operation_name)(struct opentracing_span* span,
                               const char* operation_name)
        OPENTRACINGC_NONNULL_ALL;

    void (*set_tag)(struct opentracing_span* span,
                    const char* key,
                    const opentracing_value* value) OPENTRACINGC_NONNULL_ALL;

    void (*log_fields)(struct opentracing_span* span,
                       const opentracing_log_field* fields,
                       int num_fields) OPENTRACINGC_NONNULL(1);

    void (*set_baggage_item)(struct opentracing_span* span,
                             const char* key,
                             const char* value) OPENTRACINGC_NONNULL_ALL;

    const char* (*baggage_item)(const struct opentracing_span* span,
                                const char* key) OPENTRACINGC_NONNULL_ALL;

    struct opentracing_tracer* (*tracer)(const struct opentracing_span* span)
        OPENTRACINGC_NONNULL_ALL;
} opentracing_span;

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* OPENTRACINGC_SPAN_H */