插件 〉Amazon Aurora


开发者

Grafana


注册以接收偶尔的产品新闻和更新



数据源
grafana
企业版

Amazon Aurora

文档 →

Amazon Aurora 数据源

使用 Grafana 从 AWS Aurora 查询和可视化您的数据。此数据源插件目前处于公开预览状态。

简介

使用 Amazon Aurora 数据源,您可以轻松查询和可视化 Amazon Aurora 中的数据。此插件目前支持兼容 MySQL 和 Postgres 的 Aurora 引擎。

Screenshot of a timeseries query with aurora

要求

此插件是为 Grafana 企业版 9.4.7 及以上版本设计的,尽管它可能也适用于较旧版本。

此插件使用 AWS SDK for go 通过 IAM 连接到 AWS Aurora 集群。请阅读 AWS 的“使用 IAM 身份验证和 AWS SDK for Go 连接到您的数据库集群”指南中的先决条件部分,了解如何使用 IAM 连接到您的数据库集群,以确保 Grafana 可以查询您的集群。

示例权限

作为上述内容的一部分,请确保您用于查询 Aurora 的用户/角色具有适当的权限。例如


{
   "Version": "2012-10-17",
   "Statement": [
      {
         "Effect": "Allow",
         "Action": [
             "rds-db:connect"
         ],
         "Resource": [
             "arn:aws:rds-db:us-east-2:1234567890:dbuser:cluster-ABCDEFGHIJKL01234/db_user"
         ]
      }
   ]
}

有关更多信息,请参阅AWS 文档

入门

  1. 安装插件
  2. 使用 UI 添加新数据源配置一个
  3. 配置数据源
  4. 开始查询

配置选项

Amazon Aurora数据源使用AWS SDK for Go通过AWS IAM凭据连接到您的数据库集群。您可以通过几种方式配置Grafana中的数据源实例,以指定如何连接到AWS。

配置选项详细信息
身份验证提供者根据运行环境,Grafana支持不同的身份验证提供者,例如密钥、凭据文件或使用AWS的“默认”提供者,该提供者支持使用基于服务器的IAM角色。可以通过allowed_auth_providers字段手动启用/禁用这些提供者。有关支持的身份验证提供者的更多信息,请参阅云监控数据源的文档
假设角色ARN可选字段,如果您想选择上面的提供者假设一个角色,请使用此字段。
外部ID可选字段,有时在假设角色时使用。
端点可选字段,默认情况下,所有请求都将使用在AWS SDK中指定的端点。但是,如果您想覆盖此设置,您可以选择。
默认区域指定您的集群所在区域。
引擎选择您的集群使用的Aurora引擎。目前我们提供对兼容PostgreSQL和MySQL的引擎的支持。
数据库名称可选字段,用于创建DSN。
数据库用户用于创建DSN。
数据库主机用于创建DSN(注意:建议您选择“指定只读连接”,因为Grafana UI中没有任何东西可以防止对您的数据库进行写入)。
数据库端口用于创建DSN。

高级设置

为了连接到您的集群,Grafana进行两次调用

  1. 使用端点生成RDS的认证令牌
  2. 使用该令牌和您的端点打开DSN连接。

通常这两个步骤的端点是相同的。但是,如果您将DB集群放在负载均衡器后面,您可能需要两个单独的端点。对于第一个步骤,您需要指定负载均衡器后面的端点。对于第二个步骤,您需要指定用于打开SQL连接的负载均衡器端点。为了让Grafana代表您完成此操作,请在“认证数据库主机”和“认证数据库端口”中指定负载均衡器后面的端点,并使用上面的负载均衡器端点/端口配置字段。

已配置的Aurora数据源的示例

如果您正在配置数据源,您可以使用YAML文件设置上述所有配置选项。以下是一个此类文件的示例。

  - name: AWS Aurora with mysql behind a load balancer
    type: grafana-aurora-datasource
    editable: true
    jsonData:
      engine: 'aurora-mysql'
      authType: keys
      dbName: 'testDatabase'
      dbUser: 'dbuser'
      dbHost: 'aurora-mysql.cluster-123.us-east-1.rds.amazonaws.com'
      dbPort: 3306
      defaultRegion: 'us-east-1'
    secureJsonData:
      accessKey: someAccessKey
      secretKey: someSecretKey
    version: 1

