系统参数配置
什么是系统参数
系统参数是指多个操作具有的共有属性,包括预置参数和批量参数。
- 预置参数是同类型操作都具有的属性,是系统预置的操作属性,用户无需配置即可使用,如Browser操作的浏览器和省份。
- 批量参数是用户配置的某应用或业务属性下的多个操作具有的属性,是用户配置的操作属性。
参数标签是用户给多个操作的不同参数设置的业务标签,如操作A的参数1和操作B的参数2具有相同的业务含义,如业务ID、用户年龄等,可以将参数1和参数2标记为参数标签C。
说明:
参数标签即V3.5.1及以前版本的全局参数。
BPI V3.6.0.2之前的版本仅支持APM探针配置批量参数,V3.6.1.0及以后的版本支持APM/JS/SDK探针采集批量参数。
操作的各类参数和参数标签的关系图如下,采集/计算参数是操作的私有属性,在【操作编辑】页面维护,预置参数是所有操作的公有属性,批量参数是部分操作的公有属性;参数标签是将不同操作的采集/计算/批量参数设置为同一个业务标签。
批量参数
在导航栏中依次点击业务感知分析>配置>系统参数配置,进入系统参数配置页面。
选择左上角的展示所有的批量参数。
新建批量参数
点击按钮后可进入新建批量参数页面,新建参数流程说明如下:
如何获取参数:支持3种参数获取方式,包括APM探针获取的数据项、 App SDK请求参数、JS探针获取的请求参数。
设置参数使用范围:支持按操作所属应用、业务属性和操作名称3种方式指定操作范围,如选择“wy_testapp51”应用,银行业务下的“王燕事务1”和“事务wy1”两个操作定义批量参数。
APM探针获取的数据项
- 搜索并选择数据项,配置如下:
- 数据项列表:如果操作所属应用单独配置数据项,此处展示该应用的所有数据项,否则展示系统数据项。
- 搜索数据项:在搜索框输入数据项名称,点击后展示搜索结果。
- 编辑数据项:点击后跳转至APM应用设置页面,用户可编辑数据项。
- 新建数据项:点击按钮后跳转至APM应用设置页面,用户可点击新建数据项。
- 选择数据项:点击数据项后,序号前变为选中状态。
添加参数:将选择的数据项设置为参数,参数名称和参数类型与数据项保持一致,用户可修改。 用户可点击对数据项的返回值做进一步处理,详细说明见字符串解析。支持对List格式的参数做自动拆分。
参数列表:用户通过【字符串解析】配置的参数才显示参数列表,展示解析树上的所有参数。
说明:没有显示的是根节点,点击根节点的删除根节点绑定的参数,不影响根节点相关的参数。
确认和取消:点击保存当前页面的所有配置,点击放弃当前页面的所有配置。
App SDK请求参数
当满足以下两种情况之一时,用户可选择【App SDK请求参数】配置批量参数,通过字符串解析获取业务参数。
情况一:用户定义多个具有相同属性的操作。
情况二:用户通过自定义嵌码的方式定义多个具有相同属性的操作,且每个操作上传相同结构Map事件。
说明:如果当前用户没有App应用权限,此处不显示【App SDK请求参数】选项。
参数所在请求,配置如下:
如果参数在请求中,选择【请求参数】,可设置批量参数的请求URI,选择精准匹配/正则匹配。其他逻辑与操作添加采集参数相同,不做详细描述。详细说明见新建App操作。
如果参数在自定义事件的Map中,选择自定义事件。
添加参数:点击后,增加一行参数配置,用户可设置参数位置、参数key、参数名称、参数类型、启用状态等。目前支持从HTTP请求头、HTTP响应头、URL参数、URL路径中获取参数。其他逻辑与操作添加采集参数相同,不做详细描述。详细说明见新建App操作。
点击弹出字符串解析框,可对参数返回值做进一步解析,详细说明见字符串解析。
点击复制一条参数配置,根节点不可再复制。
点击删除该参数配置,点击根节点的删除根节点绑定的参数,不影响根节点相关的参数。
参数列表:用户通过【字符串解析】配置的参数才显示参数列表,展示解析树上的所有参数。
确认和取消:点击保存当前页面的所有配置,点击放弃当前页面的所有配置。
JS探针获取的请求参数
如果某应用/多个应用下的多个操作具有相同的请求和参数,如需要获取请求头的用户名等信息,这种情况下可选择【JS探针获取的请求参数】配置批量参数。
说明:如果当前用户没有Web应用权限,此处不显示【JS探针获取的请求参数】选项。
参数采集方式:用户可对应用的多个操作配置采集参数与计算参数,即采集参数和计算参数都可以被设置为批量参数。
用户可为计算参数设置参数名称、参数类型和参数标签。
参数所在请求,配置如下:
- 设置批量参数的请求URI,可选择精准匹配/正则匹配。点击可在弹框中设置请求的参数信息。其他逻辑与操作添加采集参数相同,不做详细描述。详细说明见新建Web操作。
添加参数:点击后,增加一行参数配置,用户可设置参数位置、参数key、参数名称、参数类型、启用状态等。目前支持从HTTP请求头、HTTP响应头、URL参数、URL路径中获取参数。其他逻辑与操作添加采集参数相同,不做详细描述。详细说明见新建Web操作。
点击弹出字符串解析框,可对参数返回值做进一步解析,详细说明见字符串解析。
点击复制一条参数配置,根节点不可再复制。
点击删除该参数配置,点击根节点的删除根节点绑定的参数,不影响根节点相关的参数。
确认和取消:点击保存当前页面的所有配置,点击放弃当前页面的所有配置。
需要说明的是,JS探针可将采集到的弹窗事件的参数自动设置为批量参数,显示在批量参数列表中。
单击操作列的编辑,可继续配置这些批量参数。
批量参数列表
展示用户配置的所有批量参数,可搜索、新建、编辑、删除、复制参数,每个参数展示其序号、参数名称、参数类型、使用范围、引用次数、启用状态。
搜索:支持按参数类型、应用、业务属性过滤参数所在操作,多个过滤之间为"且"的关系,支持按参数名称精准模糊匹配参数。
参数列表:包含以下字段:
- 参数名称、参数类型,与【批量新建】的配置项相同;
- 使用范围,显示规则与【批量新建】的配置项相同;
引用次数,展示该参数被业务流、query配置、指标引用的明细;
启用状态,打开开关后采集该参数,关闭开关后不采集该参数。
复制:复制成为一个新的参数后,新参数的引用次数等于0。
编辑:点击进入参数编辑页面。
删除:点击删除该参数。
预置参数
- 在导航栏中依次点击业务感知分析>配置>系统参数配置,进入系统参数配置页面。
- 选择左上角的展示所有的预置参数。
预置参数列表
展示系统所有的预置参数(总共36个),每个参数展示其序号、参数名称、参数类型、单位、使用范围、返回值说明,支持参数搜索。
搜索:支持按参数类型过滤参数,支持按参数名称精准匹配参数。
参数列表:包含以下字段:
- 参数名称:参数类型和单位,展示参数的基础信息。
- 使用范围:展示参数在各数据源的使用范围,包括App、Web、APM操作。
- 返回值说明:对参数的返回值做补充说明,包括返回值举例。