Koipy
  • koipy测试机器人
  • 快速开始
  • 配置模板
  • 激活
  • 友情链接
  • 文档
    • 配置详解
      • 必填配置
      • bot
      • network
      • image
      • scriptConfig
    • 指令详解
      • /test
      • /rule
      • /log
      • /remove
      • /help
      • /re
      • /checkslave
      • /subinfo
      • /reload
      • /setantigroup
      • /leave
      • /grant
      • /nightshift
      • /panel
      • 指令参数
      • 位置参数
    • 自定义指令
    • 关于规则
      • 指令映射
    • 回调功能
    • 以旁路模式运行bot
    • MiaoSpeed后端
      • 介绍
      • 搭建指南
        • docker使用
      • 测试脚本编写
        • 第一个测试脚本
        • 预设函数
          • 发起POST请求
      • MMDB数据库
      • 历史过往
    • 语言包
      • 导入语言包
      • 制作语言包
    • 问题答疑
      • 无法获取订阅
      • 关于连通性测试
      • 关于拓扑测试
    • 更新日志
      • v1.8.X
      • v1.7.X
      • v1.6.X
      • v1.5.X
      • v1.4.2
      • v1.4
      • v1.3
    • 合作开发
    • 赞赏支持
Powered by GitBook
On this page
  • 定义
  • 规则字段(配置)
  • 场景举例
  • 优先级
  1. 文档

关于规则

此篇幅将介绍koipy的一大特性--规则系统

定义

在koipy中,规则是一系列测试行为的集合,通过一系列预先定义好的规则字段,可在前端bot中的测试指令(如 /test /speed等)中快速发起想要的测试

规则字段(配置)

设置的一条规则中,有以下字段:

  • name 此规则的名字

  • url 此规则所绑定的订阅URL

  • script 测试脚本的数组

  • runtime 测试运行时动态改变的设置,比如针对测速任务的测速线程(speedThreads),测Ping任务的pingURL,还有结果排序等。具体可用值参阅config.yaml里的全局runtime配置。

  • slaveid 后端id指定,指定后端后将不会弹出选择后端页面

  • owner 此规则的创建者的TG UID

场景举例

  1. 将订阅保存为一个具体的名字,以方便进行测试,以及避免暴露订阅

使用 /rule <订阅链接> <具体名字>

例子:

/rule https://www.google.com 谷歌云
  1. 在上面的基础上,指定后端id

由于在bot未在前端实现指定后端id的文本接收,故需要手动在配置文件中进行配置:

rules: # 注意这行,说明rules是一个数组,数组里面每一个元素即为规则的配置,下面不写的话自行补全
- name: 谷歌云
  url: "https://www.google.com"
  script: []
  slaveid: local
  runtime: null
  owner: 123456789 # 改成对应目标的uid

你在后端配置中的所有后端id均可用,如果slaveid对应的后端无法找到,将自动进入选择后端页面。

  1. 在上面的基础上,选定ping rtt测试和http延迟测试‘

这里需要用到预留脚本名称,有关预留的名称作用,参阅:

script字段是一个数组

- name: 谷歌云
  url: "https://www.google.com"
  script: [TEST_PING_RTT, TEST_PING_CONN]
  slaveid: local
  runtime: null
  owner: 123456789

第二种写法,与上面效果等同:

- name: 谷歌云
  url: "https://www.google.com"
  script: 
  - "TEST_PING_RTT"
  - "TEST_PING_CONN"
  slaveid: local
  runtime: null
  owner: 123456789
  1. 在上面的基础上,指定排序为 “HTTP升序”

- name: 谷歌云
  url: "https://www.google.com"
  script: 
  - "TEST_PING_RTT"
  - "TEST_PING_CONN"
  slaveid: local
  runtime: 
    sort: "HTTP升序"
  owner: 123456789

优先级

或许你会想,如果我在设置规则的同时又同时在测试指令使用指令参数时会怎样呢,例如:

/test?s=local&sort=订阅原序 谷歌云

答案是指令参数的优先级大于规则,遵循的原则是——所见即所闻,你在前端操作的一切指令,都应该符合你的主观感受。如果不是,那就是程序出现bug,欢迎向开发者反馈。

Previous自定义指令Next指令映射

Last updated 9 months ago

scriptConfig