以下是一个使用负载均衡器的示例。

  - name: AWS Aurora with mysql behind a load balancer
    type: grafana-aurora-datasource
    editable: true
    jsonData:
      engine: 'aurora-mysql'
      authType: keys
      dbName: 'testDatabase'
      dbUser: 'dbuser'
      dbHost: 'protectedByALoadBalancer.example.com'
      dbPort: 3307
      defaultRegion: 'us-east-1'
      dbPortAuth: 3306
      dbHostAuth 'aurora-mysql.cluster-123.us-east-1.rds.amazonaws.com'
    secureJsonData:
      accessKey: someAccessKey
      secretKey: someSecretKey
    version: 1

查询

表与时间序列

与其他SQL数据源插件类似,在Grafana中查询时,您可以指定是否将数据作为“宽”或“长”时间序列返回。这由“格式”下拉菜单控制。

为了更好地解释这个概念,考虑以下表格

Using Format As Table with a Table Visualization

当我们用时间序列可视化渲染相同的查询时,我们会注意到“neighborhood”和“city”字段合并为1个时间序列。

Using Format As Table with a Time Series Visualization

这通常是SQL数据源所期望和期望的行为,尤其是在使用表格可视化时。然而,有时您可能希望为每个城市/社区组合渲染不同的时间序列。要做到这一点,在“格式为”下拉菜单中选择“时间序列”,将呈现相同的时间序列可视化,如下所示

Using Format as Time Series with a Time Series Visualization

当使用探索时,Grafana会在您更改格式时自动使用适当的时间序列或表格可视化。在仪表板的查询编辑器中,用户控制数据可视化的方式。

要了解更多信息,请参阅Grafana文档中的时间序列格式

变量和宏

此插件支持自定义和全局变量,以简化查询的编写。例如,如果您将自定义变量设置为$tableName,则可以在仪表板中跨多个表使用相同的查询。

select * from $tableName limit 3;

{{< 注解类型="note" >变量与Grafana警报不兼容。{{ /注解 >}}

此插件还支持来自sql util库的宏,例如$__timeFrom$__timeTo。例如

select * from test_table where $__timeFrom(recorded_at) and $__timeTo(recorded_at)

如果您对Aurora数据源有独特的宏建议,请随时联系客户支持。

在Grafana Cloud上安装Amazon Aurora

有关更多信息,请访问插件安装文档。

变更日志

0.2.4

  • #65中合并了对数据库连接泄漏的下游修复。
  • #62中添加了依赖项管理。

0.2.3

  • 添加错误源,更新依赖项 (#60)
  • 将grafana-plugin-sdk-go升级到0.250.2 (#61)
  • 将grafana-aws-sdk升级到0.31.2 (#61)

0.2.2

  • 修复文档语法

0.2.1

  • 更新plugin.json数据源名称以遵循约定
  • 更新READMEs和文档以符合命名约定
  • 更新发布流程文档

0.2.0

  • 首次公开预览发布

0.1.11 (开发版本)

  • 使用绝对路径放置图像

0.1.10 (开发版本)

  • 更新依赖项

0.1.9 (开发版本)

  • 添加文档

0.1.8 (测试客户私有发布)

  • 添加对表格和时序格式下拉菜单的支持

0.1.7 (测试客户私有发布)

  • 添加对MySQL的支持并修复与PostgreSQL转换器相关的问题

0.1.6 (测试客户私有发布)

  • 添加对生成认证令牌的独立端口的支持

0.1.5 (测试客户私有发布)

  • 添加对变量/宏的支持

0.1.4 (测试客户私有发布)

  • 支持具有特定端点的假设角色
  • 更新plugin-e2e

0.1.3 (测试客户私有发布)

  • 删除日志行

0.1.2 (测试客户私有发布)

  • 为生成认证令牌添加额外的主机选项

0.1.1 (测试客户私有发布)

  • 添加对假设角色的支持
  • 添加新的配置编辑页面
  • 临时添加日志行以进行更好的调试

0.1.0 (测试客户私有发布)

首次公开测试版发布。