1. 关键组件
1.1. 知识点
说明关键组件展示不同群组下的应用ntc探针关键组件、spring boot actuator healthindicators、基于ntc注解(@NextCmptCheck)自定义的关键组件列表,以及提供参数修改组件健康状态检查等功能
关于如何对接自定义关键组件和actuator healthIndicators,可以参考NTC在线对接文档。
1.2. 功能截图
1.3. 功能详述
NTC关键组件可以自动扫描应用所包含的关键组件列表并且展示,支持实时修改组件配置和自定义组件检查规则,实时发起组件健康检查等。以下做详述:
1.3.1. 组件列表查询
如上图所示展示了不同的群组下应用不同组件类型组件列表,有NTC内部探针组件、应用自定义组件、spring boot actuator healthindicators 三种类型。
组件编号:展示组件唯一标识
名称:展示组件名称
类型:展示组件不同类型
激活状态:启动和禁用
配置:组件的配置,healthIndicator不支持修改
自检码规则:点击跳转自检码规则,可以新增规则和查询规则列表等
描述:组件描述
操作:支持禁用或者启用、立即健康状态检查等
1.3.2. 组件配置
点击配置展示了该组件所有配置列表
列表字段描述:
key:该配置key
value:具体配置的值
操作:支持在线修改实时生效
默认值:在启动时候默认设置的配置值
描述:该配置帮助描述
支持属性修改实时修改实时生效,在没有指定配置修改之后调用的方法,默认调用field的set方法进行设置。修改的配置值是否生效,可以在修改之后刷新组件列表,重新点击查询配置即可确认。比如错误的配置类型,配置将不会生效,使用原配置值。
1.3.3. 自检码规则
很多组件拥有NTC内部默认的自检码,比如为正常默认为08xx00、异常08xx01、未知08xx99、异常08xx02等。但是为了应对一些特殊场景,希望能产生个性化诊断码,我们制定了自检码规则来产生相应的诊断码。
1.3.4. 列表查询
点击自检码规则展示了该组件所有的自检规则列表
列表字段描述:
自检码:展示自检码
状态:展示该自检码状态,状态一共有:UP、DOWN、WARN、OUTOFSERVICE、UNKONWN。其中OUTOFSERVICE为actuator healthIndicator独有匹配状态
组合关系:当一条规则里面有多个项时候他们之间的组合关系,有“或”和“且”两种
操作:可以修改和删除,修改支持修改匹配状态和规则项
规则新增
规则新增
自检码:更加规则生成的自检规则
匹配状态:要匹配的检查结果返回状态
规则项:匹配返回结果的context字段,可以设置要匹配的key对于的value值,匹配运算符有多种。其中计算运算符:大于、大于等于、小于、小于等于、相等、不相等、区间,内容运算符:内容相等、内容包含、内容前缀、内容后缀。
解决方案:针对该种诊断的解决方案,非必输
规则项可以设置多条,当出现多条的时候,可以设置组合关系来确定多条规则项直接的关系
例子
如下图设定了自检规则项
将返回结果对象中的context匹配其中的key为num的值大于5,且匹配key为config的值内容包含字符串“192.186.1.1”。
匹配的检查结果为UP,根据以上的规则匹配的自检码为103812。也就是说满足上面描述的规则,在NTC触发检查组件的时候将返回自检码为103812。
1.3.5. 立即检查
点击立即检查按钮,即可触发调用检查方法,以表格形式展示以下结果
表格展示了检查组件结果状态,本次检查的自检码以及相应上下文返回数据