- Elastic integrations
- Integrations quick reference
- 1Password
- Abnormal Security
- ActiveMQ
- Active Directory Entity Analytics
- Airflow
- Akamai
- Apache
- API (custom)
- Arbor Peakflow SP Logs
- Arista NG Firewall
- Atlassian
- Auditd
- Auth0
- authentik
- AWS
- Amazon CloudFront
- Amazon DynamoDB
- Amazon EBS
- Amazon EC2
- Amazon ECS
- Amazon EMR
- AWS API Gateway
- Amazon GuardDuty
- AWS Health
- Amazon Kinesis Data Firehose
- Amazon Kinesis Data Stream
- Amazon Managed Streaming for Apache Kafka (MSK)
- Amazon NAT Gateway
- Amazon RDS
- Amazon Redshift
- Amazon S3
- Amazon S3 Storage Lens
- Amazon Security Lake
- Amazon SNS
- Amazon SQS
- Amazon VPC
- Amazon VPN
- AWS Bedrock
- AWS Billing
- AWS CloudTrail
- AWS CloudWatch
- AWS ELB
- AWS Fargate
- AWS Inspector
- AWS Lambda
- AWS Logs (custom)
- AWS Network Firewall
- AWS Route 53
- AWS Security Hub
- AWS Transit Gateway
- AWS Usage
- AWS WAF
- Azure
- Activity logs
- App Service
- Application Gateway
- Application Insights metrics
- Application Insights metrics overview
- Application State Insights metrics
- Azure logs (v2 preview)
- Azure OpenAI
- Billing metrics
- Container instance metrics
- Container registry metrics
- Container service metrics
- Custom Azure Logs
- Custom Blob Storage Input
- Database Account metrics
- Event Hub input
- Firewall logs
- Frontdoor
- Functions
- Microsoft Entra ID
- Monitor metrics
- Network Watcher VNet
- Network Watcher NSG
- Platform logs
- Resource metrics
- Spring Cloud logs
- Storage Account metrics
- Virtual machines metrics
- Virtual machines scaleset metrics
- Barracuda
- BeyondInsight and Password Safe Integration
- BitDefender
- Bitwarden
- blacklens.io
- Blue Coat Director Logs
- BBOT (Bighuge BLS OSINT Tool)
- Box Events
- Bravura Monitor
- Broadcom ProxySG
- Canva
- Cassandra
- CEL Custom API
- Ceph
- Check Point
- Cilium Tetragon
- CISA Known Exploited Vulnerabilities
- Cisco
- Cisco Meraki Metrics
- Citrix
- Claroty CTD
- Cloudflare
- Cloud Asset Inventory
- CockroachDB Metrics
- Common Event Format (CEF)
- Containerd
- CoreDNS
- Corelight
- Couchbase
- CouchDB
- Cribl
- CrowdStrike
- Cyberark
- Cybereason
- CylanceProtect Logs
- Custom Websocket logs
- Darktrace
- Data Exfiltration Detection
- DGA
- Digital Guardian
- Docker
- DomainTools Real Time Unified Feeds
- Elastic APM
- Elastic Fleet Server
- Elastic Security
- Elastic Stack monitoring
- Elasticsearch Service Billing
- Envoy Proxy
- ESET PROTECT
- ESET Threat Intelligence
- etcd
- Falco
- F5
- File Integrity Monitoring
- FireEye Network Security
- First EPSS
- Forcepoint Web Security
- ForgeRock
- Fortinet
- Gigamon
- GitHub
- GitLab
- Golang
- Google Cloud
- Custom GCS Input
- GCP
- GCP Audit logs
- GCP Billing metrics
- GCP Cloud Run metrics
- GCP CloudSQL metrics
- GCP Compute metrics
- GCP Dataproc metrics
- GCP DNS logs
- GCP Firestore metrics
- GCP Firewall logs
- GCP GKE metrics
- GCP Load Balancing metrics
- GCP Metrics Input
- GCP PubSub logs (custom)
- GCP PubSub metrics
- GCP Redis metrics
- GCP Security Command Center
- GCP Storage metrics
- GCP VPC Flow logs
- GCP Vertex AI
- GoFlow2 logs
- Hadoop
- HAProxy
- Hashicorp Vault
- HTTP Endpoint logs (custom)
- IBM MQ
- IIS
- Imperva
- InfluxDb
- Infoblox
- Iptables
- Istio
- Jamf Compliance Reporter
- Jamf Pro
- Jamf Protect
- Jolokia Input
- Journald logs (custom)
- JumpCloud
- Kafka
- Keycloak
- Kubernetes
- LastPass
- Lateral Movement Detection
- Linux Metrics
- Living off the Land Attack Detection
- Logs (custom)
- Lumos
- Lyve Cloud
- Mattermost
- Memcached
- Menlo Security
- Microsoft
- Microsoft 365
- Microsoft Defender for Cloud
- Microsoft Defender for Endpoint
- Microsoft DHCP
- Microsoft DNS Server
- Microsoft Entra ID Entity Analytics
- Microsoft Exchange Online Message Trace
- Microsoft Exchange Server
- Microsoft Graph Activity Logs
- Microsoft M365 Defender
- Microsoft Office 365 Metrics Integration
- Microsoft Sentinel
- Microsoft SQL Server
- Mimecast
- ModSecurity Audit
- MongoDB
- MongoDB Atlas
- MySQL
- Nagios XI
- NATS
- NetFlow Records
- Netskope
- Network Beaconing Identification
- Network Packet Capture
- Nginx
- Okta
- Oracle
- OpenAI
- OpenCanary
- Osquery
- Palo Alto
- pfSense
- PHP-FPM
- PingOne
- PingFederate
- Pleasant Password Server
- PostgreSQL
- Prometheus
- Proofpoint TAP
- Proofpoint On Demand
- Pulse Connect Secure
- Qualys VMDR
- QNAP NAS
- RabbitMQ Logs
- Radware DefensePro Logs
- Rapid7
- Redis
- Rubrik RSC Metrics Integration
- Sailpoint Identity Security Cloud
- Salesforce
- SentinelOne
- ServiceNow
- Slack Logs
- Snort
- Snyk
- SonicWall Firewall
- Sophos
- Spring Boot
- SpyCloud Enterprise Protection
- SQL Input
- Squid Logs
- SRX
- STAN
- Statsd Input
- Sublime Security
- Suricata
- StormShield SNS
- Symantec
- Symantec Endpoint Security
- Sysmon for Linux
- Sysdig
- Syslog Router Integration
- System
- System Audit
- Tanium
- TCP Logs (custom)
- Teleport
- Tenable
- Threat intelligence
- ThreatConnect
- Threat Map
- Thycotic Secret Server
- Tines
- Traefik
- Trellix
- Trend Micro
- TYCHON Agentless
- UDP Logs (custom)
- Universal Profiling
- Vectra Detect
- VMware
- WatchGuard Firebox
- WebSphere Application Server
- Windows
- Wiz
- Zeek
- ZeroFox
- Zero Networks
- ZooKeeper Metrics
- Zoom
- Zscaler
CouchDB Integration
editCouchDB Integration
editVersion |
1.5.0 (View all) |
Compatible Kibana version(s) |
8.13.0 or higher |
Supported Serverless project types |
Security |
Subscription level |
Basic |
Level of support |
Elastic |
This Elastic integration collects and parses the Server metrics from CouchDB so that the user could monitor and troubleshoot the performance of the CouchDB instances.
This integration uses http
metricbeat module to collect above metrics.
Compatibility
editThis integration has been tested against CouchDB version 3.1
and CouchDB version 3.2.2
.
Requirements
editIn order to ingest data from CouchDB, you must know the host(s) and the administrator credentials for the CouchDB instance(s).
Host Configuration Format: http[s]://username:password@host:port
Example Host Configuration: http://admin:changeme@localhost:5984
To mask the password in the Hosts connection string, remove the username and password from the string. Then, set up the Hosts field with only the host address (localhost:5984
in the example) and any additional connection parameters. Finally, use the username
and password
fields under advanced options for configuration.
Metrics
editServer
editThis is the server
data stream.
Reference: https://docs.couchdb.org/en/stable/api/server/common.html#node-node-name-stats
Example
An example event for server
looks as following:
{ "@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 Field Reference
Please refer to the following document for detailed information on ECS fields.
Exported fields
Field | Description | Type | Unit | Metric Type |
---|---|---|---|---|
@timestamp |
Event timestamp. |
date |
||
agent.id |
Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id. |
keyword |
||
cloud.account.id |
The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. |
keyword |
||
cloud.availability_zone |
Availability zone in which this host, resource, or service is located. |
keyword |
||
cloud.instance.id |
Instance ID of the host machine. |
keyword |
||
cloud.provider |
Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. |
keyword |
||
cloud.region |
Region in which this host, resource, or service is located. |
keyword |
||
container.id |
Unique container id. |
keyword |
||
couchdb.server.auth_cache.hits |
Number of authentication cache hits. |
long |
counter |
|
couchdb.server.auth_cache.misses |
Number of authentication cache misses. |
long |
counter |
|
couchdb.server.database.open |
Number of open databases. |
long |
counter |
|
couchdb.server.database.reads |
Number of times a document was read from a database. |
long |
counter |
|
couchdb.server.database.writes |
Number of times a database was changed. |
long |
counter |
|
couchdb.server.httpd.clients_requesting_changes |
Number of clients for continuous changes. |
long |
counter |
|
couchdb.server.httpd.request_methods.copy |
Number of HTTP COPY requests. |
long |
counter |
|
couchdb.server.httpd.request_methods.delete |
Number of HTTP DELETE requests. |
long |
counter |
|
couchdb.server.httpd.request_methods.get |
Number of HTTP GET requests. |
long |
counter |
|
couchdb.server.httpd.request_methods.head |
Number of HTTP HEAD requests. |
long |
counter |
|
couchdb.server.httpd.request_methods.post |
Number of HTTP POST requests. |
long |
counter |
|
couchdb.server.httpd.request_methods.put |
Number of HTTP PUT requests. |
long |
counter |
|
couchdb.server.httpd.requests.bulk |
Number of bulk requests. |
long |
counter |
|
couchdb.server.httpd.requests.count |
Number of HTTP requests. |
long |
counter |
|
couchdb.server.httpd.status_codes.200 |
Number of HTTP 200 OK responses. |
long |
counter |
|
couchdb.server.httpd.status_codes.201 |
Number of HTTP 201 Created responses. |
long |
counter |
|
couchdb.server.httpd.status_codes.202 |
Number of HTTP 202 Accepted responses. |
long |
counter |
|
couchdb.server.httpd.status_codes.301 |
Number of HTTP 301 Moved Permanently responses. |
long |
counter |
|
couchdb.server.httpd.status_codes.304 |
Number of HTTP 304 Not Modified responses. |
long |
counter |
|
couchdb.server.httpd.status_codes.400 |
Number of HTTP 400 Bad Request responses. |
long |
counter |
|
couchdb.server.httpd.status_codes.401 |
Number of HTTP 401 Unauthorized responses. |
long |
counter |
|
couchdb.server.httpd.status_codes.403 |
Number of HTTP 403 Forbidden responses. |
long |
counter |
|
couchdb.server.httpd.status_codes.404 |
Number of HTTP 404 Not Found responses. |
long |
counter |
|
couchdb.server.httpd.status_codes.405 |
Number of HTTP 405 Method Not Allowed responses. |
long |
counter |
|
couchdb.server.httpd.status_codes.409 |
Number of HTTP 409 Conflict responses. |
long |
counter |
|
couchdb.server.httpd.status_codes.412 |
Number of HTTP 412 Precondition Failed responses. |
long |
counter |
|
couchdb.server.httpd.status_codes.500 |
Number of HTTP 500 Internal Server Error responses. |
long |
counter |
|
couchdb.server.httpd.view_reads.count |
Number of view reads. |
long |
counter |
|
couchdb.server.httpd.view_reads.temporary |
Number of temporary view reads. |
long |
counter |
|
couchdb.server.open_os_files |
Number of file descriptors CouchDB has open. |
long |
counter |
|
couchdb.server.request_time.avg |
Arithmetic mean of the request time inside CouchDB. |
float |
s |
|
data_stream.dataset |
Data stream dataset. |
constant_keyword |
||
data_stream.namespace |
Data stream namespace. |
constant_keyword |
||
data_stream.type |
Data stream type. |
constant_keyword |
||
host.name |
Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name (FQDN), or a name specified by the user. The recommended value is the lowercase FQDN of the host. |
keyword |
||
service.address |
Address where data about this service was collected from. This should be a URI, network address (ipv4:port or [ipv6]:port) or a resource path (sockets). |
keyword |
Changelog
editChangelog
Version | Details | Kibana version(s) |
---|---|---|
1.5.0 |
Enhancement (View pull request) |
8.13.0 or higher |
1.4.0 |
Enhancement (View pull request) |
8.13.0 or higher |
1.3.0 |
Enhancement (View pull request) |
8.13.0 or higher |
1.2.0 |
Enhancement (View pull request) |
8.8.0 or higher |
1.1.0 |
Enhancement (View pull request) |
8.8.0 or higher |
1.0.1 |
Bug fix (View pull request) |
8.8.0 or higher |
1.0.0 |
Enhancement (View pull request) |
8.8.0 or higher |
0.7.1 |
Bug fix (View pull request) |
— |
0.7.0 |
Enhancement (hhttps://github.com/elastic/integrations/pull/6166[View pull request]) |
— |
0.6.0 |
Enhancement (View pull request) |
— |
0.5.1 |
Bug fix (View pull request) |
— |
0.5.0 |
Enhancement (View pull request) |
— |
0.4.0 |
Enhancement (View pull request) |
— |
0.3.1 |
Enhancement (View pull request) |
— |
0.3.0 |
Enhancement (View pull request) |
— |
0.2.0 |
Enhancement (View pull request) |
— |
0.1.0 |
Enhancement (View pull request) |
— |
On this page