tracing.h

/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *     Copyright 2018-2020 Couchbase, Inc.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
 
#ifndef LCB_TRACING_H
#define LCB_TRACING_H
 
#ifdef __cplusplus
namespace lcb
{
namespace trace
{
class Span;
class Tracer;
} // namespace trace
} // namespace lcb
typedef lcb::trace::Span lcbtrace_SPAN;
extern "C" {
#else /* C only! */
typedef struct lcbtrace_SPAN_Cdummy lcbtrace_SPAN;
#endif
 
#define LCBTRACE_F_THRESHOLD 0x01
 
#define LCBTRACE_F_EXTERNAL 0x02
 
typedef enum {
    LCBTRACE_SERVICE_KV = 0,
    LCBTRACE_SERVICE_QUERY,
    LCBTRACE_SERVICE_VIEW,
    LCBTRACE_SERVICE_SEARCH,
    LCBTRACE_SERVICE_ANALYTICS,
    LCBTRACE_SERVICE__MAX
} lcbtrace_SERVICE;
 
struct lcbtrace_TRACER;
typedef struct lcbtrace_TRACER {
    lcb_U16 version;                                    
    lcb_U64 flags;                                      
    void *cookie;                                       
    void (*destructor)(struct lcbtrace_TRACER *tracer); 
    union {
        struct {
            void (*report)(struct lcbtrace_TRACER *tracer, lcbtrace_SPAN *span); 
        } v0;
        struct {
            void *(*start_span)(struct lcbtrace_TRACER *tracer, const char *name, void *parent);
            void (*end_span)(void *span);
            void (*destroy_span)(void *span);
            void (*add_tag_string)(void *span, const char *name, const char *value, size_t value_len);
            void (*add_tag_uint64)(void *span, const char *name, uint64_t value);
        } v1;
    } v;
} lcbtrace_TRACER;
 
LIBCOUCHBASE_API lcbtrace_TRACER *lcb_get_tracer(lcb_INSTANCE *instance);
 
LIBCOUCHBASE_API void lcb_set_tracer(lcb_INSTANCE *instance, lcbtrace_TRACER *tracer);
 
LIBCOUCHBASE_API lcbtrace_TRACER *lcbtrace_new(lcb_INSTANCE *instance, lcb_U64 flags);
 
LIBCOUCHBASE_API void lcbtrace_destroy(lcbtrace_TRACER *tracer);
 
typedef enum {
    LCBTRACE_REF_NONE = 0,
    LCBTRACE_REF_CHILD_OF = 1,
    LCBTRACE_REF_FOLLOWS_FROM,
    LCBTRACE_REF__MAX
} lcbtrace_REF_TYPE;
 
typedef struct {
    lcbtrace_REF_TYPE type;
    lcbtrace_SPAN *span;
} lcbtrace_REF;
 
#define LCBTRACE_NOW 0
 
LIBCOUCHBASE_API
lcb_U64 lcbtrace_now(void);
 
LIBCOUCHBASE_API
lcbtrace_SPAN *lcbtrace_span_start(lcbtrace_TRACER *tracer, const char *operation, lcb_U64 now, lcbtrace_REF *ref);
 
LIBCOUCHBASE_API
lcb_STATUS lcbtrace_span_wrap(lcbtrace_TRACER *tracer, const char *opname, uint64_t start, void *external_span,
                              lcbtrace_SPAN **lcbspan);
 
LIBCOUCHBASE_API
void lcbtrace_span_finish(lcbtrace_SPAN *span, lcb_U64 now);
 
LIBCOUCHBASE_API
int lcbtrace_span_should_finish(lcbtrace_SPAN *span);
 
LIBCOUCHBASE_API
lcb_U64 lcbtrace_span_get_start_ts(lcbtrace_SPAN *span);
 
LIBCOUCHBASE_API
lcb_U64 lcbtrace_span_get_finish_ts(lcbtrace_SPAN *span);
 
LIBCOUCHBASE_API
int lcbtrace_span_is_orphaned(lcbtrace_SPAN *span);
 
LIBCOUCHBASE_API
const char *lcbtrace_span_get_operation(lcbtrace_SPAN *span);
 
LIBCOUCHBASE_API
lcb_STATUS lcbtrace_span_set_service(lcbtrace_SPAN *span, lcbtrace_SERVICE svc);
 
LIBCOUCHBASE_API
lcb_STATUS lcbtrace_span_get_service(lcbtrace_SPAN *span, lcbtrace_SERVICE *svc);
 
LIBCOUCHBASE_API
lcb_STATUS lcbtrace_span_get_is_outer(lcbtrace_SPAN *span, int *outer);
 
LIBCOUCHBASE_API
lcb_STATUS lcbtrace_span_set_is_outer(lcbtrace_SPAN *span, int outer);
 
LIBCOUCHBASE_API
lcb_STATUS lcbtrace_span_get_is_encoding(lcbtrace_SPAN *span, int *encoding);
 
LIBCOUCHBASE_API
lcb_STATUS lcbtrace_span_set_is_encode(lcbtrace_SPAN *span, int encode);
 
LIBCOUCHBASE_API
lcb_STATUS lcbtrace_span_get_is_dispatch(lcbtrace_SPAN *span, int *dispatch);
 
LIBCOUCHBASE_API
lcb_STATUS lcbtrace_span_set_is_dispatch(lcbtrace_SPAN *span, int dispatch);
 
#define LCBTRACE_OP_REQUEST_ENCODING "request_encoding"
#define LCBTRACE_OP_DISPATCH_TO_SERVER "dispatch"
#define LCBTRACE_OP_RESPONSE_DECODING "response_decoding"
 
#define LCBTRACE_OP_INSERT "insert"
#define LCBTRACE_OP_APPEND "append"
#define LCBTRACE_OP_COUNTER "counter"
#define LCBTRACE_OP_GET "get"
#define LCBTRACE_OP_GET_FROM_REPLICA "get_from_replica"
#define LCBTRACE_OP_INSERT "insert"
#define LCBTRACE_OP_OBSERVE_CAS "observe_cas"
#define LCBTRACE_OP_OBSERVE_CAS_ROUND "observe_cas_round"
#define LCBTRACE_OP_OBSERVE_SEQNO "observe_seqno"
#define LCBTRACE_OP_PREPEND "prepend"
#define LCBTRACE_OP_REMOVE "remove"
#define LCBTRACE_OP_REPLACE "replace"
#define LCBTRACE_OP_TOUCH "touch"
#define LCBTRACE_OP_UNLOCK "unlock"
#define LCBTRACE_OP_UPSERT "upsert"
#define LCBTRACE_OP_EXISTS "exists"
#define LCBTRACE_OP_LOOKUPIN "lookup_in"
#define LCBTRACE_OP_MUTATEIN "mutate_in"
#define LCBTRACE_OP_QUERY "query"
#define LCBTRACE_OP_ANALYTICS "analytics"
#define LCBTRACE_OP_SEARCH "search"
#define LCBTRACE_OP_VIEW "views"
 
#define LCBTRACE_TAG_SPAN_KIND "span.kind"
#define LCBTRACE_TAG_DB_INSTANCE "db.name"
#define LCBTRACE_TAG_COMPONENT "db.couchbase.component"
#define LCBTRACE_TAG_OPERATION_ID "db.couchbase.operation_id"
#define LCBTRACE_TAG_SERVICE "db.couchbase.service"
#define LCBTRACE_TAG_SERVICE_KV "kv"
#define LCBTRACE_TAG_SERVICE_VIEW "views"
#define LCBTRACE_TAG_SERVICE_N1QL "query"
#define LCBTRACE_TAG_SERVICE_SEARCH "search"
#define LCBTRACE_TAG_SERVICE_ANALYTICS "analytics"
 
#define LCBTRACE_TAG_LOCAL_ID "db.couchbase.local_id"
 
#define LCBTRACE_TAG_LOCAL_ADDRESS "net.host.name"
#define LCBTRACE_TAG_LOCAL_PORT "net.host.port"
 
#define LCBTRACE_TAG_PEER_ADDRESS "net.peer.name"
#define LCBTRACE_TAG_PEER_PORT "net.peer.port"
#define LCBTRACE_TAG_PEER_LATENCY "db.couchbase.server_duration"
#define LCBTRACE_TAG_SCOPE "db.couchbase.scope"
#define LCBTRACE_TAG_COLLECTION "db.couchbase.collection"
#define LCBTRACE_TAG_STATEMENT "db.statement"
#define LCBTRACE_TAG_OPERATION "db.operation"
#define LCBTRACE_TAG_DURABILITY "db.couchbase.durability"
#define LCBTRACE_TAG_RETRIES "db.couchbase.retries"
 
#define LCBTRACE_TAG_SYSTEM "db.system"
 
#define LCBTRACE_TAG_TRANSPORT "net.transport"
LIBCOUCHBASE_API
lcb_U64 lcbtrace_span_get_span_id(lcbtrace_SPAN *span);
 
LIBCOUCHBASE_API
lcb_U64 lcbtrace_span_get_trace_id(lcbtrace_SPAN *span);
 
LIBCOUCHBASE_API
lcbtrace_SPAN *lcbtrace_span_get_parent(lcbtrace_SPAN *span);
 
LIBCOUCHBASE_API
lcb_STATUS lcbtrace_span_get_tag_str(lcbtrace_SPAN *span, const char *name, char **value, size_t *nvalue);
 
LIBCOUCHBASE_API
lcb_STATUS lcbtrace_span_get_tag_uint64(lcbtrace_SPAN *span, const char *name, lcb_U64 *value);
 
LIBCOUCHBASE_API
lcb_STATUS lcbtrace_span_get_tag_double(lcbtrace_SPAN *span, const char *name, double *value);
 
LIBCOUCHBASE_API
lcb_STATUS lcbtrace_span_get_tag_bool(lcbtrace_SPAN *span, const char *name, int *value);
 
LIBCOUCHBASE_API
void lcbtrace_span_add_tag_str(lcbtrace_SPAN *span, const char *name, const char *value);
 
LIBCOUCHBASE_API
void lcbtrace_span_add_tag_uint64(lcbtrace_SPAN *span, const char *name, lcb_U64 value);
 
LIBCOUCHBASE_API
void lcbtrace_span_add_tag_double(lcbtrace_SPAN *span, const char *name, double value);
 
LIBCOUCHBASE_API
void lcbtrace_span_add_tag_bool(lcbtrace_SPAN *span, const char *name, int value);
 
#define LCB_CMD_SET_TRACESPAN(cmd, span)                                                                               \
    do {                                                                                                               \
        (cmd)->pspan = span;                                                                                           \
    } while (0)
 
typedef struct {
    void *state;
    void (*report)(void *state, lcbtrace_SPAN *span);
} ldcptrace_REPORTER;
 
#ifdef __cplusplus
}
#endif
#endif /* LCB_TRACING_H */