The Couchbase integration collects bucket metrics such as operations, memory usage, and ejections. The integration collects metrics from the Prometheus server exposed on a node. The integration also collects Couchbase general, HTTP access,
and cross-datacenter ("goxdcr") logs.
For more information about couchbase, see the
Couchbase documentation
.
Prerequisites
To collect couchbase telemetry, you must
install the Ops Agent
version 2.18.2 or
higher.
This integration supports couchbase versions 6.5, 6.6, and 7.0.
Following the guide for
Configuring the Ops
Agent
, add the required elements
to collect telemetry from couchbase instances, and
restart the agent
.
Example configuration
The following command creates the configuration to collect and ingest telemetry
for couchbase and restarts the Ops Agent.
What is logged
The
logName
is derived from
the receiver IDs specified in the configuration. Detailed fields inside the
LogEntry
are as follows.
The
couchbase_general
logs contain the following fields in the
LogEntry
:
Field
|
Type
|
Description
|
jsonPayload.level
|
string
|
Log entry severity for the couchbase log
|
jsonPayload.message
|
string
|
Log message
|
jsonPayload.module_name
|
string
|
The name of the module issuing the entry
|
jsonPayload.node_name
|
string
|
The name of the node issuing the log message
|
jsonPayload.source
|
string
|
Source where the log originated
|
jsonPayload.type
|
string
|
The type of log
|
severity
|
string (
LogSeverity
)
|
Log entry level (translated).
|
The
couchbase_http_access
logs contain the following fields in the
LogEntry
:
Field
|
Type
|
Description
|
httpRequest
|
object
|
See
HttpRequest
|
jsonPayload.host
|
string
|
The IP address of the client invoking the HTTP request
|
jsonPayload.level
|
string
|
Log entry severity for the couchbase log
|
jsonPayload.message
|
string
|
Log message
|
jsonPayload.user
|
string
|
The name of the user making the HTTP request if basic auth is used.
|
severity
|
string (
LogSeverity
)
|
Log entry level (translated).
|
The
couchbase_goxdcr
logs contain the following fields in the
LogEntry
:
Field
|
Type
|
Description
|
jsonPayload.level
|
string
|
Log entry severity for the couchbase log
|
jsonPayload.log_type
|
string
|
The name of the component that is issuing the cross-datacenter log
|
jsonPayload.message
|
string
|
Log message
|
severity
|
string (
LogSeverity
)
|
Log entry level (translated).
|
Configure metrics collection
To ingest metrics from couchbase, you must create a receiver for the metrics
that couchbase produces and then create a pipeline for the new receiver.
This receiver does not
support the use of multiple instances in the configuration, for example, to
monitor multiple endpoints. All such instances write to the same time series,
and Cloud Monitoring has no way to distinguish among them.
To configure a receiver for your
couchbase
metrics, specify the following
fields:
Field
|
Default
|
Description
|
collection_interval
|
60s
|
A
time.Duration
value, such as
30s
or
5m
.
|
endpoint
|
localhost:8091
|
The URL of the node to monitor.
|
password
|
|
The password used to connect to the couchbase server.
|
type
|
|
This value must be
couchbase
.
|
username
|
|
The username used to connect to the couchbase server.
|
What is monitored
The following table provides the list of metrics that the Ops Agent collects
from the couchbase instance.
Metric type
|
Kind, Type
Monitored resources
|
Labels
|
workload.googleapis.com/couchbase.bucket.error.oom.count
|
CUMULATIVE
,
INT64
gce_instance
|
bucket_name
error_type
|
workload.googleapis.com/couchbase.bucket.item.count
|
GAUGE
,
DOUBLE
gce_instance
|
bucket_name
state
|
workload.googleapis.com/couchbase.bucket.item.ejection.count
|
CUMULATIVE
,
INT64
gce_instance
|
bucket_name
|
workload.googleapis.com/couchbase.bucket.memory.high_water_mark.limit
|
GAUGE
,
DOUBLE
gce_instance
|
bucket_name
|
workload.googleapis.com/couchbase.bucket.memory.low_water_mark.limit
|
GAUGE
,
DOUBLE
gce_instance
|
bucket_name
|
workload.googleapis.com/couchbase.bucket.memory.usage
|
GAUGE
,
DOUBLE
gce_instance
|
bucket_name
|
workload.googleapis.com/couchbase.bucket.operation.count
|
CUMULATIVE
,
INT64
gce_instance
|
bucket_name
op
|
workload.googleapis.com/couchbase.bucket.vbucket.count
|
GAUGE
,
DOUBLE
gce_instance
|
bucket_name
state
|
Verify the configuration
This section describes how to verify that you correctly configured the
Couchbase receiver. It might take one or two
minutes for the Ops Agent to begin collecting telemetry.
To verify that Couchbase logs are being sent to
Cloud Logging, do the following:
-
In the Google Cloud console, go to the
Logs Explorer
page:
Go to
Logs Explorer
If you use the search bar to find this page, then select the result whose subheading is
Logging
.
- Enter the following query in the editor, and then click
Run query
:
resource.type="gce_instance"
(log_id("couchbase_general") OR log_id("couchbase_http_access") OR log_id("couchbase_goxdcr"))
To verify that Couchbase metrics are being sent to
Cloud Monitoring, do the following:
-
In the Google Cloud console, go to the
leaderboard
Metrics explorer
page:
Go to
Metrics explorer
If you use the search bar to find this page, then select the result whose subheading is
Monitoring
.
- In the toolbar of the
query-builder pane, select the button whose name is either
code
MQL
or
code
PromQL
.
- Verify that
MQL
is selected
in the
Language
toggle. The language toggle is in the same toolbar that
lets you format your query.
- Enter the following query in the editor, and then click
Run query
:
fetch gce_instance
| metric 'workload.googleapis.com/couchbase.bucket.memory.usage'
| every 1m
View dashboard
To view your Couchbase metrics, you must have a chart or dashboard
configured.
The Couchbase integration includes one or more dashboards for you.
Any dashboards are automatically installed after you configure the
integration and the Ops Agent has begun collecting metric data.
You can also view static previews of dashboards without
installing the integration.
To view an installed dashboard, do the following:
-
In the Google Cloud console, go to the
Dashboards
page:
Go to
Dashboards
If you use the search bar to find this page, then select the result whose subheading is
Monitoring
.
- Select the
Dashboard List
tab, and then choose the
Integrations
category.
- Click the name of the dashboard you want to view.
If you have configured an integration but the dashboard has not been
installed, then check that the Ops Agent is running. When there is no
metric data for a chart in the dashboard, installation of the dashboard fails.
After the Ops Agent begins collecting metrics, the dashboard is installed
for you.
To view a static preview of the dashboard, do the following:
-
In the Google Cloud console, go to the
Integrations
page:
Go to
Integrations
If you use the search bar to find this page, then select the result whose subheading is
Monitoring
.
- Click the
Compute Engine
deployment-platform filter.
- Locate the entry for
Couchbase
and click
View Details
.
- Select the
Dashboards
tab to see a static preview. If the
dashboard is installed, then you can navigate to it by clicking
View dashboard
.
For more information about dashboards in Cloud Monitoring, see
Dashboards and charts
.
For more information about using the
Integrations
page, see
Manage integrations
.
Install alerting policies
Alerting policies instruct Cloud Monitoring to notify you when
specified conditions occur.
The Couchbase integration includes one or more alerting policies for
you to use.
You can view and install
these alerting policies from the
Integrations
page in
Monitoring.
To view the descriptions of available alerting policies and
install them, do the following:
-
In the Google Cloud console, go to the
Integrations
page:
Go to
Integrations
If you use the search bar to find this page, then select the result whose subheading is
Monitoring
.
- Locate the entry for
Couchbase
and click
View Details
.
- Select the
Alerts
tab. This tab provides descriptions of
available alerting policies and provides an interface for installing
them.
- Install alerting policies. Alerting policies need
to know where to send notifications that the alert has been
triggered, so they require information from you for installation.
To install alerting policies, do the following:
- From the list of available alerting policies,
select those that you want to install.
In the
Configure notifications
section, select one or
more notification channels. You have the option to disable the
use of notification channels, but if you do, then your alerting
policies fire silently. You can check their status in
Monitoring, but you receive no notifications.
For more information about notification channels,
see
Manage
notification channels
.
- Click
Create Policies
.
For more information about alerting policies in Cloud Monitoring, see
Introduction to alerting
.
For more information about using the
Integrations
page, see
Manage integrations
.
What's next
For a walkthrough on how to use Ansible to install the Ops Agent, configure a
third-party application, and install a sample dashboard, see the
Install the Ops Agent to troubleshoot third-party applications
video.