couchbase/dist/observabilitytypes.js

The official Couchbase Node.js Client Library.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ObservabilityInstruments = exports.SpanStatusCode = exports.serviceNameFromOpType = exports.ServiceName = exports.DispatchAttributeName = exports.isCppAttribute = exports.CppOpAttributeNameToOpAttributeNameMap = exports.OpAttributeName = exports.CppOpAttributeName = exports.ViewIndexMgmtOp = exports.UserMgmtOp = exports.SearchIndexMgmtOp = exports.QueryIndexMgmtOp = exports.EventingFunctionMgmtOp = exports.CollectionMgmtOp = exports.BucketMgmtOp = exports.AnalyticsMgmtOp = exports.StreamingOp = exports.DatastructureOp = exports.KeyValueOp = void 0;
/* eslint-disable jsdoc/require-jsdoc */
/**
 * @internal
 */
var KeyValueOp;
(function (KeyValueOp) {
    KeyValueOp["Append"] = "append";
    KeyValueOp["Decrement"] = "decrement";
    KeyValueOp["Exists"] = "exists";
    KeyValueOp["Get"] = "get";
    KeyValueOp["GetAllReplicas"] = "get_all_replicas";
    KeyValueOp["GetAndLock"] = "get_and_lock";
    KeyValueOp["GetAndTouch"] = "get_and_touch";
    KeyValueOp["GetAnyReplica"] = "get_any_replica";
    KeyValueOp["GetReplica"] = "get_replica";
    KeyValueOp["Increment"] = "increment";
    KeyValueOp["Insert"] = "insert";
    KeyValueOp["LookupIn"] = "lookup_in";
    KeyValueOp["LookupInAllReplicas"] = "lookup_in_all_replicas";
    KeyValueOp["LookupInAnyReplica"] = "lookup_in_any_replica";
    KeyValueOp["LookupInReplica"] = "lookup_in_replica";
    KeyValueOp["MutateIn"] = "mutate_in";
    KeyValueOp["Prepend"] = "prepend";
    KeyValueOp["RangeScanCancel"] = "range_scan_cancel";
    KeyValueOp["RangeScanContinue"] = "range_scan_continue";
    KeyValueOp["RangeScanCreate"] = "range_scan_create";
    KeyValueOp["Remove"] = "remove";
    KeyValueOp["Replace"] = "replace";
    KeyValueOp["Touch"] = "touch";
    KeyValueOp["Unlock"] = "unlock";
    KeyValueOp["Upsert"] = "upsert";
})(KeyValueOp || (exports.KeyValueOp = KeyValueOp = {}));
/**
 * @internal
 */
var DatastructureOp;
(function (DatastructureOp) {
    DatastructureOp["ListGetAll"] = "list_get_all";
    DatastructureOp["ListGetAt"] = "list_get_at";
    DatastructureOp["ListIndexOf"] = "list_index_of";
    DatastructureOp["ListPush"] = "list_push";
    DatastructureOp["ListRemoveAt"] = "list_remove_at";
    DatastructureOp["ListSize"] = "list_size";
    DatastructureOp["ListUnshift"] = "list_unshift";
    DatastructureOp["MapExists"] = "map_exists";
    DatastructureOp["MapGet"] = "map_get";
    DatastructureOp["MapGetAll"] = "map_get_all";
    DatastructureOp["MapKeys"] = "map_keys";
    DatastructureOp["MapRemove"] = "map_remove";
    DatastructureOp["MapSet"] = "map_set";
    DatastructureOp["MapSize"] = "map_size";
    DatastructureOp["MapValues"] = "map_values";
    DatastructureOp["QueuePop"] = "queue_pop";
    DatastructureOp["QueuePush"] = "queue_push";
    DatastructureOp["QueueSize"] = "queue_size";
    DatastructureOp["SetAdd"] = "set_add";
    DatastructureOp["SetContains"] = "set_contains";
    DatastructureOp["SetRemove"] = "set_remove";
    DatastructureOp["SetSize"] = "set_size";
    DatastructureOp["SetValues"] = "set_values";
})(DatastructureOp || (exports.DatastructureOp = DatastructureOp = {}));
/**
 * @internal
 */
