Grafana基于API Key分享大盘

步骤一：配置Grafana参数

1. 登录可观测可视化 Grafana 版控制台，在左侧导航栏单击工作区管理。

2. 在工作区管理页面，单击目标工作区ID。

3. 在左侧导航栏单击参数设置。

4. 在左侧参数列表选择aliyun，然后单击修改参数。

5. 修改api_key_share参数的运行参数为true，然后单击保存并生效。

   

6. 可选：若期望链接用于iFrame内嵌，则需要额外调整以下参数。

   • 跨域情况下

     域名需为HTTPS，并修改以下3个security参数。

     allow_embedding=true
     cookie_samesite=none
     cookie_secure=true

     

   • 未跨域情况下

     修改security下的allow_embedding参数为true，开启iFrame内嵌即可。

步骤二：创建API Key

Grafana 9.0.x和Grafana 10.0.x版本创建API Key的步骤有所不同，请确认您的Grafana版本并选择对应的操作步骤。

如果您的Grafana是从9.0.x升级到10.0.x版本，那么在Administration > api keys页面依然可以看到Grafana 9.0.x中创建的API Key。此时，单击migrate to service account可以将原有的API Key迁移到Service Account，迁移完成后api keys页面将会被永久隐藏。此外，版本升级不会影响原有API Key的使用。

步骤三：生成分享链接

常见问题

• 通过共享连接访问大盘时页面报错如下：

  可能原因：内嵌大盘情况下，allow_embedding参数未设置。配置allow_embedding参数的操作，请参见上文步骤一。

• 无法显示大盘数据。

  内嵌大盘情况下，Cookie无法写入导致，可能原因如下：

  • 跨域，即根域名不同时，默认配置无法写入Cookie。

  • cookie_samesite参数设置为none，但是cookie_secure参数设置为false。

  • 域名为HTTP。由于cookie_secure参数无法在HTTP下生效，因此域名不支持HTTP。

  解决方案：参考上文步骤一重新配置Grafana参数。

• 通过共享连接访问大盘时页面报错如下：

  可能原因：

  • 浏览器版本过低。

  • 内嵌大盘的情况下浏览器配置导致。

    解决方案：

    1. 查看Cookie使用的配置，允许使用Cookie。

    2. 若使用Chrome浏览器，在无痕模式下需要配置允许所有Cookie。

• 如果用于大盘内嵌，API Key建议是设置较短的有效时间使用一次就更换，还是配置一个很长时间的免登Key？

  您可以根据安全需要做配置，建议3个月换一次，若Key泄露可以通过删除让Key失效。

• API Key是否有数量上限？

  Key的创建官方源码里并没有做限制，由于页面查询时最多展示100条，建议不要超过100个。

• API Key配置的有效时间到期了，这个API Key会自动删除吗？

  Key失效后，数据仍然存在，如果担心占用数量您可以手动删除Key。Grafana页面上失效的Key默认不展示，您可以单击Include expired keys显示已失效Key，然后删除。