日志动态控制插件

相关链接

协议文件:

参考示例:

插件概述

log_control_plugin中注册了一个基于 protobuf 协议定义的 RPC,提供了针对 Log 的一些运行时管理接口。请注意,log_control_plugin没有提供任何通信后端,因此本插件一般要搭配其他通信插件的 RPC 后端一块使用,例如net_plugin中的 http RPC 后端。

插件的配置项如下:

节点

类型

是否可选

默认值

作用

service_name

string

可选

“”

RPC Service Name,不填则使用根据协议生成的默认值

以下是一个简单的配置示例,将log_control_pluginnet_plugin中的 http RPC 后端搭配使用:

aimrt:
  plugin:
    plugins:
      - name: net_plugin
        path: ./libaimrt_net_plugin.so
        options:
          thread_num: 4
          http_options:
            listen_ip: 127.0.0.1
            listen_port: 50080
      - name: log_control_plugin
        path: ./libaimrt_log_control_plugin.so
  rpc:
    backends:
      - type: http
    servers_options:
      - func_name: "(.*)"
        enable_backends: [http]

LogControlService

log_control.proto中,定义了一个LogControlService,提供了如下接口:

  • GetModuleLogLevel:获取模块日志等级;

  • SetModuleLogLevel:设置模块日志等级;

GetModuleLogLevel

GetModuleLogLevel接口用于获取某个模块的日志等级,其接口定义如下:

message GetModuleLogLevelReq {
  repeated string module_names = 1;  // if empty, then get all module
}

message GetModuleLogLevelRsp {
  uint32 code = 1;
  string msg = 2;

  map<string, string> module_log_level_map = 3;  // key: module_name
}

service ParameterService {
  // ...
  rpc GetModuleLogLevel(GetModuleLogLevelReq) returns (GetModuleLogLevelRsp);
  // ...
}

开发者在请求包GetModuleLogLevelReq中填入想要查询日志等级的模块。如果为空则返回所有模块。

以下是一个基于net_plugin中的 http RPC 后端,使用 curl 工具通过 Http 方式调用该接口的一个示例:

curl -i \
    -H 'content-type:application/json' \
    -X POST 'http://127.0.0.1:50080/rpc/aimrt.protocols.log_control_plugin.LogControlService/GetModuleLogLevel' \
    -d '{"module_names": []}'

该示例命令查询当前所有模块的日志等级,如果调用成功,该命令返回值如下:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 84

{"code":0,"msg":"","module_log_level_map":{"core":"Info","ExecutorCoModule":"Info"}}

SetModuleLogLevel

SetModuleLogLevel接口用于设置某个或某些模块的日志等级,其接口定义如下:

message SetModuleLogLevelReq {
  map<string, string> module_log_level_map = 1;
}

message SetModuleLogLevelRsp {
  uint32 code = 1;
  string msg = 2;
}


service ParameterService {
  // ...
  rpc SetModuleLogLevel(SetModuleLogLevelReq) returns (SetModuleLogLevelRsp);
  // ...
}

开发者在请求包SetModuleLogLevelReq中填入想要设置日志等级的模块以及对应的日志等级。

以下是一个基于net_plugin中的 http RPC 后端,使用 curl 工具通过 Http 方式调用该接口的一个示例:

#!/bin/bash

data='{
	"module_log_level_map": {
		"core": "Trace",
		"ExecutorCoModule": "Trace"
	}
}'

curl -i \
    -H 'content-type:application/json' \
    -X POST 'http://127.0.0.1:50080/rpc/aimrt.protocols.log_control_plugin.LogControlService/SetModuleLogLevel' \
    -d "$data"

该示例命令为coreExecutorCoModule模块设置了Trace的日志等级,如果调用成功,该命令返回值如下:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 19

{"code":0,"msg":""}