配置 MongoDB 数据源
本文档提供了配置 MongoDB 数据源的说明,并解释了可用的配置选项。有关在 Grafana 中添加数据源的一般信息,请参阅添加数据源。
开始之前
您必须具有
组织管理员
角色才能添加数据源。管理员还可以通过Grafana Provisioning 系统使用 YAML 配置数据源。在添加 MongoDB 数据源之前,必须安装 MongoDB 插件。有关如何添加插件的说明,请参阅安装。有关插件的一般信息,请参阅插件管理。
熟悉您的 MongoDB 安全配置,并收集任何必要的安全证书和客户端密钥。
验证来自 MongoDB 数据源的数据是否正在写入您的 Grafana 实例。
使用 UI 配置数据源
要添加 MongoDB 数据源,请完成以下步骤
- 安装 MongoDB 插件。
- 点击左侧菜单中的连接。
- 在连接下,点击添加新连接。
- 在搜索栏中输入
MongoDB
。 - 在数据源部分下选择MongoDB。
- 点击右上角的添加新数据源。
您将被带到设置选项卡,在那里设置您的 MongoDB 配置。
配置选项
以下是 MongoDB 的配置选项列表。
名称 - 数据源名称。设置您在面板和查询中引用数据源时使用的名称。示例:
MongoDB-1
、MongoDB_Marketing
。默认 - 切换此选项以设置为默认数据源。
连接
您可以使用连接字符串连接到 MongoDB。有关更多信息,请参阅 MongoDB 文档中的连接字符串。
- 连接字符串 - 插入您的 MongoDB 连接字符串,其中包含连接到 MongoDB 所需的参数。示例:
mongodb://myDatabaseUserName:StrongP%ssw0rd@localhost/sales_db
;mongodb://myDatabaseUserName:StrongP%ssw0rd@%2Ftmp%2Fmongodb-27017.sock
身份验证
身份验证部分有三种身份验证方法可供选择。从下拉列表中选择以下一种身份验证方法
无身份验证 - 允许在没有任何身份验证的情况下访问数据源。
凭据 - 使用创建帐户时分配给 MongoDB 的默认凭据进行身份验证。
- 用户 - 分配给 MongoDB 帐户的用户名。
- 密码 - 分配给 MongoDB 帐户的密码。
Kerberos - Kerberos 需要手动安装的自定义构建。可在此处访问自定义构建。
- 用户 - 客户端主体的用户名。
- 密码 - 用于身份验证的客户端主体密码。如果存在 keytab 或 ccache 文件,则可选。
- KeyTab 文件路径 - KeyTab 文件的绝对文件路径。如果提供,密码将被忽略。当连接字符串包含查询字符串参数
authMethod=GSSAPI
时启用。 - 全局 ccache 文件路径 - 全局缓存文件的绝对文件路径。如果提供,密码将被忽略。当连接字符串包含查询字符串参数
authMethod=GSSAPI
时启用。 - Ccache 查找文件 - 提供基于用户名主体和连接字符串的 Kerberos 缓存的 JSON 文件的绝对文件路径。如果提供,密码将被忽略。当连接字符串包含查询字符串参数
authMethod=GSSAPI
时启用。
要在 Linux 上运行此程序,必须安装 libkrb5
库
apt-get install -y libkrb5-dev
TLS 设置
使用 TLS (Transport Layer Security) 为与 MongoDB 的工作提供额外的安全层。
- 添加自签名证书 - 勾选此框以使用 CA 证书进行身份验证。按照 CA(证书颁发机构)的说明下载证书文件。验证自签名 TLS 证书所需。
- CA 证书: - 添加您的自签名证书。
- TLS 客户端身份验证 - 勾选此框以使用 TLS 客户端身份验证进行身份验证,其中服务器对客户端进行身份验证。
- ServerName 添加服务器名称,用于验证返回证书上的主机名。示例:
domain.example.com
。 - 客户端证书 添加您的客户端证书,该证书可以从证书颁发机构 (CA) 生成,也可以是自签名的。
- 客户端密钥 添加您的客户端密钥,该密钥也可以从证书颁发机构 (CA) 生成,也可以是自签名的。客户端密钥用于加密客户端和服务器之间的数据。
- ServerName 添加服务器名称,用于验证返回证书上的主机名。示例:
- 跳过 TLS 证书验证 - 勾选此框以绕过 TLS 证书验证。除非绝对必要或用于测试目的,否则不建议跳过 TLS 证书验证。
请注意,每个证书的最大大小为 64KB。较长的证书很可能会被截断并且无法工作。
附加设置
MongoDB 数据源的附加设置是可选配置,可对其行为提供更大的控制。
查询语法验证
- 启用语法验证 - 切换此选项以启用实时查询语法验证。此功能会在您编写查询时检查其语法,并提供有关错误或不一致之处的即时反馈,包括缺失的括号
{}
、不正确的操作符结构以及无法识别的字段名。它确保查询在执行前结构正确,从而减少错误并提高效率。有关 MongoDB BSON 文档数据格式的更多信息,请参阅文档数据格式:BSON。
后端响应行数限制
- 返回行数 - 设置查询返回的最大行数。默认值为
100000
。请注意,将此数字设置得太高可能会导致大型查询出现性能问题。
私有数据源连接
- 私有数据源连接 - 仅适用于 Grafana Cloud 用户。私有数据源连接(PDC)允许您在 Grafana Cloud 实例或堆栈与私有网络中安全的数据源之间建立私有、安全的连接。点击下拉列表查找 PDC 的 URL。有关 Grafana PDC 的更多信息,请参阅私有数据源连接 (PDC) 和配置 Grafana 私有数据源连接 (PDC),了解设置 PDC 连接的步骤。
点击管理私有数据源连接将转到您的 PDC 连接页面,您可以在其中找到您的 PDC 配置详情。
配置好您的 MongoDB 数据源选项后,点击底部的保存并测试以测试您的数据源连接。
您应该会看到一个确认对话框,显示插件健康检查成功。
您还可以通过点击删除来移除连接。
Provision MongoDB 数据源
您可以将 MongoDB 数据源定义和配置在 YAML 文件中,作为 Grafana Provisioning 系统的一部分。有关 Provision 数据源的更多信息以及可用的配置选项,请参阅Provision Grafana。
apiVersion: 1
datasources:
- name: MongoDB
type: grafana-mongodb-datasource
access: proxy
basicAuth: false
editable: true
enabled: true
jsonData:
connection: Connection string
user: user name
secureJsonData:
password: password