CXXCBC-611 & CXXCBC-612: Follow RFC naming for metric operation names (…

…#695)
couchbase · Nov 14, 2024 · a797847 · a797847
1 parent 8bf1445
commit a797847
Show file tree

Hide file tree

Showing 104 changed files with 238 additions and 33 deletions.
diff --git a/core/impl/get_replica.hxx b/core/impl/get_replica.hxx
@@ -41,6 +41,8 @@ struct get_replica_request {
   using encoded_response_type =
     core::protocol::client_response<core::protocol::get_replica_response_body>;
 
+  static const inline std::string observability_identifier = "get_replica";
+
   core::document_id id;
   std::optional<std::chrono::milliseconds> timeout{};
   std::uint16_t partition{};

diff --git a/core/impl/lookup_in_replica.hxx b/core/impl/lookup_in_replica.hxx
@@ -53,6 +53,8 @@ struct lookup_in_replica_request {
   using encoded_response_type =
     protocol::client_response<protocol::lookup_in_replica_response_body>;
 
+  static const inline std::string observability_identifier = "lookup_in_replica";
+
   document_id id;
   std::vector<couchbase::core::impl::subdoc::command> specs{};
   std::optional<std::chrono::milliseconds> timeout{};

diff --git a/core/impl/observe_seqno.hxx b/core/impl/observe_seqno.hxx
@@ -50,6 +50,8 @@ struct observe_seqno_request {
   using encoded_response_type =
     core::protocol::client_response<core::protocol::observe_seqno_response_body>;
 
+  static const inline std::string observability_identifier = "observe_seqno";
+
   core::document_id id;
   bool active{};
   std::uint64_t partition_uuid{};

diff --git a/core/io/http_command.hxx b/core/io/http_command.hxx
@@ -246,8 +246,8 @@ private:
         }
         if (self->meter_) {
           metrics::metric_attributes attrs{
-            service_type::key_value,
-            fmt::format("{}", self->encoded.path),
+            self->request.type,
+            self->request.observability_identifier,
             ec,
           };
           self->meter_->record_value(std::move(attrs), start);

diff --git a/core/io/mcbp_command.hxx b/core/io/mcbp_command.hxx
@@ -269,7 +269,7 @@ struct mcbp_command : public std::enable_shared_from_this<mcbp_command<Manager,
         std::optional<key_value_error_map_info> /* error_info */) mutable {
         metrics::metric_attributes attrs{
           service_type::key_value,
-          fmt::format("{}", encoded_request_type::body_type::opcode),
+          self->request.observability_identifier,
           ec,
           self->request.id.bucket(),
           self->request.id.scope(),

diff --git a/core/operations/document_analytics.hxx b/core/operations/document_analytics.hxx
@@ -80,6 +80,7 @@ struct analytics_request {
   using error_context_type = error_context::analytics;
 
   static const inline service_type type = service_type::analytics;
+  static const inline std::string observability_identifier = "analytics";
 
   std::string statement;
 

diff --git a/core/operations/document_append.hxx b/core/operations/document_append.hxx
@@ -44,6 +44,8 @@ struct append_request {
   using encoded_request_type = protocol::client_request<protocol::append_request_body>;
   using encoded_response_type = protocol::client_response<protocol::append_response_body>;
 
+  static const inline std::string observability_identifier = "append";
+
   document_id id;
   std::vector<std::byte> value;
   std::uint16_t partition{};

diff --git a/core/operations/document_decrement.hxx b/core/operations/document_decrement.hxx
@@ -45,6 +45,8 @@ struct decrement_request {
   using encoded_request_type = protocol::client_request<protocol::decrement_request_body>;
   using encoded_response_type = protocol::client_response<protocol::decrement_response_body>;
 
+  static const inline std::string observability_identifier = "decrement";
+
   document_id id;
   std::uint16_t partition{};
   std::uint32_t opaque{};

diff --git a/core/operations/document_exists.hxx b/core/operations/document_exists.hxx
@@ -50,6 +50,8 @@ struct exists_request {
   using encoded_request_type = protocol::client_request<protocol::get_meta_request_body>;
   using encoded_response_type = protocol::client_response<protocol::get_meta_response_body>;
 
+  static const inline std::string observability_identifier = "exists";
+
   document_id id;
   std::uint16_t partition{};
   std::uint32_t opaque{};

diff --git a/core/operations/document_get.hxx b/core/operations/document_get.hxx
@@ -41,6 +41,8 @@ struct get_request {
   using encoded_request_type = protocol::client_request<protocol::get_request_body>;
   using encoded_response_type = protocol::client_response<protocol::get_response_body>;
 
+  static const inline std::string observability_identifier = "get";
+
   document_id id;
   std::uint16_t partition{};
   std::uint32_t opaque{};

diff --git a/core/operations/document_get_all_replicas.hxx b/core/operations/document_get_all_replicas.hxx
@@ -50,6 +50,8 @@ struct get_all_replicas_request {
   using encoded_response_type =
     core::protocol::client_response<core::protocol::get_replica_response_body>;
 
+  static const inline std::string observability_identifier = "get_all_replicas";
+
   core::document_id id;
   std::optional<std::chrono::milliseconds> timeout{};
   couchbase::read_preference read_preference{ couchbase::read_preference::no_preference };

diff --git a/core/operations/document_get_and_lock.hxx b/core/operations/document_get_and_lock.hxx
@@ -41,6 +41,8 @@ struct get_and_lock_request {
   using encoded_request_type = protocol::client_request<protocol::get_and_lock_request_body>;
   using encoded_response_type = protocol::client_response<protocol::get_and_lock_response_body>;
 
+  static const inline std::string observability_identifier = "get_and_lock";
+
   document_id id;
   std::uint16_t partition{};
   std::uint32_t opaque{};

diff --git a/core/operations/document_get_and_touch.hxx b/core/operations/document_get_and_touch.hxx
@@ -42,6 +42,8 @@ struct get_and_touch_request {
   using encoded_request_type = protocol::client_request<protocol::get_and_touch_request_body>;
   using encoded_response_type = protocol::client_response<protocol::get_and_touch_response_body>;
 
+  static const inline std::string observability_identifier = "get_and_touch";
+
   document_id id;
   std::uint16_t partition{};
   std::uint32_t opaque{};

diff --git a/core/operations/document_get_any_replica.hxx b/core/operations/document_get_any_replica.hxx
@@ -46,6 +46,8 @@ struct get_any_replica_request {
   using encoded_response_type =
     core::protocol::client_response<core::protocol::get_replica_response_body>;
 
+  static const inline std::string observability_identifier = "get_any_replica";
+
   core::document_id id;
   std::optional<std::chrono::milliseconds> timeout{};
   couchbase::read_preference read_preference{ couchbase::read_preference::no_preference };

diff --git a/core/operations/document_get_projected.hxx b/core/operations/document_get_projected.hxx
@@ -42,6 +42,8 @@ struct get_projected_request {
   using encoded_request_type = protocol::client_request<protocol::lookup_in_request_body>;
   using encoded_response_type = protocol::client_response<protocol::lookup_in_response_body>;
 
+  static const inline std::string observability_identifier = "get";
+
   document_id id;
   std::uint16_t partition{};
   std::uint32_t opaque{};

diff --git a/core/operations/document_increment.hxx b/core/operations/document_increment.hxx
@@ -45,6 +45,8 @@ struct increment_request {
   using encoded_request_type = protocol::client_request<protocol::increment_request_body>;
   using encoded_response_type = protocol::client_response<protocol::increment_response_body>;
 
+  static const inline std::string observability_identifier = "increment";
+
   document_id id;
   std::uint16_t partition{};
   std::uint32_t opaque{};

diff --git a/core/operations/document_insert.hxx b/core/operations/document_insert.hxx
@@ -44,6 +44,8 @@ struct insert_request {
   using encoded_request_type = protocol::client_request<protocol::insert_request_body>;
   using encoded_response_type = protocol::client_response<protocol::insert_response_body>;
 
+  static const inline std::string observability_identifier = "insert";
+
   document_id id;
   std::vector<std::byte> value;
   std::uint16_t partition{};

diff --git a/core/operations/document_lookup_in.hxx b/core/operations/document_lookup_in.hxx
@@ -54,6 +54,8 @@ struct lookup_in_request {
   using encoded_request_type = protocol::client_request<protocol::lookup_in_request_body>;
   using encoded_response_type = protocol::client_response<protocol::lookup_in_response_body>;
 
+  static const inline std::string observability_identifier = "lookup_in";
+
   document_id id;
   std::uint16_t partition{};
   std::uint32_t opaque{};

diff --git a/core/operations/document_lookup_in_all_replicas.hxx b/core/operations/document_lookup_in_all_replicas.hxx
@@ -61,6 +61,8 @@ struct lookup_in_all_replicas_request {
   using encoded_response_type =
     core::protocol::client_response<core::protocol::lookup_in_replica_response_body>;
 
+  static const inline std::string observability_identifier = "lookup_in_all_replicas";
+
   core::document_id id;
   std::vector<couchbase::core::impl::subdoc::command> specs{};
   std::optional<std::chrono::milliseconds> timeout{};

diff --git a/core/operations/document_lookup_in_any_replica.hxx b/core/operations/document_lookup_in_any_replica.hxx
@@ -59,6 +59,8 @@ struct lookup_in_any_replica_request {
   using encoded_response_type =
     core::protocol::client_response<core::protocol::lookup_in_replica_response_body>;
 
+  static const inline std::string observability_identifier = "lookup_in_any_replica";
+
   core::document_id id;
   std::vector<couchbase::core::impl::subdoc::command> specs{};
   std::optional<std::chrono::milliseconds> timeout{};

diff --git a/core/operations/document_mutate_in.hxx b/core/operations/document_mutate_in.hxx
@@ -55,6 +55,8 @@ struct mutate_in_request {
   using encoded_request_type = protocol::client_request<protocol::mutate_in_request_body>;
   using encoded_response_type = protocol::client_response<protocol::mutate_in_response_body>;
 
+  static const inline std::string observability_identifier = "mutate_in";
+
   document_id id;
   std::uint16_t partition{};
   std::uint32_t opaque{};

diff --git a/core/operations/document_prepend.hxx b/core/operations/document_prepend.hxx
@@ -44,6 +44,8 @@ struct prepend_request {
   using encoded_request_type = protocol::client_request<protocol::prepend_request_body>;
   using encoded_response_type = protocol::client_response<protocol::prepend_response_body>;
 
+  static const inline std::string observability_identifier = "prepend";
+
   document_id id;
   std::vector<std::byte> value;
   std::uint16_t partition{};

diff --git a/core/operations/document_query.hxx b/core/operations/document_query.hxx
@@ -80,6 +80,7 @@ struct query_request {
   using error_context_type = error_context::query;
 
   static const inline service_type type = service_type::query;
+  static const inline std::string observability_identifier = "query";
 
   std::string statement;
 

diff --git a/core/operations/document_remove.hxx b/core/operations/document_remove.hxx
@@ -44,6 +44,8 @@ struct remove_request {
   using encoded_request_type = protocol::client_request<protocol::remove_request_body>;
   using encoded_response_type = protocol::client_response<protocol::remove_response_body>;
 
+  static const inline std::string observability_identifier = "remove";
+
   document_id id;
   std::uint16_t partition{};
   std::uint32_t opaque{};

diff --git a/core/operations/document_replace.hxx b/core/operations/document_replace.hxx
@@ -44,6 +44,8 @@ struct replace_request {
   using encoded_request_type = protocol::client_request<protocol::replace_request_body>;
   using encoded_response_type = protocol::client_response<protocol::replace_response_body>;
 
+  static const inline std::string observability_identifier = "replace";
+
   document_id id;
   std::vector<std::byte> value;
   std::uint16_t partition{};

diff --git a/core/operations/document_search.hxx b/core/operations/document_search.hxx
@@ -116,6 +116,7 @@ struct search_request {
   using error_context_type = error_context::search;
 
   static const inline service_type type = service_type::search;
+  static const inline std::string observability_identifier = "search";
 
   std::string index_name;
   couchbase::core::json_string query;

diff --git a/core/operations/document_touch.hxx b/core/operations/document_touch.hxx
@@ -39,6 +39,8 @@ struct touch_request {
   using encoded_request_type = protocol::client_request<protocol::touch_request_body>;
   using encoded_response_type = protocol::client_response<protocol::touch_response_body>;
 
+  static const inline std::string observability_identifier = "touch";
+
   document_id id;
   std::uint16_t partition{};
   std::uint32_t opaque{};

diff --git a/core/operations/document_unlock.hxx b/core/operations/document_unlock.hxx
@@ -39,6 +39,8 @@ struct unlock_request {
   using encoded_request_type = protocol::client_request<protocol::unlock_request_body>;
   using encoded_response_type = protocol::client_response<protocol::unlock_response_body>;
 
+  static const inline std::string observability_identifier = "unlock";
+
   document_id id;
   std::uint16_t partition{};
   std::uint32_t opaque{};

diff --git a/core/operations/document_upsert.hxx b/core/operations/document_upsert.hxx
@@ -44,6 +44,8 @@ struct upsert_request {
   using encoded_request_type = protocol::client_request<protocol::upsert_request_body>;
   using encoded_response_type = protocol::client_response<protocol::upsert_response_body>;
 
+  static const inline std::string observability_identifier = "upsert";
+
   document_id id;
   std::vector<std::byte> value;
   std::uint16_t partition{};

diff --git a/core/operations/document_view.hxx b/core/operations/document_view.hxx
@@ -61,6 +61,7 @@ struct document_view_request {
   using error_context_type = error_context::view;
 
   static const inline service_type type = service_type::view;
+  static const inline std::string observability_identifier = "views";
 
   std::string bucket_name;
   std::string document_name;

diff --git a/core/operations/http_noop.hxx b/core/operations/http_noop.hxx
@@ -35,6 +35,8 @@ struct http_noop_request {
   using encoded_response_type = io::http_response;
   using error_context_type = error_context::http;
 
+  static const inline std::string observability_identifier = "noop";
+
   service_type type{};
 
   std::optional<std::string> client_context_id{};

diff --git a/core/operations/management/analytics_dataset_create.hxx b/core/operations/management/analytics_dataset_create.hxx
@@ -39,6 +39,7 @@ struct analytics_dataset_create_request {
   using error_context_type = error_context::http;
 
   static const inline service_type type = service_type::analytics;
+  static const inline std::string observability_identifier = "manager_analytics_create_dataset";
 
   std::string dataverse_name{ "Default" };
   std::string dataset_name;

diff --git a/core/operations/management/analytics_dataset_drop.hxx b/core/operations/management/analytics_dataset_drop.hxx
@@ -39,6 +39,7 @@ struct analytics_dataset_drop_request {
   using error_context_type = error_context::http;
 
   static const inline service_type type = service_type::analytics;
+  static const inline std::string observability_identifier = "manager_analytics_drop_dataset";
 
   std::string dataverse_name{ "Default" };
   std::string dataset_name;

diff --git a/core/operations/management/analytics_dataset_get_all.hxx b/core/operations/management/analytics_dataset_get_all.hxx
@@ -41,6 +41,7 @@ struct analytics_dataset_get_all_request {
   using error_context_type = error_context::http;
 
   static const inline service_type type = service_type::analytics;
+  static const inline std::string observability_identifier = "manager_analytics_get_all_datasets";
 
   std::optional<std::string> client_context_id{};
   std::optional<std::chrono::milliseconds> timeout{};

diff --git a/core/operations/management/analytics_dataverse_create.hxx b/core/operations/management/analytics_dataverse_create.hxx
@@ -39,6 +39,7 @@ struct analytics_dataverse_create_request {
   using error_context_type = error_context::http;
 
   static const inline service_type type = service_type::analytics;
+  static const inline std::string observability_identifier = "manager_analytics_create_dataverse";
 
   std::string dataverse_name;
 

diff --git a/core/operations/management/analytics_dataverse_drop.hxx b/core/operations/management/analytics_dataverse_drop.hxx
@@ -39,6 +39,7 @@ struct analytics_dataverse_drop_request {
   using error_context_type = error_context::http;
 
   static const inline service_type type = service_type::analytics;
+  static const inline std::string observability_identifier = "manager_analytics_drop_dataverse";
 
   std::string dataverse_name;
 

diff --git a/core/operations/management/analytics_get_pending_mutations.hxx b/core/operations/management/analytics_get_pending_mutations.hxx
@@ -40,6 +40,8 @@ struct analytics_get_pending_mutations_request {
   using error_context_type = error_context::http;
 
   static const inline service_type type = service_type::analytics;
+  static const inline std::string observability_identifier =
+    "manager_analytics_get_pending_mutations";
 
   std::optional<std::string> client_context_id{};
   std::optional<std::chrono::milliseconds> timeout{};

diff --git a/core/operations/management/analytics_index_create.hxx b/core/operations/management/analytics_index_create.hxx
@@ -39,6 +39,7 @@ struct analytics_index_create_request {
   using error_context_type = error_context::http;
 
   static const inline service_type type = service_type::analytics;
+  static const inline std::string observability_identifier = "manager_analytics_create_index";
 
   std::string dataverse_name{ "Default" };
   std::string dataset_name;

diff --git a/core/operations/management/analytics_index_drop.hxx b/core/operations/management/analytics_index_drop.hxx
@@ -39,6 +39,7 @@ struct analytics_index_drop_request {
   using error_context_type = error_context::http;
 
   static const inline service_type type = service_type::analytics;
+  static const inline std::string observability_identifier = "manager_analytics_drop_index";
 
   std::string dataverse_name{ "Default" };
   std::string dataset_name;

diff --git a/core/operations/management/analytics_index_get_all.hxx b/core/operations/management/analytics_index_get_all.hxx
@@ -41,6 +41,7 @@ struct analytics_index_get_all_request {
   using error_context_type = error_context::http;
 
   static const inline service_type type = service_type::analytics;
+  static const inline std::string observability_identifier = "manager_analytics_get_all_indexes";
 
   std::optional<std::string> client_context_id{};
   std::optional<std::chrono::milliseconds> timeout{};

diff --git a/core/operations/management/analytics_link_connect.hxx b/core/operations/management/analytics_link_connect.hxx
@@ -43,6 +43,7 @@ struct analytics_link_connect_request {
   using error_context_type = error_context::http;
 
   static const inline service_type type = service_type::analytics;
+  static const inline std::string observability_identifier = "manager_analytics_connect_link";
 
   std::string dataverse_name{ "Default" };
   std::string link_name{ "Local" };

diff --git a/core/operations/management/analytics_link_create.hxx b/core/operations/management/analytics_link_create.hxx
@@ -51,6 +51,7 @@ struct analytics_link_create_request {
   using error_context_type = error_context::http;
 
   static const inline service_type type = service_type::analytics;
+  static const inline std::string observability_identifier = "manager_analytics_create_link";
 
   analytics_link_type link{};
   std::optional<std::string> client_context_id{};

diff --git a/core/operations/management/analytics_link_disconnect.hxx b/core/operations/management/analytics_link_disconnect.hxx
@@ -43,6 +43,7 @@ struct analytics_link_disconnect_request {
   using error_context_type = error_context::http;
 
   static const inline service_type type = service_type::analytics;
+  static const inline std::string observability_identifier = "manager_analytics_disconnect_link";
 
   std::string dataverse_name{ "Default" };
   std::string link_name{ "Local" };

diff --git a/core/operations/management/analytics_link_drop.hxx b/core/operations/management/analytics_link_drop.hxx
@@ -43,6 +43,7 @@ struct analytics_link_drop_request {
   using error_context_type = error_context::http;
 
   static const inline service_type type = service_type::analytics;
+  static const inline std::string observability_identifier = "manager_analytics_drop_link";
 
   std::string link_name{};
   std::string dataverse_name{};

diff --git a/core/operations/management/analytics_link_get_all.hxx b/core/operations/management/analytics_link_get_all.hxx
@@ -48,6 +48,7 @@ struct analytics_link_get_all_request {
   using error_context_type = error_context::http;
 
   static const inline service_type type = service_type::analytics;
+  static const inline std::string observability_identifier = "manager_analytics_get_links";
 
   std::optional<std::string> link_type{};
   std::optional<std::string> link_name{};

diff --git a/core/operations/management/analytics_link_replace.hxx b/core/operations/management/analytics_link_replace.hxx
@@ -51,6 +51,7 @@ struct analytics_link_replace_request {
   using error_context_type = error_context::http;
 
   static const inline service_type type = service_type::analytics;
+  static const inline std::string observability_identifier = "manager_analytics_replace_link";
 
   analytics_link_type link{};