集成能力 | 集成方式 | 适用场景 | 对应章节 |
页面内嵌 | iframe | 嵌入统一运维平台、业务系统 | |
链接直达 | URL 参数拼接 | 从业务系统一键跳到指定日志检索页 / 仪表盘 | |
统一域名 | 自定义域名 + 反向代理 | 隐藏真实域名、统一 HTTPS | |
登录对接 | 反向代理 + 第三方认证 | 复用企业内部账号体系(LDAP / OAuth / 自研) |
hide* 系列参数隐藏导航、菜单、按钮等页面元素,让内嵌页面更简洁。// 一个快速查看效果的样例,请根据自身业务进行调整// 请根据实际情况修改 <domain-appid>(DataSight 域名前缀)部分function prepareSdkFrame(url) {var ifrm = document.createElement("iframe");ifrm.setAttribute("src", url);ifrm.style.width = "1280px";ifrm.style.height = "960px";document.body.appendChild(ifrm);}const url = 'https://<domain-appid>.clsconsole.tencentcls.com/cls/search?region=${Region}&topic_id=${TopicId}&query=${Query}&time=now-h,now&hideWidget=true&hideTopNav=true&hideLeftNav=true'prepareSdkFrame(url)

# 请根据实际情况,修改此配置示例中<your-domain.com>、<your-domain-cert>、<domain-appid>(DataSight 域名前缀,支持公网/内网域名)部分# 强烈建议您为自定义域名开启https,并强制http跳转到https,以提升浏览器请求安全性、减少浏览器请求排队等待。# 示例使用新域名(tencentcls.com),老域名实例请替换为 tencent-cloud.com,并以实际实例域名为准# 如不希望强制跳转到https协议,可注释此server配置server {listen 80;server_name your-domain.com;return 301 https://$host$request_uri;}server {# 如希望通过http协议访问,可去掉下行注释# listen 80;listen 443 ssl http2;server_name your-domain.com;ssl_certificate your-domain-cert.pem;ssl_certificate_key your-domain-cert.key;location ~ ^/(.*) {# 可在此处增加自定义访问控制策略,例如:限制指定referer值才可访问#set $match "$1::$http_referer";#if ($match !~* ^(.+)::http[s]*://[www]*[.]*\\1.*$ ) {# return 403;#}proxy_pass https://<domain-appid>.clsconsole.tencentcls.com;proxy_set_header Host $proxy_host;proxy_set_header Origin https://$proxy_host;proxy_set_header Referer "https://$proxy_host/$1";proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;proxy_set_header X-Proxy true;proxy_set_header X-Proxy-Host $host;proxy_set_header X-Proxy-Real-IP $remote_addr;proxy_set_header X-Proxy-Forwarded-Proto $scheme;proxy_redirect ~^(.*)/login\\?s_url=https?%3A%2F%2F[a-z0-9\\-]+(.internal)?.clsconsole.tencentcls.com%2F(.*)$ $1/login?s_url=https%3A%2F%2Fyour-domain.com%2F$3;# 如需要隐藏或自定义DataSight页面的腾讯云图标(favicon),可通过以下两个header实现# proxy_set_header X-DATASIGHT-HIDE-FAVICON true;# proxy_set_header X-DATASIGHT-FAVICON-URL https://github.githubassets.com/favicons/favicon.png;}}

X-DATASIGHT-USER 指定用户名,X-DATASIGHT-ROLE 指定角色名。如需要一次传入多个角色名,也可通过 X-DATASIGHT-ROLES 传入,支持以下格式,DataSight 将使用其中第一个作为角色名。role1,role2。["role1", "role2"]。
curl -X POST \\-H "X-DATASIGHT-USER:your_user" \\-H "X-DATASIGHT-ROLE:your_role" \\https://<domain-appid>.clsconsole.tencentcls.com/api/user
{"isLoggedIn":true,...,"username":"your_user","role":"your_role","isAuthProxy":true}:表示 DataSight 登录校验代理访问正常,并已自动通过 header 登录信息完成登录。{"isLoggedIn":false,"domain":""}:表示 DataSight 登录校验代理访问正常,但 X-DATASIGHT-ROLE 对应的角色在 DataSight 中未配置,请检查前提条件的第 2 步。intranet access denied: xxxx:当前 VPC / IP 不在允许范围,检查前提条件中的 IP 登记。X-DATASIGHT-USER 指定用户名,X-DATASIGHT-ROLE 指定角色名,即可支持。文档反馈