implement operation name suffix ignore matcher (#64)

Author: Shikugawa

README.md

@@ -31,11 +31,19 @@ cc_binary(
 )
 ```
 
+#### Docs
+
+cpp2sky configration is based on protobuf, and docs are generated by [protodoc](https://github.com/etcd-io/protodoc). If you have any API change, you should run below.
+
+```
+protodoc --directory=./cpp2sky --parse="message" --languages="C++" --title=cpp2sky config --output=docs/README.md
+```
+
 ## Basic usage
 
 #### Config
 
-cpp2sky provides simple configuration for tracer.
+cpp2sky provides simple configuration for tracer. API docs are available at `docs/README.md`.
 The detail information is described in [official protobuf definition](https://github.com/apache/skywalking-data-collect-protocol/blob/master/language-agent/Tracing.proto#L57-L67).
 
 ```cpp

bazel/repositories.bzl

@@ -8,6 +8,7 @@ def cpp2sky_dependencies():
   com_google_protobuf()
   com_github_httplib()
   com_github_fmtlib_fmt()
+  com_google_abseil()
   com_github_gabime_spdlog()
 
 def skywalking_data_collect_protocol():
@@ -81,3 +82,11 @@ def com_github_gabime_spdlog():
     build_file = "//bazel:spdlog.BUILD",
     urls = ["https://github.com/gabime/spdlog/archive/v1.7.0.tar.gz"]
   )
+
+def com_google_abseil():
+  http_archive(
+    name = "com_github_abseil-cpp",
+    sha256 = "e3812f256dd7347a33bf9d93a950cf356c61c0596842ff07d8154cd415145d83",
+    strip_prefix = "abseil-cpp-5d8fc9192245f0ea67094af57399d7931d6bd53f",
+    urls = ["https://github.com/abseil/abseil-cpp/archive/5d8fc9192245f0ea67094af57399d7931d6bd53f.tar.gz"],
+  )

cpp2sky/config.proto

@@ -26,6 +26,10 @@ message TracerConfig {
   // The size of buffer it stores pending messages.
   uint32 delayed_buffer_size = 6;
 
+  // If the operation name of the first span is included in this set, 
+  // this segment should be ignored.
+  repeated string ignore_operation_name_suffix = 8;
+
   // CDS sync request interval. If this value is zero, CDS feature will be disabled.
   uint32 cds_request_interval = 7;
 }

cpp2sky/internal/BUILD

@@ -28,3 +28,9 @@ cc_library(
   hdrs = ["stream_builder.h"],
   visibility = ["//visibility:public"],
 )
+
+cc_library(
+  name = "matcher_interface",
+  hdrs = ["matcher.h"],
+  visibility = ["//visibility:public"],
+)

cpp2sky/internal/matcher.h

@@ -0,0 +1,34 @@
+// Copyright 2021 SkyAPM
+
+// 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.
+
+#pragma once
+
+#include <memory>
+#include <string_view>
+
+namespace cpp2sky {
+
+class Matcher {
+ public:
+  virtual ~Matcher() = default;
+
+  /**
+   * Check whether to match rule.
+   */
+  virtual bool match(std::string_view target) = 0;
+};
+
+using MatcherPtr = std::unique_ptr<Matcher>;
+
+}  // namespace cpp2sky

cpp2sky/tracer.h

@@ -35,7 +35,7 @@ class Tracer {
   /**
    * Send SegmentContext to the collector.
    */
-  virtual void report(TracingContextPtr obj) = 0;
+  virtual bool report(TracingContextPtr obj) = 0;
 };
 
 using TracerPtr = std::unique_ptr<Tracer>;

docs/README.md

@@ -0,0 +1,18 @@
+### cpp2sky
+
+
+##### message `TracerConfig` (cpp2sky/config.proto)
+
+| Field | Description | Type | C++ |
+| ----- | ----------- | ---- | --- |
+| protocol | Tracer protocol. | Protocol | |
+| service_name | Service name | string | string |
+| instance_name | Instance name | string | string |
+| address | OAP address. | string | string |
+| token | OAP token. | string | string |
+| delayed_buffer_size | The size of buffer it stores pending messages. | uint32 | uint32 |
+| ignore_operation_name_suffix | If the operation name of the first span is included in this set, this segment should be ignored. | (slice of) string | (slice of) string |
+| cds_request_interval | CDS sync request interval. If this value is zero, CDS feature will be disabled. | uint32 | uint32 |
+
+
+

source/BUILD

@@ -27,8 +27,10 @@ cc_library(
     "@com_github_gabime_spdlog//:spdlog",
     "//cpp2sky/internal:async_client_interface",
     "//cpp2sky/internal:stream_builder_interface",
+    "//cpp2sky/internal:matcher_interface",
     "//cpp2sky:cpp2sky_interface",
     "//source/utils:util_lib",
+    "//source/matchers:suffix_matcher_lib",
   ],
   visibility = ["//visibility:public"],
 )
@@ -50,16 +52,18 @@ cc_library(
     "@com_github_gabime_spdlog//:spdlog",
     "//cpp2sky/internal:async_client_interface",
     "//cpp2sky/internal:stream_builder_interface",
+    "//cpp2sky/internal:matcher_interface",
     "//cpp2sky:cpp2sky_interface",
     "//source/utils:util_lib",
+    "//source/matchers:suffix_matcher_lib",
   ],
   copts = ["-DGRPC_TEST"],
   visibility = ["//visibility:public"],
 )
 
 cc_library(
   name = "cpp2sky_data_lib",
-  hdrs  =[
+  hdrs = [
     "propagation_impl.h",
     "tracing_context_impl.h",
     "dynamic_config.h",

source/matchers/BUILD

@@ -0,0 +1,12 @@
+load("@rules_cc//cc:defs.bzl", "cc_library")
+
+cc_library(
+  name = "suffix_matcher_lib",
+  hdrs = ["suffix_matcher.h"],
+  srcs = ["suffix_matcher.cc"],
+  deps = [
+    "@com_github_abseil-cpp//absl/strings:strings",
+    "//cpp2sky/internal:matcher_interface",
+  ],
+  visibility = ["//visibility:public"],
+)

source/matchers/suffix_matcher.cc

@@ -0,0 +1,31 @@
+// Copyright 2021 SkyAPM
+
+// 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.
+
+#include "suffix_matcher.h"
+
+#include "absl/strings/match.h"
+
+namespace cpp2sky {
+
+bool SuffixMatcher::match(std::string_view target) {
+  for (const auto& ignore_suffix : target_suffixes_) {
+    if (absl::EndsWith(target, ignore_suffix)) {
+      return true;
+    }
+  }
+
+  return false;
+}
+
+}  // namespace cpp2sky