[home]官方网站内容更新

2022-02-04 22:23:44 +08:00
parent 915d154f7d
commit 3b238347d4
36 changed files with 365 additions and 1073 deletions
--- a/home/docs/advanced/custom-datasource.md
+++ b/home/docs/advanced/custom-datasource.md
@@ -1,81 +0,0 @@
---
-id: custom-datasource  
-title: 自定义数据源   
-sidebar_label: 自定义数据源     
---
-
-## 自定义数据源
-
-自定义前建议了解`sureness`处理流程和提供的扩展接口,详见 [进阶扩展](/docs/advanced/extend-point)
-
- `PathTreeProvider`: 资源的数据源接口,实现从数据库,文本等加载数据,加载到对应的资源权限匹配器`DefaultPathRoleMatcher`中
- `SurenessAccountProvider`: 用户的账户密钥信息接口,实现从数据库,文本等加载数据，加载到需要账户数据的`processor`中
-
-
-首先我们先来认识下sureness提供的两个用户信息和资源权限信息的接口，用户可以实现这些接口自定义从不同的数据源给sureness提供数据。
-当我们把项目从配置文件模式切换成数据库模式时，也只是简单替换了这些接口的实现类而已。
-
-一. `PathTreeProvider` 资源权限配置信息的数据源接口,我们可以实现从数据库,文本等加载接口想要的资源权限配置数据
-
-````
-public interface PathTreeProvider {
-
-    Set<String> providePathData();
-
-    Set<String> provideExcludedResource();
-}
-
-````  
-
-此接口主要是需要实现上面这两个方法，providePathData是加载资源权限配置信息，也就是我们配置文件模式下sureness.yml的resourceRole信息列，
-provideExcludedResource是加载哪些资源可以被过滤不认证鉴权，也就是sureness.yml下的excludedResource信息列，如下。
-
-````
-resourceRole:
-  - /api/v2/host===post===[role2,role3,role4]
-  - /api/v2/host===get===[role2,role3,role4]
-  - /api/v2/host===delete===[role2,role3,role4]
-  - /api/v2/host===put===[role2,role3,role4]
-  - /api/mi/**===put===[role2,role3,role4]
-  - /api/v1/getSource1===get===[role1,role2]
-  - /api/v2/getSource2/*/*===get===[role2]
-
-excludedResource:
-  - /api/v1/source3===get
-  - /api/v3/host===get
-  - /**/*.css===get
-  - /**/*.ico===get
-  - /**/*.png===get
-````
-
-而当我们使用数据库模式时，实现这些信息从数据库关联读取就ok了，规范返回 eg: /api/v2/host===post===[role2,role3,role4] 格式的数据列，
-具体的数据库实现类参考类 - [DatabasePathTreeProvider](https://github.com/tomsun28/sureness/blob/master/sample-tom/src/main/java/com/usthe/sureness/sample/tom/sureness/provider/DatabasePathTreeProvider.java)
-
-二. `SurenessAccountProvider`这第二个相关的接口就是用户的账户密钥信息提供接口,我们需要实现从数据库或者文本等其他数据源那里去加载我们想要的用户的账户信息数据，
-这些数据提供需要账户数据的processor进行用户的认证。
-
-````
-public interface SurenessAccountProvider {
-    SurenessAccount loadAccount(String appId);
-}
-````
-此接口主要需要实现上面这个loadAccount方法，通过用户的唯一标识appid来从数据库或者redis缓存中查找到用户的账户信息返回即可。
-用户账户信息类SurenessAccount如下：
-
-````
-public class DefaultAccount implements SurenessAccount {
-
-    private String appId;
-    private String password;
-    private String salt;
-    private List<String> ownRoles;
-    private boolean disabledAccount;
-    private boolean excessiveAttempts;
-}
-```` 
-
-比较简单，主要是需要提供用户的密码相关信息即可，供sureness认证时密钥判断正确与否。  
-这个具体的数据库接口实现可参考类 - [DatabaseAccountProvider](https://github.com/tomsun28/sureness/blob/master/sample-tom/src/main/java/com/usthe/sureness/sample/tom/sureness/provider/DatabaseAccountProvider.java)
-
-
-具体扩展实践请参考 [Springboot项目集成-数据库方案](/docs/integrate/sample-tom)     
--- a/home/docs/advanced/custom-processor.md
+++ b/home/docs/advanced/custom-processor.md
@@ -1,35 +0,0 @@
---
-id: custom-processor  
-title: 自定义processor     
-sidebar_label: 自定义processor     
---
-
-processor就是对请求的用户账户信息subject真正的认证鉴权处理器，我们需要实现BaseProcessor接口，来实现我们自定义的认证鉴权方式。  
-sureness已经内置基于账户密码认证方式处理PasswordSubject的PasswordProcessor，基于jwt认证方式处理JwtSubject的JwtProcessor等。
-
-自定义前建议了解`sureness`处理流程和提供的扩展接口,详见 [进阶扩展](/docs/advanced/extend-point)
-
- `Processor`: `Subject`处理接口,根据Subject信息,进行认证鉴权
-
-```
-public abstract class BaseProcessor implements Processor{
-
-    public abstract boolean canSupportSubjectClass(Class<?> var);
-
-    public abstract Subject authenticated (Subject var) throws SurenessAuthenticationException;
-
-    public abstract void authorized(Subject var) throws SurenessAuthorizationException;
-}
-
-```
-
-上面就是BaseProcessor的一些重要接口方法，自定义processor需要我们去实现这些方法。
-
- `canSupportSubjectClass` 判断是否支持入参的此Subject类类型，比如 JwtProcessor只支持JwtSubject, PasswordProcessor只支持PasswordSubject
- `authenticated` 对subject进行认证，根据传入的subject信息和系统内信息，进行请求用户的账户认证
- `authorized` 对subject进行鉴权，鉴权判断此用户是否拥有其访问api的访问权限
-
-sureness使用异常流程模型，以上的认证失败或鉴权失败都会抛出不同类型的异常，用户在最外部捕获判断实现接下来的流程。
-
-sureness默认异常类型参考 [默认异常类型](/docs/start/default-exception)    
-具体扩展实践请参考 [Springboot项目集成-数据库方案](/docs/integrate/sample-tom)    
--- a/home/docs/advanced/custom-subject-creator.md
+++ b/home/docs/advanced/custom-subject-creator.md
@@ -1,20 +0,0 @@
---
-id: custom-subject-creator  
-title: 自定义subject creator   
-sidebar_label: 自定义subject creator    
---
-
-自定义`subject creator`是我们使用频率最高的扩展，当请求体对象并不是`servlet`或者`jax-rs`标准`api`时，
-或者我们从request请求的不同地方获取账户信息时，我们就需要自定义`subject creator`,
-使其通过请求对象获取我们需要的请求信息(请求路径，请求方法，认证信息等), 从而创建出对应的`subject`.
-
-sureness已经内置能创建出基于账户密码的PasswordSubject的BasicSubjectServletCreator，
-和创建出jwt类型JwtSubject的JwtSubjectServletCreator等，当然我们可以自定义自己需要的subjectCreator来创建subject
-
-自定义前建议了解`sureness`处理流程和提供的扩展接口,详见 [进阶扩展](/docs/advanced/extend-point)
-
- `SubjectCreate`: 创建`Subject`接口,根据请求内容创建不同类型的`Subject`对象
-
-实现`SubjectCreate`接口方法,根据request请求的内容创建出对应需要的的`subject`
-
-具体扩展实践请参考 [sample-spring-webflux项目集成案例](/docs/integrate/sample-spring-webflux)      
--- a/home/docs/advanced/custom-subject.md
+++ b/home/docs/advanced/custom-subject.md
@@ -1,20 +0,0 @@
---
-id: custom-subject  
-title: 自定义subject  
-sidebar_label: 自定义subject  
---
-
-subject包含的就是我们request请求所带的用户信息，sureness已经内置基于账户密码的PasswordSubject，
-基于jwt的JwtSubject等，当然我们可以自定义自己需要的subject来扩充自己的用户信息
-
-自定义前建议了解`sureness`处理流程和提供的扩展接口,详见 [进阶扩展](/docs/advanced/extend-point)
-
- `Subject`: 认证鉴权对象接口,提供访问对象的账户密钥,请求资源,角色等信息
-
-自定义subject需要走以下流程：
-
-1. 实现`Subject`接口,添加自定义的`subject`内容
-2. 实现`SubjectCreate`接口方法,创建出自定义的`subject` 参考[自定义Subject Creator](/docs/advanced/custom-subject-creator)
-3. 实现`Processor`接口,支持处理自定义的`subject` 参考[自定义Processor](/docs/advanced/custom-processor)
-
-具体扩展实践请参考 [使用sureness30分钟项目集成案例](/docs/integrate/sample-tom)     
--- a/home/docs/advanced/extend-point.md
+++ b/home/docs/advanced/extend-point.md
@@ -1,22 +1,202 @@
 ---
 id: extend-point  
-title: 进阶扩展  
-sidebar_label: 扩展点    
+title: 自定义监控  
+sidebar_label: 自定义监控    
 ---
+> HertzBeat拥有自定义监控能力，您只需配置两个YML文件就能适配一款自定义的监控类型。目前自定义监控支持HTTP协议，MYSQL协议，后续会支持更多通用协议。  

-`sureness`支持自定义`subject`，自定义注册`subjectCreator`，自定义`processor`处理器，自定义数据源加载器等。
+### 自定义步骤  

-进阶自定义扩展之前我们先来了解下sureness的大致流程：
+配置自定义监控类型需新增配置两个YML文件
+1. 用监控类型命名的监控配置定义文件 - example.yml 需位于安装目录 /hertz-beat/define/app/ 下
+2. 用监控类型命名的监控参数定义文件 - example.yml 需位于安装目录 /hertz-beat/define/param/ 下
+3. 重启hertzbeat系统，我们就适配好了一个新的自定义监控类型。  

-![flow](/img/docs/flow-cn.png)
+------- 
+下面详细介绍下这俩文件的配置用法。   

-如上面的流程所讲，Subject被SubjectCreate根据request请求体所创造，不同的认证鉴权处理器Processor来处理所支持的Subject。
+### 监控配置定义文件   

+> 监控配置定义文件用于定义 *监控类型的名称(国际化), 请求参数映射, 指标信息, 采集协议配置信息*等。  

-sureness提供了下面这些常用接口作为扩展点:
+样例：自定义一个名称为example的自定义监控类型，其使用HTTP协议采集指标数据。    
+文件名称: example.yml 位于 /hertz-beat/define/app/example.yml   

- `Subject`: 认证鉴权对象接口,提供访问对象的账户密钥,请求资源,角色等信息
- `SubjectCreate`: 创建`Subject`接口,根据请求内容创建不同类型的`Subject`对象
- `Processor`: `Subject`处理接口,根据Subject信息,进行认证鉴权
- `PathTreeProvider`: 资源的数据源接口,实现从数据库,文本等加载数据
- `SurenessAccountProvider`: 用户的账户密钥信息接口,实现从数据库,文本等加载数据    
+```yaml
+# 监控应用类型(与文件名保持一致) eg: linux windows tomcat mysql aws...
+app: example
+name:
+  zh-CN: 模拟应用类型
+  en-US: EXAMPLE APP
+# 参数映射map. type是参数类型: 0-number数字, 1-string明文字符串, 2-secret加密字符串
+# 强制固定必须参数 - host
+configmap:
+  - key: host
+    type: 1
+  - key: port
+    type: 0
+  - key: username
+    type: 1
+  - key: password
+    type: 2
+# 指标组列表
+metrics:
+# 第一个监控指标组 cpu
+# 注意：内置监控指标有 (responseTime - 响应时间)
+  - name: cpu
+    # 指标组调度优先级(0-127)越小优先级越高,优先级低的指标组会等优先级高的指标组采集完成后才会被调度,相同优先级的指标组会并行调度采集
+    # 优先级为0的指标组为可用性指标组,即它会被首先调度,采集成功才会继续调度其它指标组,采集失败则中断调度
+    priority: 0
+    # 指标组中的具体监控指标
+    fields:
+      # 指标信息 包括 field名称   type字段类型:0-number数字,1-string字符串   instance是否为实例主键   unit:指标单位
+      - field: hostname
+        type: 1
+        instance: true
+      - field: usage
+        type: 0
+        unit: '%'
+      - field: cores
+        type: 0
+      - field: waitTime
+        type: 0
+        unit: s
+# (非必须)监控指标别名，与上面的指标名映射。用于采集接口数据字段不直接是最终指标名称,需要此别名做映射转换
+    aliasFields:
+      - hostname
+      - core1
+      - core2
+      - usage
+      - allTime
+      - runningTime
+# (非必须)指标计算表达式,与上面的别名一起作用,计算出最终需要的指标值
+# eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime
+    calculates:
+      - hostname=hostname
+      - cores=core1+core2
+      - usage=usage
+      - waitTime=allTime-runningTime
+# 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk
+    protocol: http
+# 当protocol为http协议时具体的采集配置
+    http:
+      # 主机host: ipv4 ipv6 域名
+      host: ^_^host^_^
+      # 端口
+      port: ^_^port^_^
+      # url请求接口路径
+      url: /metrics/cpu
+      # 请求方式 GET POST PUT DELETE PATCH
+      method: GET
+      # 是否启用ssl/tls,即是http还是https,默认false
+      ssl: false
+      # 请求头内容
+      headers:
+        apiVersion: v1
+      # 请求参数内容
+      params:
+        param1: param1
+        param2: param2
+      # 认证
+      authorization:
+        # 认证方式: Basic Auth, Digest Auth, Bearer Token
+        type: Basic Auth
+        basicAuthUsername: ^_^username^_^
+        basicAuthPassword: ^_^password^_^
+      # 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-网站可用性指标监控
+      # todo xmlPath-xmlPath脚本,prometheus-Prometheus数据规则
+      parseType: jsonPath
+      parseScript: '$'
+
+  - name: memory
+    priority: 1
+    fields:
+      - field: hostname
+        type: 1
+        instance: true
+      - field: total
+        type: 0
+        unit: kb
+      - field: usage
+        type: 0
+        unit: '%'
+      - field: speed
+        type: 0
+    protocol: http
+    http:
+      host: ^_^host^_^
+      port: ^_^port^_^
+      url: /metrics/memory
+      method: GET
+      headers:
+        apiVersion: v1
+      params:
+        param1: param1
+        param2: param2
+      authorization:
+        type: Basic Auth
+        basicAuthUsername: ^_^username^_^
+        basicAuthPassword: ^_^password^_^
+      parseType: default
+```
+
+### 监控参数定义文件  
+
+> 监控参数定义文件用于定义 *需要的输入参数字段结构定义(前端页面根据结构渲染输入参数框)*。   
+
+样例：自定义一个名称为example的自定义监控类型，其使用HTTP协议采集指标数据。    
+文件名称: example.yml 位于 /hertz-beat/define/param/example.yml   
+
+```yaml
+# 监控应用类型名称(与文件名保持一致) eg: linux windows tomcat mysql aws...
+app: example
+# 强制固定必须参数 - host(ipv4,ipv6,域名)
+param:
+    # field-字段名称标识符
+  - field: host
+    # name-参数字段显示名称
+    name: 主机Host
+    # type-字段类型,样式(大部分映射input标签type属性)
+    type: host
+    # 是否是必输项 true-必填 false-可选
+    required: true
+  - field: port
+    name: 端口
+    type: number
+    # 当type为number时,用range表示范围
+    range: '[0,65535]'
+    required: true
+    # 端口默认值
+    defaultValue: 80
+    # 参数输入框提示信息
+    placeholder: '请输入端口'
+  - field: username
+    name: 用户名
+    type: text
+    # 当type为text时,用limit表示字符串限制大小
+    limit: 20
+    required: false
+  - field: password
+    name: 密码
+    type: password
+    required: false
+  - field: ssl
+    name: 启动SSL
+    # 当type为boolean时,前端用switch展示开关
+    type: boolean
+    required: false
+  - field: method
+    name: 请求方式
+    type: radio
+    required: true
+    # 当type为radio单选框,checkbox复选框时,option表示可选项值列表 {name1:value1,name2:value2}
+    options:
+      - label: GET请求
+        value: GET
+      - label: POST请求
+        value: POST
+      - label: PUT请求
+        value: PUT
+      - label: DELETE请求
+        value: DELETE
+```