metrics.h

/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *     Copyright 2017-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_METRICS_H
#define LCB_METRICS_H
 
// As part of implementation of metrics and tracing, the metrics.h file was moved to
// the iometrics.h file.  To ensure backwards compatibility, we include iometrics.h.
#include <libcouchbase/iometrics.h>
 
#include <libcouchbase/error.h>
#include <libcouchbase/visibility.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define LCBTRACE_F_LOGGING 0x01
 
typedef struct {
    const char *key;
    const char *value;
} lcbmetrics_TAG;
 
typedef struct lcbmetrics_VALUERECORDER_ lcbmetrics_VALUERECORDER;
 
typedef struct lcbmetrics_METER_ lcbmetrics_METER;
 
typedef const lcbmetrics_VALUERECORDER *(*lcbmetrics_VALUE_RECORDER_CALLBACK)(const lcbmetrics_METER *meter,
                                                                              const char *name,
                                                                              const lcbmetrics_TAG *tags, size_t ntags);
 
typedef void (*lcbmetrics_RECORD_VALUE)(const lcbmetrics_VALUERECORDER *recorder, uint64_t value);
 
LIBCOUCHBASE_API
lcb_STATUS lcbmetrics_valuerecorder_create(lcbmetrics_VALUERECORDER **recorder, void *cookie);
 
LIBCOUCHBASE_API
lcb_STATUS lcbmetrics_valuerecorder_dtor_callback(lcbmetrics_VALUERECORDER *recorder,
                                                  void (*callback)(const lcbmetrics_VALUERECORDER *recorder));
 
LIBCOUCHBASE_API lcb_STATUS lcbmetrics_valuerecorder_record_value_callback(lcbmetrics_VALUERECORDER *recorder,
                                                                           lcbmetrics_RECORD_VALUE callback);
 
LIBCOUCHBASE_API
lcb_STATUS lcbmetrics_valuerecorder_cookie(const lcbmetrics_VALUERECORDER *recorder, void **cookie);
 
LIBCOUCHBASE_API
void lcbmetrics_valuerecorder_destroy(const lcbmetrics_VALUERECORDER *recorder);
 
LIBCOUCHBASE_API
lcb_STATUS lcbmetrics_meter_create(lcbmetrics_METER **meter, void *cookie);
 
LIBCOUCHBASE_API
lcb_STATUS lcbmetrics_meter_dtor_callback(lcbmetrics_METER *meter, void (*callback)(const lcbmetrics_METER *meter));
 
LIBCOUCHBASE_API lcb_STATUS lcbmetrics_meter_value_recorder_callback(lcbmetrics_METER *meter,
                                                                     lcbmetrics_VALUE_RECORDER_CALLBACK callback);
 
LIBCOUCHBASE_API
lcb_STATUS lcbmetrics_meter_cookie(const lcbmetrics_METER *meter, void **cookie);
 
LIBCOUCHBASE_API
void lcbmetrics_meter_destroy(const lcbmetrics_METER *meter);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif // LCB_METRICS_H