【腾讯犀牛鸟开源课题实战】prometheus插件专项建设（PUSH模式支持等）

.bazelrc

@@ -3,3 +3,5 @@ build --copt=-O2
 #build --copt=-g --strip=never
 build --jobs 16
 #test --cache_test_results=no --test_output=errors
+
+build --define trpc_include_prometheus=true

docs/zh/prometheus_metrics.md

@@ -99,6 +99,7 @@ client:
 | aApp | 主调app名 |
 | aServer | 主调server名 |
 | aService | 主调service名 |
+| aIp | 主调ip地址 |
 | pApp | 被调app名 |
 | pServer | 被调server名 |
 | pService | 被调service名 |
@@ -109,6 +110,7 @@ client:
 | frame_ret_code | 调用的框架错误码 |
 | interface_ret_code | 调用的接口错误码 |
 
+
 ### 被调监控上报
 
 只需在框架配置文件的 `server` 中加上 `prometheus` 拦截器，即可开启被调监控：
@@ -124,7 +126,6 @@ server:
 
 统计数据：
 
-```mermaid
 | 监控名 | 监控类型 | 说明 |
 | ------ | ------ | ------ |
 | rpc_server_counter_metric | Counter | 服务端收到的请求总次数 |
@@ -149,7 +150,7 @@ server:
 | pConSetId | 被调所属set |
 | frame_ret_code | 调用的框架错误码 |
 | interface_ret_code | 调用的接口错误码 |
-```
+
 
 ## 属性监控上报
 
@@ -314,7 +315,7 @@ single_metrics_info.single_attr_info.value = 1;
 
 #### 通用多维属性上报
 
-Prometheus 监控插件支持框架通用的多维属性上报方式，即通过构造 `::trpc::TrpcMultiAttrMetricsInfo` 然后使用`::trpc::metrics::MultiAttrReport`接口来上报。**Prometheus 的单维属性上报是指上报统计标签包含多个键值对的数据。**。
+Prometheus 监控插件支持框架通用的多维属性上报方式，即通过构造 `::trpc::TrpcMultiAttrMetricsInfo` 然后使用`::trpc::metrics::MultiAttrReport`接口来上报。**Prometheus 的多维属性上报是指上报统计标签包含多个键值对的数据。**。
 
 设置 `::trpc::TrpcMultiAttrMetricsInfo` 值需要注意：
 

examples/features/prometheus/proxy/BUILD

@@ -44,3 +44,13 @@ cc_library(
         "@trpc_cpp//trpc/metrics/prometheus:prometheus_metrics_api",
     ],
 )
+
+cc_binary(
+    name = "push",
+    srcs = ["push.cc"],
+    deps = [
+        "@trpc_cpp//trpc/metrics/prometheus:prometheus_metrics_api",
+        "@trpc_cpp//trpc/log:trpc_log",
+
+    ],
+)

examples/features/prometheus/proxy/forward_service.cc

@@ -77,6 +77,12 @@ ::trpc::Status ForwardServiceImpl::Route(::trpc::ServerContextPtr context,
       "counter_name", "counter_desc", {{"const_counter_key", "const_counter_value"}});
   ::prometheus::Counter& counter = counter_family->Add({{"counter_key", "counter_value"}});
   counter.Increment(random_num);
+
+  if (::trpc::prometheus::PushMetricsInfo()) {
+        TRPC_FMT_INFO("Successfully pushed metrics to Pushgateway");
+    } else {
+        TRPC_FMT_ERROR("Failed to push metrics to Pushgateway");
+    }
 #endif
 
   auto client_context = ::trpc::MakeClientContext(context, greeter_proxy_);

examples/features/prometheus/proxy/push.cc

@@ -0,0 +1,22 @@
+#include <chrono>
+#include <thread>
+#include "trpc/metrics/prometheus/prometheus_metrics_api.h"
+#include "trpc/log/trpc_log.h"
+
+
+
+int main(int argc, char** argv) {
+
+   while (true) {
+        if (::trpc::prometheus::PushMetricsInfo())
+            {
+                std::cout << "Successfully pushed metrics to Pushgateway" << std::endl;
+            } else {
+                std::cerr << "Failed to push metrics to Pushgateway" << std::endl;
+            }
+
+        std::this_thread::sleep_for(std::chrono::seconds(5)); // 每60秒推送一次
+    }
+
+    return 0;
+}

