Supported Versions |
---|
Enterprise version 4.5.0 or higher |
Couchbase Server is an open-source, distributed multi-model NoSQL document-oriented database software package optimized for interactive applications.
Prerequisites
- Install gateway version 5.0.0 or later.
- Database and port(8091) are reachable from the gateway.
- Map a suitable gateway management profile to a resource.
- Create credentials with type
Database
before assigning a template to a resource. The Port, Connection Time-out, and Is Secure values are not used to create credentials.
Discovery using the gateway
The administrator can deploy a gateway to support Couchbase agentless monitoring. The gateway establishes a connection to the database using the management profile, collects metrics from the templates, and starts monitoring.
To monitor Couchbase:
- Associate appropriate database credentials to the discovered database.
- Assign one or more database-specific global templates on the device.
Choose one of the following management mechanisms to discover Couchbase servers and add them to your inventory:
WMI
SSH
SNMP
(Optional) Manually add a database server to the infrastructure inventory:
- Select Infrastructure.
- Click the Settings icon.
- Select Resource > Add.
- In the Add Device window, enter the required Device Type and specify additional fields you want to include.
- Click Save.
View resource metrics
The gateway monitors the application using the assigned templates and displays the results in a graphical format. To view resource metrics, click the desired Database Resource Name > Resource Details > Metrics.
Troubleshooting
If the graphs are plotted incorrectly, verify that the resource is accessible and telnet connectivity:
ping <IPAddress>
telnet <IPAddress:Port>
Also, verify that you are using valid credentials for the resource.
Supported templates
- Couchbase - Bucket
- Couchbase - Cluster
- Couchbase - Node
- Couchbase - Query
After selecting the templates, you can:
- Assign Couchbase templates from Setup or at the device level.
- Customize default configuration parameter values while assigning the template.
Resource template configuration parameters
Configuration Parameter | Description |
---|---|
Connection Time-out | Maximum database connect time. The driver waits for the specified time before timing out due to connection failure. The default time is 15000 milliseconds(ms). |
Service Transport Type | The secure database end-point. The default type is In-secure. The connection is Secure when the data sent between the client and server is encrypted. |
Service Port | The port number where the database is running. The connection is made to the specified port if you specify the port and the database name. The default ports are8091 and 8093. |
Application Type | The application type value to identify the adapter. For example, COUCHBASE. Do not change the default application type value. |
Supported metrics
Metric | Metric Display Name | Unit | Description |
---|---|---|---|
couchbase.hdd.free | Couchbase Hdd Free | byte | Free hard disk space |
couchbase.hdd.used | Couchbase Hdd Used | byte | Used hard disk space |
couchbase.hdd.total | Couchbase Hdd Total | byte | Total hard disk space |
couchbase.hdd.quota_total | Couchbase Hdd Quota Total | byte | Hard disk quota |
couchbase.hdd.used_by_data | Couchbase Hdd Used By Data | byte | Hard disk used for data |
couchbase.ram.used | Couchbase Ram Used | byte | RAM in use |
couchbase.hdd.free | Couchbase Hdd Free | byte | Free hard disk space |
couchbase.ram.total | Couchbase Ram Total | byte | Total RAM |
couchbase.ram.quota_total | Couchbase Ram Quota Total | byte | RAM quota |
couchbase.ram.used_by_data | Couchbase Ram Used By Data | byte | RAM used for data |
couchbase.by_bucket.avg_bg_wait_time | Couchbase By Bucket Avg Bg Wait Time | seconds | Average background wait time |
couchbase.by_bucket.avg_disk_commit_time | Couchbase By Bucket Avg Disk Commit Time | seconds | Average disk commit time |
couchbase.by_bucket.avg_disk_update_time | Couchbase By Bucket Avg Disk Update Time | microsecond | Average disk update time |
couchbase.by_bucket.bg_wait_total | Couchbase By Bucket Bg Wait Total | byte | Background wait total |
couchbase.by_bucket.bytes_read | Couchbase By Bucket .bytes_read | byte | Bytes read |
couchbase.by_bucket.bytes_written | Couchbase By Bucket .bytes_written | byte | Bytes written |
couchbase.by_bucket.cas_badval | Couchbase By Bucket Cas Badval | count | Compare and Swap bad values |
couchbase.by_bucket.cas_hits | Couchbase By Bucket Cas Hits | hit | Compare and Swap hits |
couchbase.by_bucket.cas_misses | Couchbase By Bucket Cas Misses | miss | Compare and Swap misses |
couchbase.by_bucket.cmd_get | Couchbase By Bucket Cmd Get | get | Compare and Swap gets |
couchbase.by_bucket.cmd_set | Couchbase By Bucket Cmd Set | set | Compare and swap sets |
couchbase.by_bucket.couch_docs_actual_disk_size | Couchbase By Bucket Couch Docs Actual Disk Size | byte | Couch docs total size on disk in bytes |