var StreamingOp;
(function (StreamingOp) {
    StreamingOp["Analytics"] = "analytics_query";
    StreamingOp["Query"] = "query";
    StreamingOp["Search"] = "search_query";
    StreamingOp["View"] = "view_query";
})(StreamingOp || (exports.StreamingOp = StreamingOp = {}));
/**
 * @internal
 */
var AnalyticsMgmtOp;
(function (AnalyticsMgmtOp) {
    AnalyticsMgmtOp["AnalyticsDatasetCreate"] = "manager_analytics_create_dataset";
    AnalyticsMgmtOp["AnalyticsDatasetDrop"] = "manager_analytics_drop_dataset";
    AnalyticsMgmtOp["AnalyticsDatasetGetAll"] = "manager_analytics_get_all_datasets";
    AnalyticsMgmtOp["AnalyticsDataverseCreate"] = "manager_analytics_create_dataverse";
    AnalyticsMgmtOp["AnalyticsDataverseDrop"] = "manager_analytics_drop_dataverse";
    AnalyticsMgmtOp["AnalyticsGetPendingMutations"] = "manager_analytics_get_pending_mutations";
    AnalyticsMgmtOp["AnalyticsIndexCreate"] = "manager_analytics_create_index";
    AnalyticsMgmtOp["AnalyticsIndexDrop"] = "manager_analytics_drop_index";
    AnalyticsMgmtOp["AnalyticsIndexGetAll"] = "manager_analytics_get_all_indexes";
    AnalyticsMgmtOp["AnalyticsLinkConnect"] = "manager_analytics_connectlink";
    AnalyticsMgmtOp["AnalyticsLinkCreate"] = "manager_analytics_create_link";
    AnalyticsMgmtOp["AnalyticsLinkDisconnect"] = "manager_analytics_disconnect_link";
    AnalyticsMgmtOp["AnalyticsLinkDrop"] = "manager_analytics_drop_link";
    AnalyticsMgmtOp["AnalyticsLinkGetAll"] = "manager_analytics_get_all_links";
    AnalyticsMgmtOp["AnalyticsLinkReplace"] = "manager_analytics_replace_link";
})(AnalyticsMgmtOp || (exports.AnalyticsMgmtOp = AnalyticsMgmtOp = {}));
/**
 * @internal
 */
var BucketMgmtOp;
(function (BucketMgmtOp) {
    BucketMgmtOp["BucketCreate"] = "manager_buckets_create_bucket";
    BucketMgmtOp["BucketDescribe"] = "manager_buckets_describe_bucket";
    BucketMgmtOp["BucketDrop"] = "manager_buckets_drop_bucket";
    BucketMgmtOp["BucketFlush"] = "manager_buckets_flush_bucket";
    BucketMgmtOp["BucketGet"] = "manager_buckets_get_bucket";
    BucketMgmtOp["BucketGetAll"] = "manager_buckets_get_all_buckets";
    BucketMgmtOp["BucketUpdate"] = "manager_buckets_update_bucket";
})(BucketMgmtOp || (exports.BucketMgmtOp = BucketMgmtOp = {}));
/**
 * @internal
 */
var CollectionMgmtOp;
(function (CollectionMgmtOp) {
    CollectionMgmtOp["CollectionCreate"] = "manager_collections_create_collection";
    CollectionMgmtOp["CollectionsManifestGet"] = "manager_collections_get_collections_manifest";
    CollectionMgmtOp["CollectionDrop"] = "manager_collections_drop_collection";
    CollectionMgmtOp["CollectionUpdate"] = "manager_collections_update_collection";
    CollectionMgmtOp["ScopeCreate"] = "manager_collections_create_scope";
    CollectionMgmtOp["ScopeDrop"] = "manager_collections_drop_scope";
    CollectionMgmtOp["ScopeGetAll"] = "manager_collections_get_all_scopes";
})(CollectionMgmtOp || (exports.CollectionMgmtOp = CollectionMgmtOp = {}));
/**
 * @internal
 */
