operations使用研究

简介

operations支持在peer或者orderer运行过程中，提供基于restful接口的运维服务。包括健康检查、日志level管理、指标metrics接口等。首先利用test-network启动一个测试网络。

配置

具体配置项可见sampleconfig/core.yaml和sampleconfig/orderer.yaml。

operations的启动

以peer节点为例，operations服务的启动在peer启动的过程中完成的，启动依赖配置如下:

func newOperationsSystem(coreConfig *peer.Config) *operations.System {
	return operations.NewSystem(operations.Options{
		Logger:        flogging.MustGetLogger("peer.operations"),
		ListenAddress: coreConfig.OperationsListenAddress,
		Metrics: operations.MetricsOptions{
			Provider: coreConfig.MetricsProvider,
			Statsd: &operations.Statsd{
				Network:       coreConfig.StatsdNetwork,
				Address:       coreConfig.StatsdAaddress,
				WriteInterval: coreConfig.StatsdWriteInterval,
				Prefix:        coreConfig.StatsdPrefix,
			},
		},
		TLS: operations.TLS{
			Enabled:            coreConfig.OperationsTLSEnabled,
			CertFile:           coreConfig.OperationsTLSCertFile,
			KeyFile:            coreConfig.OperationsTLSKeyFile,
			ClientCertRequired: coreConfig.OperationsTLSClientAuthRequired,
			ClientCACertFiles:  coreConfig.OperationsTLSClientRootCAs,
		},
		Version: metadata.Version,
	})
}

包括监听地址、metrics相关配置、TLS配置等，即示例core.yaml或orderer.yaml中的配置。

version接口

curl --request GET '127.0.0.1:19051/version'

返回结果：

{"CommitSHA":"7f22e99","Version":"2.2.7"}

查看version接口的处理：

func (s *System) initializeVersionInfoHandler() {
	versionInfo := &VersionInfoHandler{
		CommitSHA: metadata.CommitSHA,
		Version:   metadata.Version,
	}
	s.mux.Handle("/version", s.handlerChain(versionInfo, false))
}

可知版本信息在metadata包内定义，查看Makefile文件如下：

# defined in common/metadata/metadata.go
METADATA_VAR = Version=$(BASE_VERSION)
METADATA_VAR += CommitSHA=$(EXTRA_VERSION)
METADATA_VAR += BaseDockerLabel=$(BASE_DOCKER_LABEL)
METADATA_VAR += DockerNamespace=$(DOCKER_NS)

在编译过程中将metadata写入。

日志level管理

查询请求：

curl --location --request GET '127.0.0.1:19051/logspec'

结果：

{"spec":"info"}

修改日志级别：

curl --request PUT '127.0.0.1:19051/logspec' --header 'Content-Type: application/json' --data '{ "spec": "info"}'

针对某个模块调整日志级别：

curl --request PUT '127.0.0.1:19051/logspec' --header 'Content-Type: application/json' --data '{ "spec": "gossip.discovery=debug"}'

此时gossip服务的discovery相关日志为debug级别，其他的仍为info级别。如果调用Get logspec，此时返回为

{"spec":"gossip.discovery=debug:info"}

代表gossip.discovery为debug日志，其余为info日志。

示例1：

curl --request PUT '127.0.0.1:19051/logspec' --header 'Content-Type: application/json' --data '{ "spec": "gossip.discovery=debug:ledgermgmt=info:debug"}'

健康检查

curl --request GET '127.0.0.1:19051/healthz'

结果：

{"status":"OK","time":"2022-07-19T16:30:14.507389245Z"}

可以用于存活探针。

指标

支持prometheus和statsd两种采集方式，statsd不了解，只讨论使用promethues采集指标的方式。在peer启动配置文件中添加配置如下:

- CORE_OPERATIONS_LISTENADDRESS=0.0.0.0:19051
- CORE_METRICS_PROVIDER=prometheus

然后访问19051端口的/metrics的接口即可得到节点中的指标数据。在promethues配置中添加monitor指向19051端口，即可在promethues中查询到指标数据。