最近更新时间:2024.03.28 10:35:47
首次发布时间:2022.11.25 21:31:15
日志服务提供控制台内嵌功能,即支持将检索分析页面和仪表盘页面嵌入到外部系统的自建 Web 页面中。构建日志服务控制台内嵌的免密访问链接时,您可以通过指定 URL 参数的形式设置内嵌页面的显示效果。
构建日志服务控制台内嵌的免密访问链接时,redirectURI
部分应指定为 encodeURL 转码后的日志服务控制台页面链接。链接格式如下:
检索分析页面
https://console.volc-embed.com/tls/region:tls+${regionId}/project/${projectId}/search?UI参数1&UI参数2
仪表盘页面
https://console.volc-embed.com/tls/region:tls+${regionId}/project/${projectId}/dashboard/${dashboardId}?UI参数1&UI参数2
说明
日志服务提供以下 UI 参数,您可以在页面链接中按需使用。
参数 | 数据类型 | 是否必选 | 示例 | 说明 |
---|---|---|---|---|
hideLeftBar | Boolean | 可选 | true | 是否隐藏日志服务控制台左侧的导航栏。
|
hideTitle | Boolean | 可选 | true | 是否隐藏日志服务控制台检索分析页面的标题栏。
|
hideTopic | Boolean | 可选 | true | 是否隐藏日志服务控制台检索分析页面的 Topic 选择框。
|
hideIndexBtn | Boolean | 可选 | true | 是否隐藏日志服务控制台检索分析页面的索引配置按钮。
|
hideShareBtn | Boolean | 可选 | true | 是否隐藏日志服务控制台检索分析页面的分享图标。
|
topicId | String | 可选 | c5c0a2a1-8431-4370-b98c-d20f5f7d**** | 指定日志主题 ID。您可以在日志服务控制台中查看日志主题 ID。详细步骤请参考日志主题。 |
codebase64 | String | 可选 | KiB8IHNlbGVjdCAq | 指定检索分析语句,需通过 Base64Url 编码。 |
time | String | 可选 | now-1m,now | 设置待检索的日志的时间范围。支持设置固定时间范围或自定义时间范围。
|
参数名称 | 数据类型 | 是否必填 | 示例 | 描述 |
---|---|---|---|---|
time | String | 可选 | now-1m,now | 设置待检索的日志的时间范围。详细说明请参考时间字段枚举值。 |
refreshTime | String | 可选 | 1m | 设置仪表盘的刷新频率。详细说明请参考时间字段枚举值。 |
filter-${filterName}=${value} | String | 可选 | filter-a=v1 | 设置仪表盘过滤器默认值,可使用 |
temp[Fixed | Hidden]Var-${key}=${value} | String | 可选 | tempFixedVar-httpStatusCode=200
|
temp[Fixed | Hidden]Filter-${name}=${value} | String | 可选 | tempFixedFilter-name=1
|
hideFilters=${filterNameList} | String[] | 'all' | 可选 | hideFilters=["a", "b"] |
fixedFilters=${filterNameList} | String[] | 'all' | 可选 | fixedFilters=["a", "b"] |
readonly | Boolean | 可选 | true | 是否设置为只读模式。
|
hideLeftBar | Boolean | 可选 | false | 是否隐藏日志服务控制台左侧的导航栏。
|
hideHeader | Boolean | 可选 | false | 是否隐藏日志服务控制台中仪表盘的顶部菜单栏,包括仪表盘标题、分享按钮和工具栏模块。
|
hideTitle | Boolean | 可选 | false | 是否隐藏日志服务控制台中仪表盘的标题。
|
hideShareBtn | Boolean | 可选 | false | 是否隐藏日志服务控制台中仪表盘的分享按钮。
|
hideToolbar | Boolean | 可选 | false | 是否隐藏日志服务控制台中仪表盘的工具栏。
|
hideSetting | Boolean | 可选 | false | 是否隐藏日志服务控制台中仪表盘的设置按钮。
|
hideSubscribeBtn | Boolean | 可选 | false | 是否隐藏日志服务控制台中仪表盘的订阅按钮。
|
hideTimeSelector | Boolean | 可选 | false | 是否隐藏日志服务控制台中仪表盘的时间选择按钮。
|
hideRefreshSelector | Boolean | 可选 | false | 是否隐藏日志服务控制台中仪表盘的自动刷新按钮。
|
hideFullScreenBtn | Boolean | 可选 | false | 是否隐藏日志服务控制台中仪表盘的全屏按钮。
|
hideAddChartBtn | Boolean | 可选 | false | 是否隐藏日志服务控制台中仪表盘的添加图表按钮。
|
hideSaveBtn | Boolean | 可选 | false | 是否隐藏日志服务控制台中仪表盘的保存按钮。
|
hidePanelMenu | Boolean | 可选 | false | 是否隐藏日志服务控制台仪表盘中统计图表的操作按钮。
|
hidePanelEdit | Boolean | 可选 | false | 是否隐藏日志服务控制台仪表盘中统计图表的编辑按钮。
|
hidePanelCopy | Boolean | 可选 | false | 是否隐藏日志服务控制台仪表盘中统计图表的复制按钮。
|
hidePanelAddAlert | Boolean | 可选 | false | 是否隐藏日志服务控制台仪表盘中统计图表的添加告警按钮。
|
hidePanelDelete | Boolean | 可选 | false | 是否隐藏日志服务控制台仪表盘中统计图表的删除按钮。
|
hidePanelFullScreen | Boolean | 可选 | false | 是否隐藏日志服务控制台仪表盘中统计图表的全屏按钮。
|
viewType | String | 可选 | fullScreen | 设置仪表盘的展示状态。可选值:
设置统计图表的相关状态时,需指定 |
panelId | String | 可选 | 40d9****7637 | 统计图表 ID。 |
time 字段time
字段支持设置的固定时间范围格式如下:
time 字段枚举值 | 说明 |
---|---|
now-1m,now | 近 1 分钟。 |
now-5m,now | 近 5 分钟。 |
now-15m,now | 近 15 分钟。 |
now-30m,now | 近 30 分钟。 |
now-1h,now | 近 1 小时。 |
now-3h,now | 近 3 小时。 |
now-6h,now | 近 6 小时。 |
now-1d,now | 近 1 天。 |
now-3d,now | 近 3 天。 |
now-7d,now | 近 7 天。 |
now-30d,now | 近 30 天。 |
now-90d,now | 近 90 天。 |
now/d,now/d | 今天。 |
now/w,now/w | 本周。 |
now/M,now/M | 本月。 |
refreshTime 字段refreshTime
字段支持设置的固定时间范围格式如下:
refreshTime 枚举值 | 说明 |
---|---|
15s | 15秒 |
1m | 1分钟 |
5m | 5分钟 |
10m | 10分钟 |
30m | 30分钟 |
60m | 60分钟 |
以下示例展示了第三方系统 Web 页面内嵌的日志服务检索分析页面,该页面设置了指定的 Topic 、检索分析语句、检索日志的时间范围;隐藏了左侧导航栏、页面标题栏、Topic 选择框、分享按钮及索引配置按钮。
内嵌链接
https://https://console.volcengine.com/tls/region:tls+cn-guangzhou/project/e783ddd1-f07e-404f-b167-915d04d6****/search?topicId=999ecfa1-9eed-4cb4-ac2e-e130f656****&time=now-5m,now&codebase64=KiB8IHNlbGVjdCAq&hideTitle=true&hideTopic=true&hideIndexBtn=true&hideLeftBar=true&hideShareBtn=true
显示效果
以下示例展示了第三方系统 Web 页面内嵌的日志服务仪表盘页面,该页面设置了日志的检索时间范围为近 1小时,隐藏了左侧导航栏、分享按钮和设置按钮。
内嵌链接
https://console.volcengine.com/tls/region:tls+cn-guangzhou/project/06178e6b-63f7-4245-987e-4e1dd555****/dashboard/f1ad1620-2baf-4f4a-b336-9864ec77****?&time=now-1h,now&hideLeftBar=true&hideShareBtn=true&hideSetting=true
显示效果
以下示例展示了第三方系统 Web 页面内嵌的日志服务仪表盘页面,该页面设置了日志的检索时间范围为近 1小时,添加了临时过滤器shardid=1
。
内嵌链接
https://console.volcengine.com/tls/region:tls+cn-guangzhou/project/06178e6b-63f7-4245-987e-4e1dd555****/dashboard/f1ad1620-2baf-4f4a-b336-9864ec7****?tempFixedFilter-shardidFilter= AND shardid:1&time=now-1h%2Cnow
显示效果