var EventingFunctionMgmtOp;
(function (EventingFunctionMgmtOp) {
    EventingFunctionMgmtOp["EventingDeployFunction"] = "manager_eventing_deploy_function";
    EventingFunctionMgmtOp["EventingDropFunction"] = "manager_eventing_drop_function";
    EventingFunctionMgmtOp["EventingGetAllFunctions"] = "manager_eventing_get_all_functions";
    EventingFunctionMgmtOp["EventingGetFunction"] = "manager_eventing_get_function";
    EventingFunctionMgmtOp["EventingGetStatus"] = "manager_eventing_functions_status";
    EventingFunctionMgmtOp["EventingPauseFunction"] = "manager_eventing_pause_function";
    EventingFunctionMgmtOp["EventingResumeFunction"] = "manager_eventing_resume_function";
    EventingFunctionMgmtOp["EventingUndeployFunction"] = "manager_eventing_undeploy_function";
    EventingFunctionMgmtOp["EventingUpsertFunction"] = "manager_eventing_upsert_function";
})(EventingFunctionMgmtOp || (exports.EventingFunctionMgmtOp = EventingFunctionMgmtOp = {}));
/**
 * @internal
 */
var QueryIndexMgmtOp;
(function (QueryIndexMgmtOp) {
    QueryIndexMgmtOp["QueryIndexBuild"] = "manager_query_build_indexes";
    QueryIndexMgmtOp["QueryIndexBuildDeferred"] = "manager_query_build_deferred_indexes";
    QueryIndexMgmtOp["QueryIndexCreate"] = "manager_query_create_index";
    QueryIndexMgmtOp["QueryIndexDrop"] = "manager_query_drop_index";
    QueryIndexMgmtOp["QueryIndexGetAll"] = "manager_query_get_all_indexes";
    QueryIndexMgmtOp["QueryIndexGetAllDeferred"] = "manager_query_get_all_deferred_indexes";
    QueryIndexMgmtOp["QueryIndexWatchIndexes"] = "manager_query_watch_indexes";
})(QueryIndexMgmtOp || (exports.QueryIndexMgmtOp = QueryIndexMgmtOp = {}));
/**
 * @internal
 */
var SearchIndexMgmtOp;
(function (SearchIndexMgmtOp) {
    SearchIndexMgmtOp["SearchGetStats"] = "manager_search_get_stats";
    SearchIndexMgmtOp["SearchIndexAllowQuerying"] = "manager_search_allow_querying";
    SearchIndexMgmtOp["SearchIndexAnalyzeDocument"] = "manager_search_analyze_document";
    SearchIndexMgmtOp["SearchIndexDisallowQuerying"] = "manager_search_disallow_querying";
    SearchIndexMgmtOp["SearchIndexDrop"] = "manager_search_drop_index";
    SearchIndexMgmtOp["SearchIndexFreezePlan"] = "manager_search_freeze_plan";
    SearchIndexMgmtOp["SearchIndexGet"] = "manager_search_get_index";
    SearchIndexMgmtOp["SearchIndexGetAll"] = "manager_search_get_all_indexes";
    SearchIndexMgmtOp["SearchIndexGetDocumentsCount"] = "manager_search_get_indexed_documents_count";
    SearchIndexMgmtOp["SearchIndexGetStats"] = "manager_search_get_index_stats";
    SearchIndexMgmtOp["SearchIndexPauseIngest"] = "manager_search_pause_ingest";
    SearchIndexMgmtOp["SearchIndexResumeIngest"] = "manager_search_resume_ingest";
    SearchIndexMgmtOp["SearchIndexUnfreezePlan"] = "manager_search_unfreeze_plan";
    SearchIndexMgmtOp["SearchIndexUpsert"] = "manager_search_upsert_index";
})(SearchIndexMgmtOp || (exports.SearchIndexMgmtOp = SearchIndexMgmtOp = {}));
/**
 * @internal
 */
