管理员指南
组件部署管理
用户在使用性能监控相关的功能前,需要安装/配置链路追踪、应用诊断等组件,操作详情如下所示。
- 链路追踪需要中间件 ES, 需用户自定义配置
- 使用第三方服务 ES,版本兼容6.4.0、6.8.x
- 当适配 TCE 部署时,使用平台中间件ES,支持6.8.x版本
组件中心
作为独立的组件,用户在使用性能监控相关功能前需要安装链路追踪、应用诊断组件,页面及说明如下所示
系统管理员或租户管理员,进入[管理工作台/性能监控配置/组件部署管理],切换至“组件中心”,选择目标组件,点击部署,进入部署页面。
链路追踪部署
链路追踪作为一套分布式链路调用监控系统,将一次分布式请求还原成调用链路,集中展示调用情况。例如,各个服务节点上的耗时、请求发送到哪个节点、每个服务节点的请求状态等信息。 系统支持项目&集群维度的链路追踪组件安装,链路追踪组件的部署步骤如下:
- 用户点击平台导航进入[管理工作台/性能监控配置/组件部署管理]页面,系统默认进入部署管理页面,切换至“组件中心”列表页面。
- 找到“链路追踪”,单击<部署>按钮,进入组件部署配置页面,如下图所示。
- 租户名称:选择安装链路追踪组件的已授权租户。
- 集群名称:选择要安装链路追踪组件的集群。
- 项目名称:选择对应租户下要安装链路追踪组件的项目。
- 组件配置:配置链路追踪组件的相应资源。
- 高可用:配置链路追踪组件是否高可用,当用户配置组件高可用时可选择高可用场景下节点个数,系统支持3/4/5等节点个数配置。
- 容器规格:配置容器规格,支持选择默认配置、自定义容器规格。
- ES配置,主要为链路追踪相关功能提供存储
- 访问地址:选择HTTP/HTTPS协议,填写IP/host、端口(选填,默认9200)。其中地址配置信息支持服务名输入形式。
- 认证方式:支持Basic/Bearer token两种。选择Basic认证,填写用户名、密码;选择Bearer token,填写token
- index前缀,提供默认值,用户可自定义修改
- Header,在指定场景下,按需添加连接ES所需的键值对。
- 组件参数配置完成后,单击<确定>按钮,参数配置操作完成。
- 编辑时,除租户、集群、项目外,均支持编辑(ES 修改后,数据不会自动同步,需谨慎修改!)。
- 编辑完成后,会自动重启服务tracing-analysis-server,重启过程中不会接受上报数据,请谨慎操作!
- 卸载链路组件时,弹框中提示“卸载后,接入的服务将无法继续使用链路追踪功能,请谨慎操作!”,输入“卸载”后,点击<继续卸载>,完成卸载。
备注
- 链路组件卸载后,对应 ES 的 index 并没有默认删除,用户有需要,可自行删除。
链路高级配置
提供如下三方面的功能配置:
- 当跨集群使用链路组件时,需要为链路组件设置外网访问地址
- 采集配置,支持设置采样率、采集黑名单等
- 链路数据清理
操作步骤如下:
- 用户点击平台导航进入[管理工作台/性能监控配置/组件部署管理]页签,系统默认进入部署管理页面。
- 找到对应的链路追踪组件,单击<高级配置>按钮,进入参数配置页面,如下所示。
- 集群内地址:安装skywalking后系统对应生成的server地址。
- 外网地址:如果用户需要跨集群使用链路,需要在此处配置外网地址,且保证访问互通,否则会导致链路数据无法上报而丢失。
- 全局采样率:设置链路采集信息的采样率,适当的采样率可以减少不必要的数据传输,降低对服务性能的影响,当采样率设置为0%时,将停止采集。
- Apdex阈值:定义了服务响应时间的最优门槛为T(即Apdex阈值,T由性能评估人员根据预期性能要求确定)
- 黑名单采集设置:用户可以配置对应的采集策略,屏蔽部分数据量过大但业务意义不大的数据,降低资源的损耗。
- 采集开关:用户自定义开启黑名单采集设置。
- 采集路径:配置黑名单采集路径,支持配置多条,各路径数据之间用英文“,”隔开,例如:“/test/v1”。
- 黑名单采样率:设置黑名单的的采样比例,数值范围是0-100%,数值越大表示在符合黑名单采集设置的前提下采集的数据越多。
- 链路数据清理
- Trace数据:自定义配置trace数据的保留天数,trace指一次完整的分布式调用跟踪链路。
- 指标数据:自定义配置指标数据的保留天数,指标数据包括服务、实例、端点指标和拓扑映射指标。
- 调整保留天数后,会自动重启服务tracing-analysis-server,重启过程中不会接受上报数据,请谨慎操作!
应用诊断部署
该功能为用户提供相应数据来诊断应用运行问题,可以在不重启JVM进程的情况下,查看程序的运行情况。包括控制面板、线程列表、方法诊断和性能分析。 系统支持集群维度的应用诊断组件安装,安装的操作步骤如下:
- 用户点击平台导航进入进入[管理工作台/性能监控配置/组件部署管理]页面,系统默认进入部署管理页面,切换至“组件中心”列表页面。
- 找到“应用诊断”,单击<部署>按钮,进入组件部署配置页面
- 集群名称:选择要安装应用诊断组件的集群。
- 租户名称:授权集群下可使用该功能的租户。
- 项目名称:选择对应租户下可使用应用诊断组件的项目。
- 容器规格:配置容器规格,支持选择默认配置、自定义容器规格。
- 组件参数配置完成后,单击<确定>按钮,组件安装操作完成。
备注
- 租户管理员、系统管理员可见可部署链路追踪组件。
- 如果跨租户使用链路组件,需要租户管理员进行授权。
- 系统管理员可见可操作应用诊断组件。
- 应用诊断组件部署到固定租户/项目,即系统租户/xx项目(命名空间:apm-system,项目名称可自定义)。
链路授权管理
链路组件安装完成后,需要为项目&集群指定链路组件,后续方可将业务服务接入链路。
- 某项目&集群可使用<当前项目所属租户>中部署的所有链路组件。
- 跨租户使用需要进行链路授权。
- 跨集群使用时,需要为链路组件设置外网地址,保证网络互通。
链路设置
项目可使用自己部署的链路组件,也可为其设置其他有权限的链路组件使用。链路设置详细说明如下:
单个链路设置
用户可为单个项目绑定链路,操作步骤如下所示。
- 用户点击平台导航进入[管理工作台/性能监控配置/链路授权管理]页签,系统默认进入链路设置列表页面。
- 选择目标项目,单击<链路设置>按钮,进入链路配置页面,如下所示
- 选择要绑定的链路,输入“同意设置”,单击<确定>按钮,链路设置操作完成。
批量链路设置
为链路做批量配置的操作步骤如下所示。
- 用户点击平台导航进入[管理工作台/性能监控配置/链路授权管理]页签,系统默认进入链路设置列表页面。
- 勾选多个目标项目,单击<链路设置>按钮,进入链路批量配置页面,如下所示
- 分租户聚合展示勾选的目标项目
- 同一租户下的多个项目,配置相同的链路组件
- 选择要绑定的链路,输入“同意设置”,单击<确定>按钮,批量链路设置操作完成。
链路授权管理
跨租户使用某链路组件,需要租户管理员进行授权。
添加授权
操作步骤如下:
- 用户点击平台导航进入[管理工作台/性能监控配置/链路授权管理]页签,系统默认进入链路设置列表页面,切换至链路授权页面。
- 单击<添加授权>按钮,进入链路授权配置页面,选择要绑定的链路组件,选择被授权的租户(即受权租户)。
- 参数配置完成后,单击<确定>按钮,添加授权操作完成。
解除授权
操作步骤如下:
- 用户点击平台导航进入[管理工作台/性能监控配置/链路授权管理]页签,系统默认进入<链路设置>列表页面,切换至<链路授权>页面。
- 找到对应的链路地址,单击<解除授权>按钮,弹框中勾选目标受权租户。
- 选择要解除授权的租户,在确认框内输入“解除授权”,然后单击<确定>按钮,解除授权操作完成。
链路拓扑管理
项目&集群下配置了链路地址后,其服务可接入链路,上报数据。链路拓扑清晰展示了安装链路组件的项目/组件状态,统计并展示了项目接入链路的服务数量同时指明了链路数据上报的方向,方便运维人员查看。
- 默认仅展示部署了链路组件 或 配置了链路组件的项目&集群
- 部署了链路组件的项目&集群,右上角会展示“链路”图标,绿色标识组件健康、黄色标识组件不健康
- 连线代表数据上报链路