examples/features/prometheus/proxy/trpc_cpp_fiber.yaml

@@ -44,6 +44,11 @@ plugins:
       const_labels:
         const_key1: const_value1
         const_key2: const_value2
+      push_mode:
+        enabled: true
+        gateway_url: "http://pushgateway:9091"
+        job_name: "test_job"
+        push_interval_seconds: 2
   log:
     default:
       - name: default

examples/features/prometheus/run.sh

@@ -6,7 +6,7 @@ echo "begin"
 sleep 1
 ./bazel-bin/examples/features/prometheus/proxy/forward_server --config=examples/features/prometheus/proxy/trpc_cpp_fiber.yaml &
 sleep 1
-./bazel-bin/examples/features/prometheus/client/client_config --config=examples/features/prometheus/client/trpc_cpp_fiber.yaml
+./bazel-bin/examples/features/prometheus/client/client --client_config=examples/features/prometheus/client/trpc_cpp_fiber.yaml
 
 killall helloworld_svr
 if [ $? -ne 0 ]; then

trpc/admin/BUILD

@@ -354,13 +354,19 @@ cc_library(
         ":admin_handler",
         ":base_funcs",
         "//trpc/util:prometheus",
+        "//trpc/common/config:trpc_config",
+        "//trpc/log:trpc_log",
+        "//trpc/util/http:base64",
+        "//trpc/util/string:string_helper",
     ] + select({
         "//conditions:default": [],
         "//trpc:trpc_include_prometheus": [
             "@com_github_jupp0r_prometheus_cpp//pull",
+            "//trpc/metrics/prometheus:prometheus_metrics",
         ],
         "//trpc:include_metrics_prometheus": [
             "@com_github_jupp0r_prometheus_cpp//pull",
+            "//trpc/metrics/prometheus:prometheus_metrics",
         ],
     }),
 )

trpc/admin/admin_service.cc