var UserMgmtOp;
(function (UserMgmtOp) {
    UserMgmtOp["ChangePassword"] = "manager_users_change_password";
    UserMgmtOp["GroupDrop"] = "manager_users_drop_group";
    UserMgmtOp["GroupGet"] = "manager_users_get_group";
    UserMgmtOp["GroupGetAll"] = "manager_users_get_all_groups";
    UserMgmtOp["GroupUpsert"] = "manager_users_upsert_group";
    UserMgmtOp["RoleGetAll"] = "manager_users_get_all_roles";
    UserMgmtOp["UserDrop"] = "manager_users_drop_user";
    UserMgmtOp["UserGet"] = "manager_users_get_user";
    UserMgmtOp["UserGetAll"] = "manager_users_get_all_users";
    UserMgmtOp["UserUpsert"] = "manager_users_upsert_user";
})(UserMgmtOp || (exports.UserMgmtOp = UserMgmtOp = {}));
/**
 * @internal
 */
var ViewIndexMgmtOp;
(function (ViewIndexMgmtOp) {
    ViewIndexMgmtOp["ViewIndexDrop"] = "manager_views_drop_design_document";
    ViewIndexMgmtOp["ViewIndexGet"] = "manager_views_get_design_document";
    ViewIndexMgmtOp["ViewIndexGetAll"] = "manager_views_get_all_design_documents";
    ViewIndexMgmtOp["ViewIndexPublish"] = "manager_views_publish_design_document";
    ViewIndexMgmtOp["ViewIndexUpsert"] = "manager_views_upsert_design_document";
})(ViewIndexMgmtOp || (exports.ViewIndexMgmtOp = ViewIndexMgmtOp = {}));
/**
 * @internal
 */
var CppOpAttributeName;
(function (CppOpAttributeName) {
    CppOpAttributeName["ClusterName"] = "cluster_name";
    CppOpAttributeName["ClusterUUID"] = "cluster_uuid";
    CppOpAttributeName["RetryCount"] = "retries";
})(CppOpAttributeName || (exports.CppOpAttributeName = CppOpAttributeName = {}));
/**
 * @internal
 */
var OpAttributeName;
(function (OpAttributeName) {
    OpAttributeName["BucketName"] = "db.namespace";
    OpAttributeName["ClusterName"] = "couchbase.cluster.name";
    OpAttributeName["ClusterUUID"] = "couchbase.cluster.uuid";
    OpAttributeName["CollectionName"] = "couchbase.collection.name";
    OpAttributeName["DispatchSpanName"] = "dispatch_to_server";
    OpAttributeName["DurabilityLevel"] = "couchbase.durability";
    OpAttributeName["EncodingSpanName"] = "request_encoding";
    OpAttributeName["ErrorType"] = "error.type";
    OpAttributeName["MeterNameOpDuration"] = "db.client.operation.duration";
    OpAttributeName["OperationName"] = "db.operation.name";
    OpAttributeName["QueryStatement"] = "db.query.text";
    OpAttributeName["ReservedUnit"] = "__unit";
    OpAttributeName["ReservedUnitSeconds"] = "s";
    OpAttributeName["RetryCount"] = "couchbase.retries";
    OpAttributeName["ScopeName"] = "couchbase.scope.name";
    OpAttributeName["Service"] = "couchbase.service";
    OpAttributeName["SystemName"] = "db.system.name";
})(OpAttributeName || (exports.OpAttributeName = OpAttributeName = {}));
exports.CppOpAttributeNameToOpAttributeNameMap = {
    [CppOpAttributeName.ClusterName]: OpAttributeName.ClusterName,
    [CppOpAttributeName.ClusterUUID]: OpAttributeName.ClusterUUID,
    [CppOpAttributeName.RetryCount]: OpAttributeName.RetryCount,
};
const isCppAttribute = (attr) => {
    return attr in exports.CppOpAttributeNameToOpAttributeNameMap;
};
exports.isCppAttribute = isCppAttribute;
/**
 * @internal
 */
