CouchDB 集成

编辑

版本

1.4.0 (查看所有)

兼容的 Kibana 版本

8.13.0 或更高版本

支持的无服务器项目类型
这是什么?

安全性
可观测性

订阅级别
这是什么?

基本

支持级别
这是什么?

Elastic

此 Elastic 集成从 CouchDB 收集并解析服务器指标,以便用户可以监视和排除 CouchDB 实例的性能问题。

此集成使用 http metricbeat 模块来收集上述指标。

兼容性

编辑

此集成已针对 CouchDB 3.1 版本CouchDB 3.2.2 版本 进行了测试。

要求

编辑

为了从 CouchDB 摄取数据,您必须知道 CouchDB 实例的主机和管理员凭据。

主机配置格式:http[s]://用户名:密码@主机:端口

主机配置示例:http://admin:changeme@localhost:5984

要屏蔽主机连接字符串中的密码,请从字符串中删除用户名和密码。然后,仅使用主机地址(示例中为 localhost:5984)和任何其他连接参数来设置主机字段。最后,在配置的高级选项下使用 usernamepassword 字段。

指标

编辑

服务器

编辑

这是 server 数据流。

参考:https://docs.couchdb.cn/en/stable/api/server/common.html#node-node-name-stats

示例

server 的示例事件如下所示

{
    "@timestamp": "2022-07-13T07:21:10.000Z",
    "agent": {
        "ephemeral_id": "389401b4-5960-4cd8-a207-033a7e3c5a54",
        "id": "1f5b14b7-019a-4625-85ab-1b51ea6c08e5",
        "name": "docker-fleet-agent",
        "type": "metricbeat",
        "version": "8.3.2"
    },
    "couchdb": {
        "server": {
            "auth_cache": {
                "hits": 0,
                "misses": 0
            },
            "database": {
                "open": 0,
                "reads": 0,
                "writes": 0
            },
            "httpd": {
                "clients_requesting_changes": 0,
                "request_methods": {
                    "copy": 0,
                    "delete": 0,
                    "get": 1,
                    "head": 0,
                    "post": 0,
                    "put": 0
                },
                "requests": {
                    "bulk": 0,
                    "count": 1
                },
                "status_codes": {
                    "200": 1,
                    "201": 0,
                    "202": 0,
                    "301": 0,
                    "304": 0,
                    "400": 0,
                    "401": 0,
                    "403": 0,
                    "404": 0,
                    "405": 0,
                    "409": 0,
                    "412": 0,
                    "500": 0
                },
                "view_reads": {
                    "count": 0,
                    "temporary": 0
                }
            },
            "open_os_files": 0,
            "request_time": {
                "avg": 0
            }
        }
    },
    "data_stream": {
        "dataset": "couchdb.server",
        "namespace": "ep",
        "type": "metrics"
    },
    "ecs": {
        "version": "8.11.0"
    },
    "elastic_agent": {
        "id": "1f5b14b7-019a-4625-85ab-1b51ea6c08e5",
        "snapshot": false,
        "version": "8.3.2"
    },
    "event": {
        "agent_id_status": "verified",
        "category": [
            "database"
        ],
        "dataset": "couchdb.server",
        "duration": 6178377,
        "ingested": "2022-07-13T07:21:14Z",
        "kind": "metric",
        "module": "couchdb",
        "type": [
            "info"
        ]
    },
    "host": {
        "architecture": "x86_64",
        "containerized": true,
        "hostname": "docker-fleet-agent",
        "ip": [
            "172.18.0.7"
        ],
        "mac": [
            "02-42-AC-1F-00-07"
        ],
        "name": "docker-fleet-agent",
        "os": {
            "codename": "focal",
            "family": "debian",
            "kernel": "3.10.0-1160.66.1.el7.x86_64",
            "name": "Ubuntu",
            "platform": "ubuntu",
            "type": "linux",
            "version": "20.04.4 LTS (Focal Fossa)"
        }
    },
    "metricset": {
        "name": "json",
        "period": 10000
    },
    "service": {
        "address": "http://elastic-package-service_couchdb_1:5984/_node/_local/_stats",
        "type": "http"
    },
    "tags": [
        "couchdb-server"
    ]
}

ECS 字段参考

有关 ECS 字段的详细信息,请参阅以下文档

导出的字段
字段 描述 类型 单位 指标类型

@timestamp

事件时间戳。

日期

agent.id

此代理的唯一标识符(如果存在)。示例:对于 Beats,这将是 beat.id。

关键词

cloud.account.id

云帐户或组织 ID,用于标识多租户环境中的不同实体。示例:AWS 帐户 ID、Google Cloud ORG ID 或其他唯一标识符。

关键词

cloud.availability_zone

此主机、资源或服务所在的可用区。

关键词

cloud.instance.id

主机实例 ID。

关键词

cloud.provider

云提供商的名称。示例值为 aws、azure、gcp 或 digitalocean。

关键词

cloud.region

此主机、资源或服务所在的区域。

关键词

container.id

唯一的容器 ID。

关键词

couchdb.server.auth_cache.hits

身份验证缓存命中数。

长整型

计数器

couchdb.server.auth_cache.misses

身份验证缓存未命中数。

长整型

计数器

couchdb.server.database.open

打开的数据库数量。

长整型

计数器

couchdb.server.database.reads

从数据库读取文档的次数。

长整型

计数器

couchdb.server.database.writes

数据库更改的次数。

长整型

计数器

couchdb.server.httpd.clients_requesting_changes

