Sentinel之控制台dashboard

一、源码结构

目录结构

1、pom.xml

首先我们看下pom.xml,这也是我看源码的习惯,看完目录结构再看pom文件。
通过pom文件,可以了解到该项目:

  • 基于Spring boot快速开发的,且spring boot版本为2.0.5.RELEASE
  • 基于JDK8编译开发的
  • 引用了sentinel-web-servlet、sentinel-transport-simple-http等依赖,sentinel-web-servlet是一个sentinel的适配器,因此该项目可能也可以进行限流降级控制

2、client

主要可以看到SentinelApiClient,这个类的功能是通过http获取引用的监控指标以及设置限流、降级、熔断的规则并发送到对应的应用中。
可以看到大致有以下方法:
fetch拉取方法

  • fetchResourceOfMachine: 获取应用的资源
  • fetchFlowRuleOfMachine: 获取应用限流规则
  • fetchDegradeRuleOfMachine: 获取应用降级规则
  • fetchSystemRuleOfMachine: 获取应用的系统保护规则
  • fetchParamFlowRulesOfMachine:获取热点参数限流参数
  • fetchAuthorityRulesOfMachine: 获取机器的授权规则

set设置方法

  • setFlowRuleOfMachine: 设置限流规则
  • setDegradeRuleOfMachine:设置降级规则
  • setSystemRuleOfMachine:设置系统规则
  • setAuthorityRuleOfMachine:设置授权规则
  • setParamFlowRuleOfMachine:设置热点参数规则

然后通过httpGetContent方法调用。
这里只是简单介绍了有哪些调用方法,具体调用调用方法会请求到哪,其实会到sentinel-transpor模块中,其中有个CommandHandler接口,通过SPI的形式实现了很多Handler处理器。具体调用链后续文章会讲解。

3、config

只有一个文件WebConfig:

  • 继承了WebMvcConfigurerAdapter,用来设置web的资源目录、控制器、过滤器等
  • 增加@Configuration,表示该项目启动时加载
  • 增加了CommonFilter,用设置可以限流、降级的资源,可以看到设置资源为/*

4、datasource.entity

不用说,这里放的是实体对象地方,主要有服务实体、指标实体、各种监控规则实体等

5、discovery

这个包下主要是sentinel客户端信息,也就是使用sentinel框架的客户端信息

  • 主要可以看下SimpleMachineDiscovery这个方法,应用的信息会被保存在apps这个Map中。
  • dashboard应用在启动后,客户端会调用/registry/machine(view包下的MachineRegistryController类)这个接口把服务信息写到Map中
  • dashborad应用获取应用就是从map中拿的

6、domain

只有一个类ResourceTreeNode,就是监控指标的对象实体,主要包括qps,异常信息等信息。

7、metirc

只有个MetricFetcher类,表示获取应用的统计信息,也就是拉取实时监控信息

  • 启动是通过构造函数调用start方法进行定时拉取所有客户端指标信息。执行周期是10+n1(秒)*
  • fetchService线程池用来拉取该APP所有机器的metric
  • fetchWorker工作线程池用来调用http获取实时指标信息
  • 最后通过writeMetric方法调用的MetricsRepository的saveAll方法保存所有指标信息

8、repository

主要是metric和rule的信息保存

  • metric的信息来源已经说过了,通过InMemoryMetricsRepository的save方法可以看到客户端实时指标信息在dashboard中保留5分钟
  • rule包下的类主要是获取下一个为使用的id

9、util

  • RuleUtils用来解析Rule的JSON对象
  • VersionUtils解析Sentinel版本

10 view

这个包下就是一些资源控制器了,主要是前端提供接口

  • AppController:应用列表控制器
  • AuthorityRuleController:授权规则控制器
  • DegradeController:降级控制器
  • FlowController:降流控制器
  • MachineRegistryController:应用注册控制,这个控制器比较特殊并不是给前端的,而是客户端注册使用的
  • MetricController :实时监控控制器
  • ParamFlowRuleController:热点参数规则
  • ResourceController :机器资源
  • SystemController :系统规则控制

11、DashboardApplication

应用启动类,可以直接启动,默认端口号8080

12、resources

资源配置文件:application.properties

13、webapp

这个就是前端资源目录,前端使用的是angularjs开发的,二次开发需要搭建前端环境,可以见目录下的README_zh.md文件。

二、分析

1、dashborad模块代码比较简单,主要数据都是从内存获取的
2、在面向生产使用时,还是缺少一些内容的,比如权限控制,数据持久化,登录功能等
3、前端使用angularjs开发,对未接触过人来说,二次开发前端页面难度较大

三、我的小结

1、sentinel系列通过先分享dashboard模块,主要考虑在一个可视化的界面中设置规则,方便后续模块的调试跟踪
2、大致分析了dashboard每个包下的内容
3、针对面向生产时,面对dashbord的痛点。下篇文章会介绍如何扩展一个生产使用的控制台传送门, 主要扩展以下功能:

A: 登录功能、设置统一拦截器
B: 系统权限功能,就是用户只能看到用户权限的系统
C: 核心数据持久化

4、以上内容,若有不当之处,谢谢指正。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,684评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,143评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,214评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,788评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,796评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,665评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,027评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,679评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,346评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,664评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,766评论 1 331
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,412评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,015评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,974评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,073评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,501评论 2 343