插件 〉Oracle Cloud Infrastructure Metrics
Oracle Cloud Infrastructure Metrics
关于 OCI Metrics plugin for Grafana
简介
此插件向 Oracle Cloud Infrastructure (OCI) 监控服务发出查询,以获取您的 OCI 资源或您在 OCI 中的自定义指标,然后在 Grafana 上显示它们。
如果您在 Oracle Cloud 的机器实例上运行 Grafana,请使用配置了动态组和策略的实例主体 (Instance Principal),以允许您读取指标和区间 (compartment)。
如果您在其他任何地方运行 Grafana,则需要获取必要的提供程序和资源设置,如本节中所述:获取 OCI 配置值 (Getting OCI Configuration values)
最新插件版本 5.X.X(可在 Grafana Marketplace 获取)与 Grafana 10 兼容。
重大变更
- 如果您正在从 OCI Metrics Grafana 插件的先前版本(3.x.x 或更早版本)迁移,并且未使用实例主体 (Instance Principal)(环境未设置为 OCI 实例),请参阅Grafana OCI 指标数据源设置迁移说明(仅限用户主体和单租户模式),因为您将需要重新配置插件设置
- 如果您正在从 OCI Metrics Grafana 插件的先前版本(4.x.x 或更早版本)迁移到版本 5.x.x,并且您的仪表盘在其选择器中或作为其模板变量使用了 dimensions,请参阅此部分以根据新的 dimensions 选择器修改您的仪表盘。
Oracle Cloud Infrastructure Metrics 插件是带后端 (datasource with backend) 类型的 Grafana 插件。以下简称 OCI Metrics 插件。
安装
请参考以下兼容性矩阵,根据您的 Grafana 安装选择插件版本:兼容性矩阵
为了简化安装过程,我们创建了详细的指南供您参考。
使用本文档在 Linux 主机上安装 Grafana 和 OCI Metrics 插件。
使用本文档在 Grafana Cloud 上安装 Grafana 和 OCI Metrics 插件。
使用本文档在 MacOS 主机上安装 Grafana 和 OCI Metrics 插件。
使用本文档在 Oracle Cloud Infrastructure 的虚拟机上安装 Grafana 和 OCI Metrics 插件。
使用本文档使用 Terraform 在 Oracle Cloud Infrastructure 的虚拟机上安装 Grafana 和 OCI Metrics 插件。
使用本文档在 Oracle Cloud Infrastructure 的 Kubernetes 上安装 Grafana 和 OCI Metrics 插件
安装 OCI Metrics 插件后,使用您的租户 OCID、默认区域和正确的 IAM 设置(动态组或在 Grafana 服务器节点上的本地私钥文件进行 OCI 用户认证 - 具体取决于您在哪里运行 Grafana - Oracle Cloud 或其他地方)配置您的数据源。
我们还提供了关于如何在我们的《将 Grafana 与 OCI Metrics 插件配合使用》演练文档中使用新安装和配置的插件的文档。
注 1
如果您使用的 Grafana 版本低于 6.0,则需要下载插件版本 <=2.2.4 的 zip 文件并手动安装此插件,或使用 chmod 命令使下载的二进制文件可执行。
注 2
OCI Metrics 插件支持与 Grafana Cloud 集成,其中数据源环境 (Data Source Environment) 配置为本地 (local)。请参阅本文档获取更多信息。
调试
请确保安装的 golang 版本为 1.16
,安装的 grafana 版本为 8.x.x
如果您想调试 golang 后端插件代码,请按照以下步骤操作
安装 gops 以列出您机器上正在运行的 go 进程
运行
gops
并找到oci-plugin_darwin_amd64
进程的 processId将此 processId 复制到
.vscode/launch.json
文件中在 VSCode 中,从“调试 (Debug)”菜单调用“启动调试 (Start Debugging)”
文档
帮助
关于此插件的问题可以在此 GitHub 仓库中作为 Issue 发布
贡献
本项目欢迎社区贡献。在提交拉取请求 (pull request) 之前,请查看我们的贡献指南 (contribution guide)
安全
有关我们负责任的安全漏洞披露流程,请参阅安全指南 (security guide)。
许可证
版权所有 (c) 2024 Oracle 和/或其关联公司。
根据 Universal Permissive License v1.0 发布,如以下链接所示
在 Grafana Cloud 上安装 Oracle Cloud Infrastructure Metrics
在 Grafana Cloud 实例上安装插件是一键式操作;更新也一样。很棒,对吧?
请注意,插件可能需要长达 1 分钟才能在您的 Grafana 中显示。
在 Grafana Cloud 实例上安装插件是一键式操作;更新也一样。很棒,对吧?
请注意,插件可能需要长达 1 分钟才能在您的 Grafana 中显示。
在 Grafana Cloud 实例上安装插件是一键式操作;更新也一样。很棒,对吧?
请注意,插件可能需要长达 1 分钟才能在您的 Grafana 中显示。
在 Grafana Cloud 实例上安装插件是一键式操作;更新也一样。很棒,对吧?
请注意,插件可能需要长达 1 分钟才能在您的 Grafana 中显示。
在 Grafana Cloud 实例上安装插件是一键式操作;更新也一样。很棒,对吧?
请注意,插件可能需要长达 1 分钟才能在您的 Grafana 中显示。
在 Grafana Cloud 实例上安装插件是一键式操作;更新也一样。很棒,对吧?
请注意,插件可能需要长达 1 分钟才能在您的 Grafana 中显示。
在 Grafana Cloud 实例上安装插件是一键式操作;更新也一样。很棒,对吧?
请注意,插件可能需要长达 1 分钟才能在您的 Grafana 中显示。
有关更多信息,请访问关于插件安装的文档。
在本地 Grafana 上安装
对于本地实例,插件通过简单的 CLI 命令安装和更新。插件不会自动更新,但当有更新可用时,您将在 Grafana 中收到通知。
1. 安装数据源
使用 grafana-cli 工具通过命令行安装 Oracle Cloud Infrastructure Metrics
grafana-cli plugins install
插件将安装到您的 grafana plugins 目录中;默认目录是 /var/lib/grafana/plugins。有关 CLI 工具的更多信息。
2. 配置数据源
从 Grafana 主菜单访问,新安装的数据源可以立即在数据源部分添加。
接下来,点击右上角的“添加数据源”按钮。该数据源将在“类型 (Type)”下拉框中可供选择。
要查看已安装数据源的列表,请点击主菜单中的“插件 (Plugins)”项。核心数据源和已安装数据源都会显示出来。
<a name="v6.5.1"></a>
安全维护版本 (v6.5.1) - 2025 年 2 月 28 日
此版本包括
- 修复 Issue #311
- 修复 Issue #309
[变更][v6.5.1]
<a name="v6.5.0"></a>
支持 DRCC/Alloy 区域 (v6.5.0) - 2025 年 2 月 5 日
此版本包括
- 支持 DRCC/Alloy 区域
- OCI Golang 库更新至 v65.81.3
- 一些 Bug 修复
- 支持自定义区域
[变更][v6.5.0]
<a name="v6.0.3"></a>
安全维护版本 (v6.0.3) - 2024 年 11 月 26 日
此版本包括
- 为 SummarizeMetrics 操作实现重试功能
<a name="v6.0.2"></a>
安全维护版本 (v6.0.2) - 2024 年 10 月 14 日
此版本包括
- 安全补丁
- 添加了新区域
<a name="v6.0.1"></a>
安全维护版本 (v6.0.1) - 2024 年 10 月 3 日
此版本包括
- 安全补丁
<a name="v6.0.0"></a>
安全维护版本 (v6.0.0) - 2024 年 9 月 16 日
此版本包括
- 安全补丁
- React 18 升级
- 支持 Grafana 11
- 添加了新区域
- golang 和 typescript 库更新
<a name="v5.5.1"></a>
安全维护版本 (v5.5.1) - 2024 年 7 月 3 日
此版本包括
- 少量安全补丁
- 修复了多租户测试功能中的错误
<a name="v5.5.0"></a>
启用告警并支持跨租户 (v5.5.0) - 2024 年 5 月 15 日
此版本包括
- 支持告警
- 实例主体模式下的跨租户支持
- 错误修复
- 安全修复
<a name="v5.5.0-beta-unsigned"></a>
包括告警支持的 Beta 版本 (v5.5.0-beta-unsigned) - 2024 年 4 月 24 日
************* 警告 ***********
这是一个未签名的 Beta 版本。这意味着它仍不是最终版本,尚未准备好用于生产环境,并且未签名。您必须在 grafana.ini 中启用以下选项才能使用此版本:app_mode = development 此版本尚未在 Grafana 目录中提供,您需要手动将二进制文件解压到 Grafana 插件目录中来安装此插件。
此 Beta 版本包含告警功能。
<a name="v5.2.0"></a>
支持多区域并增强了时间间隔 (v5.2.0) - 2024 年 4 月 16 日
此版本包括
- 支持多区域
- 将时间间隔用作模板变量
- 自动时间间隔设置
- 修复了 babel-traverse 包中的安全问题,该包易受 CVE-2023-45133 攻击
- 增强了错误处理
- 提高了查询性能
<a name="v5.1.1"><a>
修复了 Regex 并支持主权云 (v5.1.1) - 2024 年 3 月 8 日
实现以下内容
- 修复了在模板变量中使用区间时的 Regex 问题
- 支持主权云
- 探索使用 Grafana 版本高于 v10.1 时的问题
<a name="v5.1.0"></a>
修复了区间 Regex 并添加了新的主权区域 (v5.1.0) - 2024 年 3 月 7 日
- 修复了区间 Regex。
- 添加了新的主权区域
<a name="v5.0.4"></a>
添加了数据源配置的新区域 (v5.0.4) - 2024 年 2 月 20 日
- 在数据源配置中添加了新增的缺失区域
- 修复了数据源配置页面(src/ConfigEditor.tsx)中的一个小错误
<a name="v5.0.3"></a>
改进了自定义标签管理 (v5.0.3) - 2024 年 1 月 18 日
此维护版本包括
修复了在原始查询中从 OCI API 返回的维度值列表问题。修复了在使用自定义标签对非索引维度(例如 oci_autonomous_database)进行排序时的错误。
<a name="v5.0.2"></a>
原始查询模板变量 (v5.0.2) - 2024 年 1 月 10 日
原始查询模板变量
<a name="v5.0.1"></a>
原始模式和自定义指标标签 (v5.0.1) - 2024 年 1 月 9 日
- 支持对某些自定义指标进行标签化
- 支持原始查询模式
- 错误修复和安全修复
<a name="v5.0.0"><a>
支持 Grafana 10 (v5.0.0) - 2023 年 10 月 11 日
- 前端完全使用 React/Typescript 重写
- 兼容 Grafana 10
- 缓存区域、租户、区间、维度查询
- 许多性能改进
- 新的 Grafana API
<a name="v4.0.1"></a>
升级 nodejs 依赖项并修复少量安全错误 (v4.0.1) - 2023 年 4 月 11 日
- 升级了 nodejs 依赖项
- 升级了 net golang 库
<a name="v4.0.0"><a>
支持多租户和 OCI 安全 JSON (v4.0.0) - 2023 年 3 月 7 日
此版本特性包括
- 支持多租户
- OCI 配置的安全 JSON 机密
- 添加了对圣何塞区域的支持
<a name="v3.0.6"></a>
区域列表排序、自定义标签、ARM64 支持、命名空间下拉字段错误修复和漏洞补丁 (v3.0.6) - 2022 年 10 月 24 日
- 自定义图表标签 (https://github.com/oracle/oci-grafana-metrics/pull/131)
- OCI 区域列表按字母顺序排序 (https://github.com/oracle/oci-grafana-metrics/pull/132)
- 更新了 GoLang 和 Javascript 库,漏洞补丁 (https://github.com/oracle/oci-grafana-metrics/pull/133, https://github.com/oracle/oci-grafana-metrics/pull/134, https://github.com/oracle/oci-grafana-metrics/pull/136, https://github.com/oracle/oci-grafana-metrics/pull/137, https://github.com/oracle/oci-grafana-metrics/pull/138, https://github.com/oracle/oci-grafana-metrics/pull/139, https://github.com/oracle/oci-grafana-metrics/pull/140)
- 修复了指标命名空间下拉字段的错误 (https://github.com/oracle/oci-grafana-metrics/pull/135)
- 支持 ARM64 (https://github.com/oracle/oci-grafana-metrics/pull/129)
<a name="v3.0.5"></a>
v3.0.5 - 添加了新区域 - 2022 年 6 月 16 日
添加了新区域
- 新加坡
- 巴黎
- 克雷塔罗
更新 Grunt 版本。更新 Linux readme。
<a name="v3.0.4"></a>
小补丁 (v3.0.4) - 2022 年 3 月 16 日
更新构建文件,plugin.json
<a name="v3.0.3"></a>
修复模板变量错误 (v3.0.3) - 2022 年 2 月 11 日
修复了多个数据源和模板变量的问题。
<a name="v3.0.2"></a>
Grafana 8 热修复支持 (v3.0.2) - 2022 年 2 月 10 日
这是对 Grafana 8 支持的临时解决方案,可能尚未完全完善。完整支持将在稍后发布。
<a name="v2.2.4"></a>
添加了英国政府支持并进行了开发变更 (v2.2.4) - 2021 年 8 月 9 日
- 添加了对英国政府区域
uk-gov-london-1 , uk-gov-cardiff-1
的支持
开发变更
- 移除了 toml 文件并替换为 mod
- 添加了一些安装和签名相关内容。
对于 Oracle Grafana 开发人员,在下一个版本中:将以下内容附加到构建脚本 zip -r oci-grafana-metrics-<VERSION> ./dist
<a name="v2.2.3"></a>
修复了缺失的指标 (v2.2.3) - 2021 年 1 月 22 日
处于测试阶段,请勿在生产环境中使用
- 现在,所有指标都能被接收到。
- 指标请求现在快了 20 倍。
- 对插件进行了签名并添加到 tar 文件中。
<a name="v2.2.2"></a>
修复了资源组相关的文档 (v2.2.2) - 2021 年 1 月 11 日
- 修复了每个查询中包含资源组的文档
<a name="v.2.2.1"></a>
添加了对迪拜、圣地亚哥和卡迪夫的支持 (v.2.2.1) - 2020 年 12 月 22 日
此版本添加了对新区域(如圣地亚哥、卡迪夫和迪拜)的支持
<a name="v2.2"><a>
添加了对 ap-chiyoda-1 的支持 (v2.2) - 2020 年 12 月 8 日
- 支持在 ap-chiyoda-1 区域调用 Oracle Cloud Infrastructure 服务
<a name="2.0.2"></a>
Grafana 指标插件支持 (2.0.2) - 2020 年 10 月 5 日
请仅下载插件文件
这不适用于所有用户
请生成 manifest 文件并以电子邮件方式发送给我们
plugin.json 中的版本已更新为 2.0.0
<a name="v2.0.1"></a>
Logging-plugin-zip (v2.0.1) - 2020 年 10 月 5 日
- 不适用于所有用户
- 这与当前代码无关
- 仅下载 plugin.tar 和其他文件
- 仅用于 Grafana 支持
<a name="v2.0.0"></a>
v2.0.0 - 2020 年 9 月 28 日
更新了插件的名称和 ID。
请移除现有插件并安装此版本
功能没有变化。
<a name="v1.1.2"></a>
支持 Grafana 7 (v1.1.2) - 2020 年 7 月 7 日
- 更新 Grafana 7 的文档
- 扩展了默认区域列表。
- 修复了分辨率输入
<a name="v1.1.1"></a>
修复了列表指标 API 调用 (v1.1.1) - 2020 年 6 月 4 日
- 现在,列表指标调用的数量已设置为最多 20 页
- 此限制是可配置的
<a name="v1.1.0"></a>
添加了窗口和分辨率中的变量和自动支持 (v1.1.0) - 2020 年 4 月 6 日
新功能
- 添加了窗口和分辨率中的变量和自动支持
少量错误修复
- 修复了下拉列表中的变量重复问题
文档
- 添加了在下拉菜单的窗口和分辨率中使用变量和自动配置的说明
<a name="V1.0.9"></a>
向 getCompartment 方法添加了区域选项 (V1.0.9) - 2020 年 3 月 12 日
当 OCI 租户只配置了一个区域(例如 'us-phoenix-1',即 home 租户),并且本地的数据源设置的默认区域是 'us-ausburn-1'(在 ~/.oci/config 文件中)时,getCompartment 不会返回区间列表。原因是 OCI 租户只有一个作为 home 的租户,而这个租户不是 'us-phoenix-1' 租户。
解决方案是在进行 getCompartment 调用时,将区域设置为 OCI 租户的 home 区域。
感谢 Jayesh Patel
<a name="V1.0.8"></a>
支持资源组 (V1.0.8) - 2020 年 3 月 10 日
用户将能够使用资源组。默认情况下:不使用资源组
<a name="V1.0.7"></a>
V1.0.7 - 2020 年 2 月 21 日
修复了根据所选区域填充的指标字段。
<a name="V1.0.6"><a>
支持模板变量中的硬编码值 (V1.0.6) - 2020 年 1 月 23 日
- 支持模板变量中的硬编码值
- 修复了在模板变量编辑器中使用 regex 过滤区间时的错误
<a name="V1.0.5"></a>
支持手动查询。新增维度模板变量。(V1.0.5) - 2019 年 11 月 25 日
- 新增了模板变量
dimensions()
显示所选区域、区间、命名空间和指标的所有可能维度键dimensionOptions()
显示所选区域、区间、命名空间、指标和维度键的所有可能维度值。
维度值变量可用作多值变量。多选中的每个维度值都会生成单独的查询(但查询数量不超过 20 个)
支持自定义查询。用户可以手动输入 MQL 表达式,该表达式将传递给 telemetry,而不是 UI 上选择的指标和维度。
自定义模板变量已添加到维度值选项列表中。重复选项已移除。
在查询编辑器打开期间,区域和区间的选项会被缓存。维度选项会为所选区域 - 区间 - 命名空间 - 指标进行缓存。
<a name="V1.0.4"></a>
修复了 $namespace 和 $metric 变量 (V1.0.4) - 2019 年 10 月 3 日
$namespace
在之前的版本中,$namespace 变量的命名空间列表是硬编码的。现在,命名空间列表取决于区域和区间。
$metric
在之前的版本中,$metric 变量取决于 home 区域、$compartment 和硬编码的 $namespace。现在,$metric 取决于 $region、$compartment 和 $namespace。
<a name="V1.0.3"></a>
V1.0.3 - 2019 年 9 月 25 日
修复问题:更新了指标名称规则创建
<a name="v1.0.2"></a>
v1.0.2 - 2019 年 3 月 27 日
- 显示子区间并从列表中移除非活动区间
- 在屏幕上渲染时更改指标名称,如果资源有人类可读名称,则使用该名称
- 将 OCID 缩短为前三个和后六个字符,以节省屏幕空间
<a name="v1.0.1"></a>
v1.0.1 - 2019 年 3 月 8 日
动态获取区域,添加更多文档
<!-- Generated by https://github.com/rhysd/changelog-from-release v3.7.2 -->