@@ -117,7 +117,9 @@ AdminService::AdminService() {
 
 #ifdef TRPC_BUILD_INCLUDE_PROMETHEUS
   // Prometheus metrics.
-  RegisterCmd(http::OperationType::GET, "/metrics", std::make_shared<admin::PrometheusHandler>());
+  auto prometheus_handle_ptr = std::make_shared<admin::PrometheusHandler>();
+  prometheus_handle_ptr->Init();
+  RegisterCmd(http::OperationType::GET, "/metrics", prometheus_handle_ptr);
 #endif
 
   RegisterCmd(http::OperationType::POST, "/client_detach", std::make_shared<admin::ClientDetachHandler>());

trpc/admin/prometheus_handler.cc

@@ -20,10 +20,62 @@ namespace trpc::admin {
 
 PrometheusHandler::PrometheusHandler() { description_ = "[GET /metrics] get prometheus metrics"; }
 
+void PrometheusHandler::Init() {
+  PrometheusConfig prometheus_conf;
+  bool ret = TrpcConfig::GetInstance()->GetPluginConfig<PrometheusConfig>(
+      "metrics", trpc::prometheus::kPrometheusMetricsName, prometheus_conf);
+  if (!ret) {
+    TRPC_LOG_WARN(
+        "Failed to obtain Prometheus plugin configuration from the framework configuration file. Default configuration "
+        "will be used.");
+  }
+  auto& cfg = prometheus_conf.auth_cfg;
+  if (cfg.count("username") && cfg.count("password")) {
+    auth_conf_.username = cfg["username"];
+    auth_conf_.password = cfg["password"];
+  } else {
+    TRPC_LOG_WARN("can not found prometheus auth config");
+  }
+}
+
+bool PrometheusHandler::CheckAuth(std::string token) {
+  auto splited = Split(token, ' ');
+  if (splited.size() != 2) {
+    TRPC_FMT_ERROR("error token: {}", token);
+    return false;
+  }
+  if (splited[0] != "Basic") {
+    TRPC_FMT_ERROR("error token: {}", token);
+    return false;
+  }
+
+  std::string username_pwd = http::Base64Decode(std::begin(splited[1]), std::end(splited[1]));
+  auto sp = Split(username_pwd, ':');
+  if (sp.size() != 2) {
+    TRPC_FMT_ERROR("error token: {}", token);
+    return false;
+  }
+
+  auto username = sp[0], pwd = sp[1];
+  if (username != auth_conf_.username || pwd != auth_conf_.password) {
+    TRPC_FMT_ERROR("error username or password: username: {}, password: {}", username, pwd);
+    return false;
+  }
+  return true;
+}
+
 void PrometheusHandler::CommandHandle(http::HttpRequestPtr req, rapidjson::Value& result,
                                       rapidjson::Document::AllocatorType& alloc) {
   static std::unique_ptr<::prometheus::Serializer> serializer = std::make_unique<::prometheus::TextSerializer>();
 
+  if (auth_conf_.username.size() && auth_conf_.password.size()) {
+    std::string token = req->GetHeader("authorization");
+    if (!CheckAuth(token)) {
+      result.AddMember("message", "wrong request without right username or password", alloc);
+      return;
+    }
+  }
+
   std::string prometheus_str = serializer->Serialize(trpc::prometheus::Collect());
   result.AddMember(rapidjson::StringRef("trpc-html"), rapidjson::Value(prometheus_str, alloc).Move(), alloc);
 }

trpc/admin/prometheus_handler.h

@@ -15,7 +15,13 @@
 #pragma once
 
 #include "trpc/admin/admin_handler.h"
+#include "trpc/common/config/trpc_config.h"
+#include "trpc/log/trpc_log.h"
+#include "trpc/metrics/prometheus/prometheus_metrics.h"
+#include "trpc/util/http/base64.h"
 #include "trpc/util/prometheus.h"
+#include "trpc/util/string/string_helper.h"
+#include "trpc/util/time.h"
 
 namespace trpc::admin {
 
@@ -24,8 +30,18 @@ class PrometheusHandler : public AdminHandlerBase {
  public:
   PrometheusHandler();
 
+  void Init();
+
   void CommandHandle(http::HttpRequestPtr req, rapidjson::Value& result,
                      rapidjson::Document::AllocatorType& alloc) override;
+
+ private:
+  bool CheckAuth(std::string token);
+
+  struct AuthConf {
+    std::string username;
+    std::string password;
+  } auth_conf_;
 };
 
 }  // namespace trpc::admin

trpc/common/plugin.h

@@ -71,7 +71,7 @@ class Plugin : public RefCounted<Plugin> {
 
   /// @brief Stop the runtime environment of the plugin
   virtual void Stop() noexcept {}
-
+  
   /// @brief destroy plugin internal resources
   virtual void Destroy() noexcept {}
 

trpc/metrics/prometheus/BUILD

@@ -9,6 +9,16 @@ filegroup(
     ]),
 )
 
+cc_library(
+    name = "prometheus_pusher",
+    srcs = ["prometheus_pusher.cc"],
+    hdrs = ["prometheus_pusher.h"],
+    deps = [
+        "//trpc/util/log:logging",
+        "@com_github_jupp0r_prometheus_cpp//push",
+    ],
+)
+
 cc_library(
     name = "prometheus_conf",
     srcs = ["prometheus_conf.cc"],
@@ -73,15 +83,20 @@ cc_library(
         ":prometheus_conf",
         ":prometheus_conf_parser",
         "//trpc/util:prometheus",
+        "@com_github_jupp0r_prometheus_cpp//core",
+
         "//trpc/common/config:trpc_config",
+        ":prometheus_pusher",
         "//trpc/metrics",
     ] + select({
         "//conditions:default": [],
         "//trpc:trpc_include_prometheus": [
             "@com_github_jupp0r_prometheus_cpp//pull",
+            "@com_github_jupp0r_prometheus_cpp//push",
         ],
         "//trpc:include_metrics_prometheus": [
             "@com_github_jupp0r_prometheus_cpp//pull",
+            "@com_github_jupp0r_prometheus_cpp//push",
         ],
     }),
 )

trpc/metrics/prometheus/prometheus_conf.cc

@@ -30,7 +30,52 @@ void PrometheusConfig::Display() const {
     TRPC_LOG_DEBUG(label.first << ":" << label.second);
   }
 
+  TRPC_LOG_DEBUG("auth_cfg:");
+  for (auto label : auth_cfg) {
+    TRPC_LOG_DEBUG(label.first << ":" << label.second);
+  }
+
   TRPC_LOG_DEBUG("--------------------------------");
 }
 
 }  // namespace trpc
