TARS 服务信息上报｜全方位服务监控

原创

于 2020-12-24 11:49:18 发布 · 1.1k 阅读

文章标签：

本文详细介绍了TARS框架中的服务信息上报功能，包括状态统计上报、异常上报和属性统计上报，帮助开发者实现多维度的服务监控。通过Stat、Notify、Property节点，服务能主动报告状态、异常和业务属性，确保服务的健康运行。TarsCpp和TarsGo的异常上报示例展示了如何在代码中实现异常通知。属性统计上报则允许开发者统计业务相关属性，如队列大小的六种统计策略。通过这些上报方式，开发者能更好地管理和维护服务。

作者 | Eaton

导语 | 服务上线运营后，出现异常是难免的事，通常情况下会通过服务日志排查问题。然而这种排查问题的方式有时候是低效的，特别是日志比较多，还不知道如何下手的时候，非常麻烦。那让服务主动报告出现的错误不就行了吗？本文将对 TARS 中的几种信息上报方式进行介绍。

简介

TARS 框架中集成了服务信息上报的功能，包含了服务的状态统计上报、异常上报、属性统计上报等三个信息上报统计方式，实现对服务健康程度的多方面监控。这三种信息上报方式分别通过 Stat、Notify、Property 这三个节点实现。如下图

在这里插入图片描述

服务通过向这三个节点报告自身不同维度的信息，实现对服务状态的监控。那么接下来我们来了解这三种信息上报方式吧。

状态统计上报

所谓的状态统计上报，就是在 TARS 框架中，服务向 Stat 上报自身的调用耗时、超时率、异常率等状态信息并进行统计。

服务调用上报接口后，实际上是先暂存在内存中，当到达某个时间点后才正式上报到 Stat 服务（默认是1分钟上报一次）。我们称两个上报时间点之间的时间为一个统计区间，在一个统计区间相同 key 进行累加、对比等操作。

状态统计上报一般不需用户额外开发，服务在 TARS 框架中正确配置并部署后，即可自动上报。

打开 TarsWeb 的服务管理页面，在具体服务的 服务监控 页面中可以看到对应服务相关的状态信息，包括流量、平均耗时、超时率等，如下图。

在这里插入图片描述

异常上报

服务状态统计上报能够直观地了解服务的状态和健康度。不过实际使用场景中，仅统计一些服务的调用信息是不够的。为了更好监控，TARS 框架支持在服务中将异常直接上报到 Notify，并可以在 TarsWeb 管理页面上查看到，或结合别的告警软件或平台直接通知用户。TARS 不同语言版本中都提供了异常上报方式。本部分将分别基于 TarsCpp 和 TarsGo 举例介绍，其他语言版本类似。

TarsCpp

TarsCpp 中提供了一种异常上报方式，即使用 RemoteNotify::report 来上报异常，用法如下

RemoteNotify::getInstance()->report(info);

参数 info 为需要上报的异常信息，类型为 string 字符串, 可以直接上报字符串到 Notify，页面可以看到上报的字符串。例如我们创建一个服务名为 Demo.DemoServer.DemoObj 的 TarsCpp 服务，创建命令如下

/usr/local/tars/cpp/script/cmake_tars_server.sh TestDemo DemoServer Demo

项目目录结构如下

DemoServer
├── build                   # 构建目录
├── CMakeLists.txt          # cmake 构建文件
└── src                     # 源文件目录
    ├── CMakeLists.txt
    ├── Demo.h              # Demo.tars 生成文件
    ├── DemoImp.cpp         # 接口实现文件
    ├── DemoImp.h           # 接口实现头文件
    ├── DemoServer.cpp      # 服务实现文件
    ├── DemoServer.h        # 服务实现头文件
    └── Demo.tars           # tars 接口定义文件

接着在 DemoServer.cpp 的服务初始化函数 DemoServer::initialize 中上报一条信息，这样服务在启动时，就会上报一条 DemoServer Start 的信息，如下

void
DemoServer::initialize()
{
   
   
    addServant<DemoImp>(ServerConfig::Application + "." + ServerConfig::ServerName + ".DemoObj");
    // 上报信息
    RemoteNotify::getInstance()->report("DemoServer Start");
}

将服务编译部署后，可以在 TarsWeb 上服务的实时状态中看到服务上报的信息，如下图

在这里插入图片描述

TarsGo

TarsGo 中提供了如下函数来上报异常信息，用法和前面 TarsCpp 的相似

func ReportNotifyInfo(level int32, info string)

level 指的是异常等级，分为 NOTIFY_NORMAL, NOTIFY_WARN, NOTIFY_ERROR，info 则为上报的信息。

我们通过以下命令创建一个 TarsGo 服务 Demo.NotifyDemo.DemoObj

$GOPATH/src/github.com/TarsCloud/TarsGo/tars/tools/cmake_tars_server.sh Demo NotifyDemo Demo github.com/ETZhangSX/NotifyDemo

项目目录结构如下

NotifyDemo
├── build
├── client
│   ├── client.go
│   └── CMakeLists.txt
├── CMakeLists.txt
├── config.conf
├── debugtool
│   └── dumpstack.go
├── demo_imp.go
├── Demo.tars
├── go.mod
├── go.sum
├── main.go
├── start.sh
└── tars-protocol

同 TarsCpp 相似，我们在 demo_imp.cpp 的 Init 中添加异常上报