Skip to content

docs(api): daily audit 2026-09-29 — RUM remote-config error-session switches, channel filter UTF-8 note #581

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ysyneu merged 1 commit into from
Oct 6, 2026
Merged

docs(api): daily audit 2026-09-29 — RUM remote-config error-session switches, channel filter UTF-8 note #581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions api-reference/on-call.openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24555,7 +24555,7 @@
},
"query": {
"type": "string",
"description": "Case-insensitive regular expression matched against channel name and description; invalid regex syntax falls back to a literal match."
"description": "Case-insensitive regular expression matched against channel name and description; invalid regex syntax falls back to a literal match. Must be valid UTF-8 — invalid byte sequences are rejected with `InvalidParameter`."
},
"channel_ids": {
"type": "array",
Expand All @@ -24567,7 +24567,7 @@
},
"channel_name": {
"type": "string",
"description": "Exact-match filter on channel name. Takes priority over `query` for name filtering."
"description": "Exact-match filter on channel name. Takes priority over `query` for name filtering. Must be valid UTF-8 — invalid byte sequences are rejected with `InvalidParameter`."
}
}
},
Expand Down
4 changes: 2 additions & 2 deletions api-reference/on-call.openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24555,7 +24555,7 @@
},
"query": {
"type": "string",
"description": "针对协作空间名称和描述的不区分大小写正则匹配；正则语法非法时按字面量匹配。"
"description": "针对协作空间名称和描述的不区分大小写正则匹配；正则语法非法时按字面量匹配。必须为合法 UTF-8，非法字节序列会返回 `InvalidParameter`。"
},
"channel_ids": {
"type": "array",
Expand All @@ -24567,7 +24567,7 @@
},
"channel_name": {
"type": "string",
"description": "协作空间名称精确匹配，优先级高于 `query` 的名称过滤。"
"description": "协作空间名称精确匹配，优先级高于 `query` 的名称过滤。必须为合法 UTF-8，非法字节序列会返回 `InvalidParameter`。"
}
}
},
Expand Down
18 changes: 16 additions & 2 deletions api-reference/openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13535,7 +13535,7 @@
"type": "array"
},
"channel_name": {
"description": "Exact-match filter on channel name. Takes priority over `query` for name filtering.",
"description": "Exact-match filter on channel name. Takes priority over `query` for name filtering. Must be valid UTF-8 — invalid byte sequences are rejected with `InvalidParameter`.",
"type": "string"
},
"is_brief": {
Expand Down Expand Up @@ -13578,7 +13578,7 @@
"type": "integer"
},
"query": {
"description": "Case-insensitive regular expression matched against channel name and description; invalid regex syntax falls back to a literal match.",
"description": "Case-insensitive regular expression matched against channel name and description; invalid regex syntax falls back to a literal match. Must be valid UTF-8 — invalid byte sequences are rejected with `InvalidParameter`.",
"type": "string"
},
"team_ids": {
Expand Down Expand Up @@ -17886,6 +17886,20 @@
"null"
]
},
"sessionOnError": {
"description": "Keep sessions the session sample rate did not draw when they report an error; applies only to sessions that rate missed, so it does nothing alongside a rate of 100.",
"type": [
"boolean",
"null"
]
},
"sessionReplayOnError": {
"description": "The same switch for Session Replay: un-sampled sessions still record and upload their recording only when the session errors.",
"type": [
"boolean",
"null"
]
},
"sessionReplaySampleRate": {
"description": "Session Replay sampling rate (0-100).",
"maximum": 100,
Expand Down
18 changes: 16 additions & 2 deletions api-reference/openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13535,7 +13535,7 @@
"type": "array"
},
"channel_name": {
"description": "协作空间名称精确匹配，优先级高于 `query` 的名称过滤。",
"description": "协作空间名称精确匹配，优先级高于 `query` 的名称过滤。必须为合法 UTF-8，非法字节序列会返回 `InvalidParameter`。",
"type": "string"
},
"is_brief": {
Expand Down Expand Up @@ -13578,7 +13578,7 @@
"type": "integer"
},
"query": {
"description": "针对协作空间名称和描述的不区分大小写正则匹配；正则语法非法时按字面量匹配。",
"description": "针对协作空间名称和描述的不区分大小写正则匹配；正则语法非法时按字面量匹配。必须为合法 UTF-8，非法字节序列会返回 `InvalidParameter`。",
"type": "string"
},
"team_ids": {
Expand Down Expand Up @@ -17886,6 +17886,20 @@
"null"
]
},
"sessionOnError": {
"description": "会话采样率未抽中、但上报了错误的会话也予以保留；仅对采样率未覆盖的会话生效，采样率为 100 时不起作用。",
"type": [
"boolean",
"null"
]
},
"sessionReplayOnError": {
"description": "Session Replay 上的同名开关：未被采样率抽中的会话仍会录制，仅在该会话出错时上传录制内容。",
"type": [
"boolean",
"null"
]
},
"sessionReplaySampleRate": {
"description": "Session Replay 采样率（0-100）。",
"maximum": 100,
Expand Down
14 changes: 14 additions & 0 deletions api-reference/rum.openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,6 +486,20 @@
"null"
]
},
"sessionOnError": {
"description": "Keep sessions the session sample rate did not draw when they report an error; applies only to sessions that rate missed, so it does nothing alongside a rate of 100.",
"type": [
"boolean",
"null"
]
},
"sessionReplayOnError": {
"description": "The same switch for Session Replay: un-sampled sessions still record and upload their recording only when the session errors.",
"type": [
"boolean",
"null"
]
},
"sessionReplaySampleRate": {
"description": "Session Replay sampling rate (0-100).",
"maximum": 100,
Expand Down
14 changes: 14 additions & 0 deletions api-reference/rum.openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,6 +486,20 @@
"null"
]
},
"sessionOnError": {
"description": "会话采样率未抽中、但上报了错误的会话也予以保留；仅对采样率未覆盖的会话生效，采样率为 100 时不起作用。",
"type": [
"boolean",
"null"
]
},
"sessionReplayOnError": {
"description": "Session Replay 上的同名开关：未被采样率抽中的会话仍会录制，仅在该会话出错时上传录制内容。",
"type": [
"boolean",
"null"
]
},
"sessionReplaySampleRate": {
"description": "Session Replay 采样率（0-100）。",
"maximum": 100,
Expand Down
Loading