+
+namespace YAML {
+
+YAML::Node convert<trpc::PrometheusConfig>::encode(const trpc::PrometheusConfig& config) {
+  YAML::Node node;
+  node["histogram_module_cfg"] = config.histogram_module_cfg;
+  node["const_labels"] = config.const_labels;
+  node["auth_cfg"] = config.auth_cfg;
+  node["push_mode"]["enabled"] = config.push_mode.enabled;
+  if (config.push_mode.enabled) {
+    node["push_mode"]["gateway_url"] = config.push_mode.gateway_url;
+    node["push_mode"]["job_name"] = config.push_mode.job_name;
+    node["push_mode"]["push_interval_seconds"] = config.push_mode.push_interval_seconds;
+  }
+  return node;
+}
+
+bool convert<trpc::PrometheusConfig>::decode(const YAML::Node& node, trpc::PrometheusConfig& config) {
+  if (node["histogram_module_cfg"]) {
+    config.histogram_module_cfg = node["histogram_module_cfg"].as<std::vector<double>>();
+  }
+  if (node["const_labels"]) {
+    config.const_labels = node["const_labels"].as<std::map<std::string, std::string>>();
+  }
+  if (node["auth_cfg"]) {
+    config.auth_cfg = node["auth_cfg"].as<std::map<std::string, std::string>>();
+  }
+  if (node["push_mode"]) {
+    const auto& push_mode = node["push_mode"];
+    config.push_mode.enabled = push_mode["enabled"].as<bool>(false);
+    if (config.push_mode.enabled) {
+      config.push_mode.gateway_url = push_mode["gateway_url"].as<std::string>();
+      config.push_mode.job_name = push_mode["job_name"].as<std::string>();
+      config.push_mode.push_interval_seconds = push_mode["push_interval_seconds"].as<int>(15);
+    }
+  }
+  return true;
+}
+
+}  // namespace YAML

trpc/metrics/prometheus/prometheus_conf.h

@@ -29,7 +29,26 @@ struct PrometheusConfig {
   /// The default label attached to each RPC metrics data
   std::map<std::string, std::string> const_labels;
 
+  std::map<std::string, std::string> auth_cfg;
+
+  struct PushMode {
+    bool enabled = false;
+    std::string gateway_url;
+    std::string job_name;
+    int push_interval_seconds = 15;
+  } push_mode;
+
   void Display() const;
 };
 
 }  // namespace trpc
+
+namespace YAML {
+
+template <>
+struct convert<trpc::PrometheusConfig> {
+  static YAML::Node encode(const trpc::PrometheusConfig& config);
+  static bool decode(const YAML::Node& node, trpc::PrometheusConfig& config);
+};
+
+}  // namespace YAML

trpc/metrics/prometheus/prometheus_conf_parser.h

@@ -25,6 +25,7 @@ struct convert<trpc::PrometheusConfig> {
     YAML::Node node;
     node["histogram_module_cfg"] = conf.histogram_module_cfg;
     node["const_labels"] = conf.const_labels;
+    node["auth_cfg"] = conf.auth_cfg;
 
     return node;
   }
@@ -37,6 +38,10 @@ struct convert<trpc::PrometheusConfig> {
     if (node["const_labels"]) {
       conf.const_labels = node["const_labels"].as<std::map<std::string, std::string>>();
     }
+
+    if (node["auth_cfg"]) {
+      conf.auth_cfg = node["auth_cfg"].as<std::map<std::string, std::string>>();
+    }
     return true;
   }
 };