Sentinel-Go 源码系列(二)|初始化流程和责任链设计模式
上节中我们知道了 Sentinel-Go 大概能做什么事情,最简单的例子如何跑起来
其实我早就写好了本系列的第二篇,但迟迟没有发布,感觉光初始化流程显得有些单一,于是又补充了责任链模式,二合一,内容显得丰富一些。
初始化流程
初始化做了什么
Sentinel-Go 初始化时主要做了以下2件事情:
- 通过各种方式(文件、环境变量等)载入全局配置
- 启动异步的定时任务或服务,如机器 cpu、内存信息收集、metric log 写入等等
初始化流程详解
提供的 API
上节例子中,我们使用了最简单的初始化方式
func InitDefault() error
除此之外,它还提供了另外几种初始化方式
// 使用给定的 parser 方法解析配置的方式来初始化
func InitWithParser(configBytes []byte, parser func([]byte) (*config.Entity, error)) (err error)
// 使用已解析好的配置对象初始化
func InitWithConfig(confEntity *config.Entity) (err error)
// 从 yaml 文件加载配置初始化
func InitWithConfigFile(configPath string) error
从命名能看出它们只是配置的获取方式不一样,其中InitWithParser
有点意思,传入的 parser
是个函数指针,对于 Java 写惯了的我来说还是有点陌生,比如通过 json
解析可以写出如下 parser
parser := func(configBytes []byte) (*config.Entity, error) {
conf := &config.Entity{}
err := json.Unmarshal(configBytes, conf)
return conf, err
}
conf := "{\"Version\":\"v1\",\"Sentinel\":{\"App\":{\"Name\":\"roshi-app\",\"Type\":0}}}"
err := api.InitWithParser([]byte(conf), parser)
配置项
简单看一下 Sentinel-Go 的配置项,首先配置被包装在一个 Entity
中,包含了一个 Version
和 真正的配置信息 SentinelConfig
type Entity struct {
Version string
Sentinel SentinelConfig
}
接着, SentinelConfig
是这样:
type SentinelConfig struct {
App struct {
// 应用名
Name string
// 应用类型:普通应用,网关
Type int32
}
// Exporter 配置
Exporter ExporterConfig
// 日志配置
Log LogConfig
// 统计配置
Stat StatConfig
// 是否缓存时间戳
UseCacheTime bool `yaml:"useCacheTime"`
}
- App 应用信息
- 应用名
- 应用类型:如普通应用、网关应用等
- ExporterConfig:prometheus exporter 暴露服务的端口和 path
type ExporterConfig struct {
Metric MetricExporterConfig
}
type MetricExporterConfig struct {
// http 服务地址,如 ":8080"
HttpAddr string `yaml:"http_addr"`
// http 服务 path,如"/metrics".
HttpPath string `yaml:"http_path"`
}
- LogConfig:包括使用什么logger,日志目录,文件是否使用 pid(防止一台机器部署两个应用日志混合),以及 metric log 的单个文件大小、最多保留文件个数、刷新时间
type LogConfig struct {
// logger,可自定义
Logger logging.Logger
// 日志目录
Dir string
// 是否在日志文件后加 PID
UsePid bool `yaml:"usePid"`
// metric 日志配置
Metric MetricLogConfig
}
type MetricLogConfig struct {
// 单个文件最大占用空间
SingleFileMaxSize uint64 `yaml:"singleFileMaxSize"`
// 最多文件个数
MaxFileCount uint32 `yaml:"maxFileCount"`
// 刷新间隔
FlushIntervalSec uint32 `yaml:"flushIntervalSec"`
}
- StatConfig:统计配置包括资源采集窗口配置,metric 统计的窗口、系统信息收集间隔
type StatConfig struct {
// 全局统计资源的窗口(后续文章再解释)
GlobalStatisticSampleCountTotal uint32 `yaml:"globalStatisticSampleCountTotal"`
GlobalStatisticIntervalMsTotal uint32 `yaml:"globalStatisticIntervalMsTotal"`
// metric 统计的窗口(后续文章再解释)
MetricStatisticSampleCount uint32 `yaml:"metricStatisticSampleCount"`
MetricStatisticIntervalMs uint32 `yaml:"metricStatisticIntervalMs"`
// 系统采集配置
System SystemStatConfig `yaml:"system"`
}
type SystemStatConfig struct {
// 采集默认间隔
CollectIntervalMs uint32 `yaml:"collectIntervalMs"`
// 采集 cpu load 间隔
CollectLoadIntervalMs uint32 `yaml:"collectLoadIntervalMs"`
// 采集 cpu 使用间隔
CollectCpuIntervalMs uint32 `yaml:"collectCpuIntervalMs"`
// 采集内存间隔使用
CollectMemoryIntervalMs uint32 `yaml:"collectMemoryIntervalMs"`
}
配置覆盖
从上文知道,参数可以通过自定义 parser
/ 文件
/ 默认
的方式来传入配置,但后面这个配置还可以用系统的环境变量
覆盖,覆盖项目前只包括应用名、应用类型、日志文件使用使用 PID
结尾、日志目录
func OverrideConfigFromEnvAndInitLog() error {
// 系统环境变量可覆盖传入的配置
err := overrideItemsFromSystemEnv()
if err != nil {
return err
}
...
return nil
}
启动后台服务
- 启动 聚合 metric 定时任务,聚合后发送到 chan,聚合后的格式如下:
_, err := fmt.Fprintf(&b, "%d|%s|%s|%d|%d|%d|%d|%d|%d|%d|%d",
m.Timestamp, timeStr, finalName, m.PassQps,
m.BlockQps, m.CompleteQps, m.ErrorQps, m.AvgRt,
m.OccupiedPassQps, m.Concurrency, m.Classification)
时间戳|时间字符串|名称|通过QPS|阻断QPS|完成QPS|出错QPS|平均RT|已经通过QPS|并发|类别
启动 metric 写入日志定时任务,可配置间隔时间(秒级),接受上个任务写入 chan 的数据
启动单独 goroutine 收集 cpu 使用率 / load、内存使用,收集间隔可配置,收集到的信息存放在
system_metric
下的私有变量
var (
currentLoad atomic.Value
currentCpuUsage atomic.Value
currentMemoryUsage atomic.Value
)
- 若开启,则启动单独 goroutine 缓存时间戳,间隔是 1ms,这个主要是为了高并发下提高获取时间戳的性能
func (t *RealClock) CurrentTimeMillis() uint64 {
// 从缓存获取时间戳
tickerNow := CurrentTimeMillsWithTicker()
if tickerNow > uint64(0) {
return tickerNow
}
return uint64(time.Now().UnixNano()) / UnixTimeUnitOffset
}
获取时,如果拿到 0 则说明未开启缓存时间戳,取当前,如果拿到值说明已开启,可直接使用
- 若配置了 metric exporter,则启动服务,监听端口,暴露 prometheus 的 exporter
责任链模式
什么是责任链模式
可以用这样一张图形象地解释什么是责任链:
责任链模式为每次请求创建了一个链
,链上有 N 多个处理者,处理者可在不同阶段处理不同的事情,就像这幅图上的小人,拿到一桶水(请求)后都可以完成各自的事情,比如往头上浇,然后再传递给下一个。
为什么叫责任?因为每个处理者只关心自己的责任
,跟自己没关系就递交给链上的下一个处理者。
责任链在哪里有用到?很多开源产品都是用了责任链模式,如 Dubbo
、Spring MVC
等等
这么设计有什么好处?
- 简化编码难度,抽象出处理模型,只需关注关心的点即可
- 扩展性好,如果需要自定义责任链中的一环或者插拔某一环,非常容易实现
关于扩展性除了大家理解的软件设计中的扩展性外,这里还想提两点,阿里开源的软件其实都有高扩展性这个特性,一是因为是开源,别人使用场景未必和自己一致,留出扩展接口,不符合要求的,用户可以自行实现,二是如果要追溯,阿里开源扩展性 Dubbo 可能算是祖师爷(未考证),Dubbo 作者(梁飞)的博客中说过为什么 Dubbo 要设计这么强的扩展性,他对代码有一定的追求,在他维护时期,代码能保证高质量,但如果项目交给别人,如何才能保持现在的水准呢?于是他设计出一套很强的扩展,后面开发基于这个扩展去做,代码就不会差到哪里去
- 可动态,可针对每个请求构造不同的责任链
Sentinel-Go 责任链设计
先看责任链的数据结构定义,Sentinel-Go 把处理者叫 Slot
(插槽),将 Slot 分为了前置统计、规则校验、统计三组,且每组是有有序的
type SlotChain struct {
// 前置准备(有序)
statPres []StatPrepareSlot
// 规则校验(有序)
ruleChecks []RuleCheckSlot
// 统计(有序)
stats []StatSlot
// 上线文对象池(复用对象)
ctxPool *sync.Pool
}
在调用 Entry
开始进入 Sentinel 逻辑时,如果没有手动构造 SlotChain,则使用默认。
为什么这里要设计成三个 Slot组呢?因为每组 Slot 的行为稍有不同,比如前置准备的 Slot 不需要返回值,规则校验组需要返回值,如果校验当前流量不通过,还需要返回原因、类型等信息,统计 Slot 还会有一些入参,比如请求是否失败等等
type BaseSlot interface {
Order() uint32
}
type StatPrepareSlot interface {
BaseSlot
Prepare(ctx *EntryContext)
}
type RuleCheckSlot interface {
BaseSlot
Check(ctx *EntryContext) *TokenResult
}
type StatSlot interface {
BaseSlot
OnEntryPassed(ctx *EntryContext)
OnEntryBlocked(ctx *EntryContext, blockError *BlockError)
OnCompleted(ctx *EntryContext)
}
总结
本文从源码角度分析了 Sentinel-Go 的初始化流程和责任链的设计,总体上来说还是比较简单,接下来的系列文章将会分析 Sentinel-Go 的限流熔断等的核心设计与实现。
搜索关注微信公众号"捉虫大师",后端技术分享,架构设计、性能优化、源码阅读、问题排查、踩坑实践。
Sentinel-Go 源码系列(二)|初始化流程和责任链设计模式的更多相关文章
- 手牵手,从零学习Vue源码 系列二(变化侦测篇)
系列文章: 手牵手,从零学习Vue源码 系列一(前言-目录篇) 手牵手,从零学习Vue源码 系列二(变化侦测篇) 陆续更新中... 预计八月中旬更新完毕. 1 概述 Vue最大的特点之一就是数据驱动视 ...
- Spring源码系列(二)--bean组件的源码分析
简介 spring-bean 组件是 Spring IoC 的核心,我们可以使用它的 beanFactory 来获取所需的对象,对象的实例化.属性装配和初始化等都可以交给 spring 来管理. 本文 ...
- MyBatis源码分析-MyBatis初始化流程
MyBatis 是支持定制化 SQL.存储过程以及高级映射的优秀的持久层框架.MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集.MyBatis 可以对配置和原生Map使用简 ...
- spring源码系列(二):IOC接口设计分析
这里主要对springIOC接口体系进行简单的概述和分析,具体每个接口详细分析在下面目录: 参考内容: <Spring技术内幕:深入解析 Spring架构与设计原理> 和 <Spri ...
- Vue.js源码解析-Vue初始化流程
目录 前言 1. 初始化流程概述图.代码流程图 1.1 初始化流程概述 1.2 初始化代码执行流程图 2. 初始化相关代码分析 2.1 initGlobalAPI(Vue) 初始化Vue的全局静态AP ...
- 深入seajs源码系列二
模块类和状态类 参照上文的demo,我们结合源码分析在简单的API调用的背后,到底使用了什么技巧来实现各个模块的依赖加载以及模块API的导出. 首先定义了一个Module类,对应与一个模块 funct ...
- Vue.js源码解析-Vue初始化流程之动态创建DOM
目录 前言 一._update 如何判断是初始化还是更新操作? 二.patch 2.1 patch 定义 2.2 初始化的 patch 三.createElm 动态创建DOM 3.1 创建组件节点 3 ...
- Mybatis源码手记-从缓存体系看责任链派发模式与循环依赖企业级实践
一.缓存总览 Mybatis在设计上处处都有用到的缓存,而且Mybatis的缓存体系设计上遵循单一职责.开闭原则.高度解耦.及其精巧,充分的将缓存分层,其独到之处可以套用到很多类似的业务上.这里将主要 ...
- 框架源码系列二:手写Spring-IOC和Spring-DI(IOC分析、IOC设计实现、DI分析、DI实现)
一.IOC分析 1. IOC是什么? IOC:Inversion of Control控制反转,也称依赖倒置(反转) 问题:如何理解控制反转? 反转:依赖对象的获得被反转了.由自己创建,反转为从IOC ...
随机推荐
- Windows环境下实现WireShark抓取HTTPS
https 加密传输,Wireshark 没有设置的情况下是没有办法抓到包的 https 的数据包. 设置系统环境变量(SSLKEYLOGFILE) WireShark 设置 SSL 选项 参考文章: ...
- vue three.js 结合tween.js 实现动画过渡
参考地址:https://www.jianshu.com/p/d6e3b4b153bb https://www.jqhtml.com/10513.html 官方文档:https://github.co ...
- HTML 网页开发、CSS 基础语法——十二.CSS选择器
选择器 基础选择器:标签选择器,id选择器,类选择器,通配符选择器 高级选择器:后代选择器,交集选择器,并集选择器 1. 标签选择器: • 优点:可以选中所有的同名标签,设置所有同名标签的公共样式. ...
- 提问式复习:图文回顾 redo log 相关知识
原文链接:提问式复习:图文回顾 redo log 相关知识 1.如何提升 redo日志 的写性能? 为了保证 redo日志 不丢失,会在磁盘中开辟一块空间将日志保存起来.但是这样会有一个问题,磁盘的读 ...
- 通用脱敏工具类和判断URL
通用脱敏工具类 public class DesensitizationUtil { private static final int SIZE = 6; private static final S ...
- MySQL5.7.26二进制安装
1.安装系统版本 2.解压更换路径 tar xf mysql-5.7.26-linux-glibc2.12-x86_64.tar.gz mv mysql-5.7.26-linux-glibc2.12- ...
- Serverless 在大规模数据处理的实践
作者 | 西流 阿里云技术专家 前言 当您第一次接触 Serverless 的时候,有一个不那么明显的新使用方式:与传统的基于服务器的方法相比,Serverless 服务平台可以使您的应用快速水平扩展 ...
- 前端必会的Javascript经典面试题
这是前端最基础的问题,也是在面试中难倒无数同学的经典问题 01. Javascript 数据类型 Javascript 数据类型 = 基本类型 + 引用类型 ES6 之前 5 + 1 = 6 种 ES ...
- 题解 CF1172E Nauuo and ODT
题目传送门 题目大意 给出一个 \(n\) 个点的树,每个点有颜色,定义 \(\text{dis}(u,v)\) 为两个点之间不同颜色个数,有 \(m\) 次修改,每次将某个点的颜色进行更改,在每次操 ...
- C#开发BIMFACE系列52 CS客户端集成BIMFACE应用的技术方案
BIMFACE二次开发系列目录 [已更新最新开发文章,点击查看详细] 在我的博客<C#开发BIMFACE系列49 Web网页集成BIMFACE应用的技术方案>.<C#开发BI ...