Apache CouchDB 集成会收集与流量相关的指标,例如对节点发出的请求数以及来自节点的响应数。它还会收集数据库指标,例如操作数以及已打开的操作的数量。 该集成会收集常规 CouchDB 日志以及访问日志,并将其解析为 JSON 载荷。结果将包含用户、主机、级别和消息字段。
如需详细了解 CouchDB,请参阅 Apache CouchDB 文档。
前提条件
如需收集 CouchDB 遥测数据,您必须安装 Ops Agent:
- 对于指标,请安装 2.10.0 版或更高版本。
- 对于日志,请安装 2.11.0 版或更高版本。
此集成支持 CouchDB 2.3.x 和 3.1 版及更高版本。
为 CouchDB 配置 Ops Agent
按照配置 Ops Agent 指南,添加从 CouchDB 实例收集遥测数据所需的元素并重启代理。
配置示例
以下命令会创建相关配置来收集和注入 CouchDB 的遥测数据,并重启 Ops Agent。
配置日志收集
如需从 CouchDB 注入日志,您必须为 CouchDB 生成的日志创建接收器,然后为新的接收器创建流水线。
如需为 couchdb
日志配置接收器,请指定以下字段:
字段 | 默认 | 说明 |
---|---|---|
exclude_paths |
要从 include_paths 匹配的集合中排除的文件系统路径模式列表。 |
|
include_paths |
[/var/log/couchdb/couchdb.log] |
要通过跟踪每个文件读取的文件系统路径列表。路径中可以使用通配符 (* );例如 /var/log/couchdb*/*.log 。 |
record_log_file_path |
false |
如果设置为 true ,则从中获取日志记录的特定文件的路径将作为 agent.googleapis.com/log_file_path 标签的值显示在输出日志条目中。使用通配符时,系统只会记录从中获取记录的文件的路径。 |
type |
该值必须为 couchdb 。 |
|
wildcard_refresh_interval |
60s |
include_paths 中通配符文件路径的刷新间隔。指定为时长,例如 30s 或 2m 。该属性在高日志记录吞吐量下可能很有用,因为日志文件的轮替速度快于默认时间间隔。 必须是 1 秒的倍数。 |
记录的内容
logName
派生自配置中指定的接收器 ID。LogEntry
中的详细字段如下所示。
couchdb
日志包含 LogEntry
中的以下字段:
字段 | 类型 | 说明 |
---|---|---|
httpRequest |
对象 | 参见HTTPRequest |
jsonPayload.host |
字符串 | 主机实例名称 |
jsonPayload.level |
字符串 | 日志条目级别 |
jsonPayload.message |
字符串 | 日志消息 |
jsonPayload.node |
字符串 | 节点实例名称 |
jsonPayload.path |
字符串 | 请求路径 |
jsonPayload.pid |
字符串 | 进程 ID |
jsonPayload.remote_user |
字符串 | 请求经过身份验证的用户名 |
jsonPayload.status_message |
字符串 | 状态代码消息 |
severity |
字符串 (LogSeverity ) |
日志条目级别(已转换)。 |
日志条目不包含任何空白字段或缺失字段。
配置指标收集
如需从 CouchDB 注入指标,您必须为 CouchDB 生成的指标创建接收器,然后为新的接收器创建流水线。
如需为 couchdb
指标配置接收器,请指定以下字段:
字段 | 默认 | 说明 |
---|---|---|
collection_interval |
60s |
time.Duration 值,例如 30s 或 5m 。 |
password |
用于连接到服务器的密码。 | |
server_status_url |
http://localhost:5984 |
CouchDB 公开的网址。 |
type |
该值必须为 couchdb 。 |
|
username |
用于连接到服务器的用户名。 |
监控的内容
下表提供了 Ops Agent 从 CouchDB 实例收集的指标列表。
指标类型 | |
---|---|
种类、类型 受监控的资源 |
标签 |
workload.googleapis.com/couchdb.average_request_time
|
|
GAUGE 、DOUBLE gce_instance |
|
workload.googleapis.com/couchdb.database.open
|
|
GAUGE 、INT64 gce_instance |
|
workload.googleapis.com/couchdb.database.operations
|
|
CUMULATIVE 、INT64 gce_instance |
operation
|
workload.googleapis.com/couchdb.file_descriptor.open
|
|
GAUGE 、INT64 gce_instance |
|
workload.googleapis.com/couchdb.httpd.bulk_requests
|
|
CUMULATIVE 、INT64 gce_instance |
|
workload.googleapis.com/couchdb.httpd.requests
|
|
CUMULATIVE 、INT64 gce_instance |
http_method
|
workload.googleapis.com/couchdb.httpd.responses
|
|
CUMULATIVE 、INT64 gce_instance |
http_status_code
|
workload.googleapis.com/couchdb.httpd.views
|
|
CUMULATIVE 、INT64 gce_instance |
view
|
示例信息中心
如需查看 CouchDB 指标,您必须配置一个图表或信息中心。Cloud Monitoring 提供了一个用于集成的示例信息中心库,其中包含一些预配置的图表。如需了解如何安装这些信息中心,请参阅安装示例信息中心。
验证配置
本部分介绍如何验证您是否正确配置了 CouchDB 接收器。Ops Agent 可能需要一两分钟才会开始收集遥测数据。
如需验证是否已注入日志,请转到日志浏览器并运行以下查询来查看 CouchDB 日志:
resource.type="gce_instance"
log_id("couchdb")
如需验证指标已注入,请前往 Metrics Explorer 并在 MQL 标签页中运行以下查询:
fetch gce_instance
| metric 'workload.googleapis.com/couchdb.database.open'
| every 1m
后续步骤
如需查看如何使用 Ansible 安装 Ops Agent、配置第三方应用和安装示例信息中心的演示,请参阅安装 Ops Agent 以排查第三方应用的问题视频。