配置真实用户监控 (RUM)

编辑

真实用户监控 (RUM) 代理捕获用户与 Web 浏览器等客户端的交互。这些交互将作为事件发送到 APM Server。由于 RUM 代理在客户端运行,因此代理和服务器之间的连接是未经身份验证的。作为安全预防措施,RUM 默认情况下是禁用的。

要启用 RUM 支持,请在 APM Server 配置文件中将 apm-server.rum.enabled 设置为 true

配置示例

apm-server.rum.enabled: true
apm-server.auth.anonymous.rate_limit.event_limit: 300
apm-server.auth.anonymous.rate_limit.ip_limit: 1000
apm-server.auth.anonymous.allow_service: [your_service_name]
apm-server.rum.allow_origins: ['*']
apm-server.rum.allow_headers: ["header1", "header2"]
apm-server.rum.library_pattern: "node_modules|bower_components|~"
apm-server.rum.exclude_from_grouping: "^/webpack"
apm-server.rum.source_mapping.enabled: true
apm-server.rum.source_mapping.cache.expiration: 5m
apm-server.rum.source_mapping.elasticsearch.api_key: TiNAGG4BaaMdaH1tRfuU:KnR6yE41RrSowb0kQ0HWoA

此外,如果 APM Server 部署在与页面源不同的源中,您需要在代理中配置跨源资源共享 (CORS)

配置参考
编辑
启用 RUM编辑

要启用 RUM 支持,请设置为 true。默认情况下,此选项处于禁用状态。(bool)

APM Server 二进制文件

apm-server.rum.enabled

Fleet 管理

启用 RUM

如果配置了API 密钥密钥令牌,则启用 RUM 支持将自动启用匿名身份验证。由于 RUM 代理在浏览器中运行,因此需要匿名身份验证。

允许的源编辑

RUM 支持的允许源列表。用户代理发送一个 Origin 标头,该标头将针对此列表进行验证。现代浏览器作为CORS 规范的一部分自动执行此操作。源由协议方案、主机和端口组成,不包含 URL 路径。

默认值:['*'](允许所有内容)。(text)

APM Server 二进制文件

apm-server.rum.allow_origins

Fleet 管理

允许的源

Access-Control-Allow-Headers编辑

从 RUM 代理到 APM Server 的 HTTP 请求在允许拥有的 HTTP 标头方面受到限制。如果添加任何其他标头,则由于跨源资源共享 (CORS) 限制,浏览器将拒绝该请求。使用此设置允许其他标头。允许的标头的默认列表包括“Content-Type”、“Content-Encoding”和“Accept”;此处配置的自定义值将附加到默认列表,并用作 Access-Control-Allow-Headers 标头的值。

默认值:[]。(text)

APM Server 二进制文件

apm-server.rum.allow_headers

Fleet 管理

Access-Control-Allow-Headers

自定义 HTTP 响应标头编辑

要添加到 RUM 响应的自定义 HTTP 标头。这对于安全策略合规性非常有用。

为同一键设置的值将被连接。

默认值:无。(text)

APM Server 二进制文件

apm-server.rum.response_headers

Fleet 管理

自定义 HTTP 响应标头

库帧模式编辑

要与堆栈跟踪帧的 file_nameabs_path 属性匹配的正则表达式。如果正则表达式匹配,则认为堆栈跟踪帧是库帧。当应用源映射时,error.culprit 设置为反映第一个非库帧的函数文件名。这旨在为识别问题提供一个切入点。

默认值:"node_modules|bower_components|~"。(text)

APM Server 二进制文件

apm-server.rum.library_pattern

Fleet 管理

库帧模式

从分组中排除编辑

要与堆栈跟踪帧的 file_name 匹配的正则表达式。如果正则表达式匹配,则将从用于计算错误组的范围中排除堆栈跟踪帧。

默认值:"^/webpack"(排除文件名以 /webpack 开头的堆栈跟踪帧)。(text)

APM Server 二进制文件

apm-server.rum.exclude_from_grouping

Fleet 管理

从分组中排除

源映射配置选项
编辑
source_mapping.enabled编辑

用于启用/禁用 RUM 事件的源映射。启用后,APM Server 需要额外的权限才能读取源映射。有关更多详细信息,请参阅使用功能角色

默认值:true

source_mapping.elasticsearch编辑

配置 Elasticsearch 源映射检索位置,采用与output.elasticsearch相同的选项。当使用 Elasticsearch 以外的输出并且该输出正在写入 Elasticsearch 时,必须设置此项。否则,将此部分留空。

source_mapping.cache.expiration编辑

如果源映射已上传到 APM Server,则会自动将源映射应用于发送到 RUM 端点的文档。源映射从 Elasticsearch 中获取,然后保存在内存缓存中,直到配置的时间。未配置时间单位的值被视为秒。

默认值:5m (5 分钟)

source_mapping.index_pattern编辑

先前版本的 APM Server 将源映射存储在 apm-%{[observer.version]}-sourcemap 索引中。使用此设置搜索存储在较旧版本中的源映射。

默认值:"apm-*-sourcemap*"

摄取管道
编辑

默认的 APM Server 管道包含在 Elasticsearch 中编制索引之前丰富 RUM 数据的处理器。有关如何查找、编辑或禁用此预处理的详细信息,请参阅使用摄取管道解析数据