var DispatchAttributeName;
(function (DispatchAttributeName) {
    DispatchAttributeName["LocalId"] = "couchbase.local_id";
    DispatchAttributeName["NetworkTransport"] = "network.transport";
    DispatchAttributeName["OperationId"] = "couchbase.operation_id";
    DispatchAttributeName["PeerAddress"] = "network.peer.address";
    DispatchAttributeName["PeerPort"] = "network.peer.port";
    DispatchAttributeName["ServerAddress"] = "server.address";
    DispatchAttributeName["ServerDuration"] = "couchbase.server_duration";
    DispatchAttributeName["ServerPort"] = "server.port";
})(DispatchAttributeName || (exports.DispatchAttributeName = DispatchAttributeName = {}));
/**
 * @internal
 */
var ServiceName;
(function (ServiceName) {
    ServiceName["Analytics"] = "analytics";
    ServiceName["Eventing"] = "eventing";
    ServiceName["KeyValue"] = "kv";
    ServiceName["Management"] = "management";
    ServiceName["Query"] = "query";
    ServiceName["Search"] = "search";
    ServiceName["Transactions"] = "transactions";
    ServiceName["Views"] = "views";
})(ServiceName || (exports.ServiceName = ServiceName = {}));
/**
 * @internal
 */
function serviceNameFromOpType(opType) {
    if (Object.values(KeyValueOp).includes(opType)) {
        return ServiceName.KeyValue;
    }
    else if (Object.values(DatastructureOp).includes(opType)) {
        return ServiceName.KeyValue;
    }
    else if (Object.values(StreamingOp).includes(opType)) {
        switch (opType) {
            case StreamingOp.Analytics:
                return ServiceName.Analytics;
            case StreamingOp.Query:
                return ServiceName.Query;
            case StreamingOp.Search:
                return ServiceName.Search;
            case StreamingOp.View:
                return ServiceName.Views;
        }
    }
    else if (Object.values(AnalyticsMgmtOp).includes(opType)) {
        return ServiceName.Analytics;
    }
    else if (Object.values(BucketMgmtOp).includes(opType)) {
        return ServiceName.Management;
    }
    else if (Object.values(CollectionMgmtOp).includes(opType)) {
        return ServiceName.Management;
    }
    else if (Object.values(EventingFunctionMgmtOp).includes(opType)) {
        return ServiceName.Eventing;
    }
    else if (Object.values(QueryIndexMgmtOp).includes(opType)) {
        return ServiceName.Query;
    }
    else if (Object.values(SearchIndexMgmtOp).includes(opType)) {
        return ServiceName.Search;
    }
    else if (Object.values(UserMgmtOp).includes(opType)) {
        return ServiceName.Management;
    }
    else if (Object.values(ViewIndexMgmtOp).includes(opType)) {
        return ServiceName.Views;
    }
    throw new Error(`Unknown OpType: ${opType}`);
}
exports.serviceNameFromOpType = serviceNameFromOpType;
/**
 * An enumeration of status codes.
 */
var SpanStatusCode;
(function (SpanStatusCode) {
    /**
     * The default status.
     */
    SpanStatusCode[SpanStatusCode["UNSET"] = 0] = "UNSET";
    /**
     * The operation has been validated by an Application developer or
     * Operator to have completed successfully.
     */
    SpanStatusCode[SpanStatusCode["OK"] = 1] = "OK";
    /**
     * The operation contains an error.
     */
    SpanStatusCode[SpanStatusCode["ERROR"] = 2] = "ERROR";
})(SpanStatusCode || (exports.SpanStatusCode = SpanStatusCode = {}));
/**
 * @internal
 */
class ObservabilityInstruments {
    constructor(tracer, meter, getClusterLabelsFn) {
        this._tracer = tracer;
        this._meter = meter;
        this._getClusterLabelsFn = getClusterLabelsFn;
    }
    /**
     * @internal
     */
    get tracer() {
        return this._tracer;
    }
    /**
     * @internal
     */
    get meter() {
        return this._meter;
    }
    /**
     * @internal
     */
    get clusterLabelsFn() {
        return this._getClusterLabelsFn;
    }
}
exports.ObservabilityInstruments = ObservabilityInstruments;