Apache CouchDB

Apache CouchDB 集成会收集与流量相关的指标,例如对节点发出的请求数以及来自节点的响应数。它还会收集数据库指标,例如操作数以及已打开的操作的数量。 该集成会收集常规 CouchDB 日志以及访问日志,并将其解析为 JSON 载荷。结果将包含用户、主机、级别和消息字段。

如需详细了解 Apache CouchDB,请参阅 couchdb.apache.org/

前提条件

如需收集和注入 CouchDB 日志和指标,您必须安装 Ops Agent 2.11.0 或更高版本。

此接收器支持 Apache CouchDB 2.3.x 和 3.1 及更高版本。

为 CouchDB 配置 Ops Agent

按照配置 Ops Agent 指南,添加从 CouchDB 实例收集日志和指标所需的元素并重启代理

配置示例

以下命令会创建配置文件,以收集和注入 CouchDB 的日志和指标,并在 Linux 上重启 Ops Agent。

sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
logging:
  receivers:
    couchdb:
      type: couchdb
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb
metrics:
  receivers:
    couchdb:
      type: couchdb
      username: usr
      password: pwd
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb
EOF
sudo service google-cloud-ops-agent restart

配置日志收集

如需从 CouchDB 注入日志,您必须为 CouchDB 生成的日志创建接收器,然后为新的接收器创建流水线。如需为 couchdb 日志配置接收器,请指定以下字段:

字段 默认 说明
type 该值必须为 couchdb
include_paths [/var/log/couchdb/couchdb.log] 要通过跟踪每个文件读取的文件系统路径列表。路径中可以使用通配符 (*);例如 /var/log/couchdb*/*.log
exclude_paths 要从 include_paths 匹配的集合中排除的文件系统路径模式列表。
wildcard_refresh_interval 60s include_paths 中通配符文件路径的刷新间隔。指定为时长,例如 30s2m。该属性在高日志记录吞吐量下可能很有用,因为日志文件的轮替速度快于默认时间间隔。 必须是 1 秒的倍数。

记录的内容

couchdb 日志的 logName 派生自配置中指定的接收器 ID。LogEntry 中的详细字段如下所示。

字段 类型 说明
httpRequest.serverIp 字符串 服务器 IP 地址。
httpRequest.remoteIp 字符串 客户端 IP 地址。
httpRequest.requestMethod 字符串 HTTP 方法。
httpRequest.responseSize 字符串 (int64) 响应大小
httpRequest.status 数字 HTTP 状态代码。
jsonPayload.remote_user 字符串 请求的经过身份验证的用户名。
jsonPayload.pid 数字 进程 ID。
jsonPayload.message 字符串 日志消息。
jsonPayload.status_message 字符串 状态代码消息。
jsonPayload.node 字符串 节点实例名称。
jsonPayload.host 字符串 主机实例名称。
jsonPayload.path 字符串 请求路径。
jsonPayload.remote_user 字符串 用户 ID(可选)。
severity 字符串 (LogSeverity) 日志条目级别(已转换)。
timestamp 字符串 (Timestamp) 记录条目的时间。

日志条目不包含任何空白字段或缺失字段。

配置指标收集

如需从 CouchDB 收集指标,您必须为 CouchDB 指标创建接收器,然后为新接收器创建流水线。如需为 CouchDB 指标配置接收器,请指定以下字段:

字段 默认 说明
type 该值必须为 couchdb
stub_status_url http://localhost:5984 CouchDB 公开的网址。
username 用于连接到服务器的用户名。
password 用于连接到服务器的密码。
collection_interval 60s time.Duration 值,例如 30s5m

监控的内容

下表提供了 Ops Agent 从 CouchDB 实例收集的指标列表。

指标类型
种类、类型
受监控的资源
标签
workload.googleapis.com/couchdb.average_request_time
GAUGEDOUBLE
gce_instance
 
workload.googleapis.com/couchdb.database.open
GAUGEINT64
gce_instance
 
workload.googleapis.com/couchdb.database.operations
CUMULATIVEINT64
gce_instance
operation
workload.googleapis.com/couchdb.file_descriptor.open
GAUGEINT64
gce_instance
 
workload.googleapis.com/couchdb.httpd.bulk_requests
CUMULATIVEINT64
gce_instance
 
workload.googleapis.com/couchdb.httpd.requests
CUMULATIVEINT64
gce_instance
http_method
workload.googleapis.com/couchdb.httpd.responses
CUMULATIVEINT64
gce_instance
http_status_code
workload.googleapis.com/couchdb.httpd.views
CUMULATIVEINT64
gce_instance
view

示例信息中心

您可以使用示例 Cloud Monitoring 信息中心查看集成中的指标。完成安装示例信息中心过程,从示例库中导入 CouchDB GCE 概览信息中心并查看显示 Apache CouchDB 指标的图表。

验证配置

您可以使用日志浏览器和 Metrics Explorer 来验证是否已正确配置 CouchDB 接收器。Ops Agent 可能需要一两分钟才会开始收集日志和指标。

如需验证是否已注入日志,请转到日志浏览器并运行以下查询来查看 CouchDB 日志:

resource.type="gce_instance"
logName=("projects/PROJECT_ID/logs/couchdb")


如需验证指标是否已注入,请转到 Metrics Explorer 并在 MQL 标签页中运行以下查询。

fetch gce_instance
| metric 'workload.googleapis.com/couchdb.database.operations'
| align rate(1m)
| every 1m

后续步骤

如需查看如何使用 Ansible 安装 Ops Agent、配置第三方应用和安装示例信息中心的演示,请参阅安装 Ops Agent 以排查第三方应用的问题视频。