持续更改的客户端数量。

长整型

计数器

couchdb.server.httpd.request_methods.copy

HTTP COPY 请求的数量。

长整型

计数器

couchdb.server.httpd.request_methods.delete

HTTP DELETE 请求的数量。

长整型

计数器

couchdb.server.httpd.request_methods.get

HTTP GET 请求的数量。

长整型

计数器

couchdb.server.httpd.request_methods.head

HTTP HEAD 请求的数量。

长整型

计数器

couchdb.server.httpd.request_methods.post

HTTP POST 请求的数量。

长整型

计数器

couchdb.server.httpd.request_methods.put

HTTP PUT 请求的数量。

长整型

计数器

couchdb.server.httpd.requests.bulk

批量请求的数量。

长整型

计数器

couchdb.server.httpd.requests.count

HTTP 请求的数量。

长整型

计数器

couchdb.server.httpd.status_codes.200

HTTP 200 OK 响应的数量。

长整型

计数器

couchdb.server.httpd.status_codes.201

HTTP 201 Created 响应的数量。

长整型

计数器

couchdb.server.httpd.status_codes.202

HTTP 202 Accepted 响应的数量。

长整型

计数器

couchdb.server.httpd.status_codes.301

HTTP 301 Moved Permanently 响应的数量。

长整型

计数器

couchdb.server.httpd.status_codes.304

HTTP 304 Not Modified 响应的数量。

长整型

计数器

couchdb.server.httpd.status_codes.400

HTTP 400 Bad Request 响应的数量。

长整型

计数器

couchdb.server.httpd.status_codes.401

HTTP 401 Unauthorized 响应的数量。

长整型

计数器

couchdb.server.httpd.status_codes.403

HTTP 403 Forbidden 响应的数量。

长整型

计数器

couchdb.server.httpd.status_codes.404

HTTP 404 Not Found 响应的数量。

长整型

计数器

couchdb.server.httpd.status_codes.405

HTTP 405 Method Not Allowed 响应的数量。

长整型

计数器

couchdb.server.httpd.status_codes.409

HTTP 409 Conflict 响应的数量。

长整型

计数器

couchdb.server.httpd.status_codes.412

HTTP 412 Precondition Failed 响应的数量。

长整型

计数器

couchdb.server.httpd.status_codes.500

HTTP 500 Internal Server Error 响应的数量。

长整型

计数器

couchdb.server.httpd.view_reads.count

视图读取的数量。

长整型

计数器

couchdb.server.httpd.view_reads.temporary

临时视图读取的数量。

长整型

计数器

couchdb.server.open_os_files

CouchDB 打开的文件描述符数量。

长整型

计数器

couchdb.server.request_time.avg

CouchDB 内部请求时间的算术平均值。

浮点型

data_stream.dataset

数据流数据集。

常量关键词

data_stream.namespace

数据流命名空间。

常量关键词

data_stream.type

数据流类型。

常量关键词

host.name

主机的名称。它可以包含 Unix 系统上主机名返回的内容、完全限定域名 (FQDN) 或用户指定的名称。建议的值是主机的小写 FQDN。

关键词

service.address

从中收集有关此服务的数据的地址。这应该是一个 URI、网络地址(ipv4:端口或 [ipv6]:端口)或资源路径(套接字)。

关键词

更新日志

编辑
更新日志
版本 详细信息 Kibana 版本

1.4.0

增强 (查看拉取请求)
添加单独的用户名和密码配置选项,并为密码字段启用密钥。

8.13.0 或更高版本

1.3.0

增强 (查看拉取请求)
ECS 版本更新至 8.11.0。将 kibana 约束更新为 ^8.13.0。修改了字段定义,以删除 ecs@mappings 组件模板中多余的 ECS 字段。

8.13.0 或更高版本

1.2.0

增强 (查看拉取请求)
在 data_stream.dataset 上添加全局过滤器以提高性能。

8.8.0 或更高版本

1.1.0

增强 (查看拉取请求)
将软件包 format_version 更新为 3.0.0。

8.8.0 或更高版本

1.0.1

Bug 修复 (查看拉取请求)
从指标数据流中删除转发的标签。

8.8.0 或更高版本

1.0.0

增强 (查看拉取请求)
使 CouchDB GA。

8.8.0 或更高版本

0.7.1

Bug 修复 (查看拉取请求)
解决 host.ip 字段中的冲突。

0.7.0

增强 (hhttps://github.com/elastic/integrations/pull/6166[查看拉取请求])
为指标数据集启用时间序列数据流。这大大减少了指标的存储,并有望逐步提高查询性能。有关更多详细信息,请参阅 https://elastic.ac.cn/guide/en/elasticsearch/reference/current/tsds.html

0.6.0

增强 (查看拉取请求)
将所有权从 obs-service-integrations 重命名为 obs-infraobs-integrations

0.5.1

Bug 修复 (查看拉取请求)
修改维度字段映射以支持公有云部署。

0.5.0

增强 (查看拉取请求)
将维度字段添加到服务器数据流以启用 TSDB。

0.4.0

增强 (查看拉取请求)
将可视化迁移到 lens。

0.3.1

增强 (查看拉取请求)
添加了类别和/或子类别。

0.3.0

增强 (查看拉取请求)
将 ECS 版本更新至 8.5.1

0.2.0

增强 (查看拉取请求)
添加了基础架构类别。

0.1.0

增强 (查看拉取请求)
带有“服务器”数据流的 CouchDB 集成包