Docs » Integrations Guide » Integrations Reference » Couchbase

../../_images/integrations_couchbase.png Couchbase πŸ”—

DESCRIPTION πŸ”—

This integration primarily consists of the Smart Agent monitor collectd/couchbase. Below is an overview of that monitor.

Smart Agent Monitor πŸ”—

This is a Smart Agent monitor for Couchbase that uses the couchbase collectd Python plugin to collect metrics from Couchbase server instances.

For general reference on how to monitor Couchbase, see Couchbase Monitoring and Monitor using the REST API.

REQUIREMENTS AND DEPENDENCIES πŸ”—

Version information πŸ”—

Software Version
SignalFx Smart Agent 2.0+
couchbase 3.0 or later

INSTALLATION πŸ”—

This integration is part of the SignalFx Smart Agent as the collectd/couchbase monitor. You should first deploy the Smart Agent to the same host as the service you want to monitor, and then continue with the configuration instructions below.

CONFIGURATION πŸ”—

To activate this monitor in the Smart Agent, add the following to your agent config:

monitors:  # All monitor config goes under this key
 - type: collectd/couchbase
   ...  # Additional config

For a list of monitor options that are common to all monitors, see Common Configuration.

Config option Required Type Description
pythonBinary no string Path to a python binary that should be used to execute the Python code. If not set, a built-in runtime will be used. Can include arguments to the binary as well.
host yes string
port yes integer
collectTarget yes string Define what this Module block will monitor: "NODE", for a Couchbase node, or "BUCKET" for a Couchbase bucket.
collectBucket no string If CollectTarget is "BUCKET", CollectBucket specifies the name of the bucket that this will monitor.
clusterName no string Name of this Couchbase cluster. (default:"default")
collectMode no string Change to "detailed" to collect all available metrics from Couchbase stats API. Defaults to "default", collecting a curated set that works well with SignalFx.
username no string Username to authenticate with
password no string Password to authenticate with

USAGE πŸ”—

Below are screen captures of dashboards created for this plugin by SignalFx, illustrating the metrics emitted by this plugin.

For general reference on how to monitor Couchbase, see Couchbase Monitoring and Monitor using the REST API.

Note on bucket metrics

This plugin emits some metrics about the bucket’s performance across the cluster, and some metrics about the bucket’s performance per node.

Metrics beginning with gauge.bucket.basic.​* and gauge.bucket.quota.*​ are reported once per cluster. All other bucket metrics (gauge.bucket.*) are reported by every node that hosts that bucket. In order to analyze bucket performance for the entire bucket, apply functions like Sum or Mean to group node-level metrics together by bucket.

Monitoring a Couchbase cluster

On the Couchbase Nodes overview dashboard, you can see at a glance the status the nodes and buckets in a given cluster. Nodes in the cluster should be seeing balanced activity. Buckets in the cluster should each have adequate memory remaining.

../../_images/nodes_and_buckets_snapshot.pngCouchbase - Nodes and buckets in a cluster

This cluster’s three nodes have roughly the same number of gets per second, and its two buckets have plenty of headroom.

This dashboard also includes a percentile distribution of CPU utilization per node, allowing quick identification of unusually hot nodes. This chart shows minimum, 10th percentile, median (50th percentile), 90th percentile, and maximum CPU utilization for each node in the cluster.

../../_images/nodes_cpu.pngNodes CPU distribution

This cluster’s CPU utilization distribution shows only a small amount of variation in utilization, suggesting that each of the nodes is using about the same amount.

Monitoring a Couchbase node

Zooming in to an individual node shows that node’s activity, cache performance, and compute resource usage.

../../_images/node.pngNode overview

This node is lightly loaded. To compare its activity to other nodes in this cluster, we’d use the Couchbase Nodes dashboard above.

We can check the node’s cache performance using a graph that shows the number of gets per second in yellow, overlaid on the number of cache hits in blue. The ratio between gets and cache hits is computed as β€œhit ratio” and is shown as a dotted line. When every get request results in a cache hit, the graph is green and the dotted line remains high. When there are fewer cache hits than gets, the graph shows yellow areas and the dotted line drops.

../../_images/node_gets_and_hits.pngGets and hits

This lightly-loaded node has a 100% cache hit ratio: it can serve every get request that it receives from memory.

Monitoring Couchbase buckets

The Couchbase Buckets overview shows activity for all buckets being monitored.

../../_images/buckets_activity.pngBuckets overview

The buckets in this cluster happen to have about the same number of items and are serving about the same number of operations per second.

Monitoring a single Couchbase bucket

Selecting a particular bucket to show on the Couchbase Bucket dashboard lets us go deep on that bucket’s performance.

Resident items ratio and cache miss rate are inversely related: as the ratio of items in this bucket that are resident in memory drops, the number of get requests that require a fetch from disk will increase.

../../_images/bucket_cache_miss_rate.pngBucket cache performance

This bucket has a 100% resident items ratio: all of the items that it contains can be served from memory, instead of disk.

The performance of Couchbase buckets is bound by memory. When memory is exhausted, new items can be stored only by ejecting old items. An attempt to store a new item in a bucket with insufficient memory headroom produces an out-of-memory error: either a β€œtemp” error (an old item will be ejected, try again) or a β€œnon-temp” error (this item cannot be stored at all). Any out-of-memory error is cause for concern.

../../_images/bucket_memory.pngBucket memory usage

This bucket has available memory, and shows no out-of-memory errors.

Couchbase persists in-memory items to disk. This graph shows the number of items that have been added to the disk write queue in yellow, and the number of items that have been successfully written in blue. When Couchbase is able to keep up with disk writes, these metrics are equal and the graph is green. When the disk queue is filling faster than it can be drained, this graph shows yellow areas.

../../_images/bucket_write_queue.pngBucket write queue

This bucket is keeping up with disk writes: the number of items added to the queue is about equal to the number of items successfully written to disk.

METRICS πŸ”—

Metric Name Description Type
gauge.bucket.basic.dataUsed Size of user data within buckets of the specified state that are resident in RAM (%) gauge
gauge.bucket.basic.diskFetches Number of disk fetches gauge
gauge.bucket.basic.diskUsed Amount of disk used (bytes) gauge
gauge.bucket.basic.itemCount Number of items associated with the bucket gauge
gauge.bucket.basic.memUsed Amount of memory used by the bucket (bytes) gauge
gauge.bucket.basic.opsPerSec Number of operations per second gauge
gauge.bucket.basic.quotaPercentUsed Percentage of RAM used (for active objects) against the configure bucket size (%) gauge
gauge.bucket.op.cmd_get requested objects gauge
gauge.bucket.op.couch_docs_fragmentation Percent fragmentation of documents in this bucket gauge
gauge.bucket.op.couch_views_ops view operations per second gauge
gauge.bucket.op.curr_connections open connection per bucket gauge
gauge.bucket.op.curr_items total number of stored items per bucket gauge
gauge.bucket.op.disk_write_queue number of items waiting to be written to disk gauge
gauge.bucket.op.ep_bg_fetched number of items fetched from disk gauge
gauge.bucket.op.ep_cache_miss_rate ratio of requested objects found in cache vs retrieved from disk gauge
gauge.bucket.op.ep_diskqueue_drain items removed from disk queue gauge
gauge.bucket.op.ep_diskqueue_fill enqueued items on disk queue gauge
gauge.bucket.op.ep_mem_high_wat memory high water mark - point at which active objects begin to be ejected from bucket gauge
gauge.bucket.op.ep_mem_low_wat memory low water mark gauge
gauge.bucket.op.ep_num_value_ejects number of objects ejected out of the bucket gauge
gauge.bucket.op.ep_oom_errors request rejected - bucket is at quota, panic gauge
gauge.bucket.op.ep_queue_size number of items queued for storage gauge
gauge.bucket.op.ep_tmp_oom_errors request rejected - couchbase is making room by ejecting objects, try again later gauge
gauge.bucket.op.mem_used memory used gauge
gauge.bucket.op.ops total of gets, sets, increment and decrement gauge
gauge.bucket.op.vb_active_resident_items_ratio ratio of items kept in memory vs stored on disk gauge
gauge.bucket.quota.ram Amount of RAM used by the bucket (bytes) gauge
gauge.bucket.quota.rawRAM Amount of raw RAM used by the bucket (bytes) gauge
gauge.nodes.cmd_get Number of get commands gauge
gauge.nodes.couch_docs_actual_disk_size Amount of disk space used by Couch docs gauge
gauge.nodes.couch_docs_data_size Data size of couch documents associated with a node (bytes) gauge
gauge.nodes.couch_spatial_data_size Size of object data for spatial views (bytes) gauge
gauge.nodes.couch_spatial_disk_size Amount of disk space occupied by spatial views, in bytes gauge
gauge.nodes.couch_views_actual_disk_size Amount of disk space occupied by Couch views (bytes) gauge
gauge.nodes.couch_views_data_size Size of object data for Couch views (bytes) gauge
gauge.nodes.curr_items Number of current items gauge
gauge.nodes.curr_items_tot Total number of items associated with node gauge
gauge.nodes.ep_bg_fetched Number of disk fetches performed since server was started gauge
gauge.nodes.get_hits Number of get hits gauge
gauge.nodes.mcdMemoryAllocated Amount of memcached memory allocated (bytes) gauge
gauge.nodes.mcdMemoryReserved Amount of memcached memory reserved (bytes) gauge
gauge.nodes.mem_used Memory used by the node (bytes) gauge
gauge.nodes.memoryFree Amount of memory free for the node (bytes) gauge
gauge.nodes.memoryTotal Total memory available to the node (bytes) gauge
gauge.nodes.ops Number of operations performed on Couchbase gauge
gauge.nodes.system.cpu_utilization_rate The CPU utilization rate (%) gauge
gauge.nodes.system.mem_free Free memory available to the node (bytes) gauge
gauge.nodes.system.mem_total Total memory available to the node (bytes) gauge
gauge.nodes.system.swap_total Total swap size allocated (bytes) gauge
gauge.nodes.system.swap_used Amount of swap space used (bytes) gauge
gauge.nodes.vb_replica_curr_items Number of items/documents that are replicas gauge
gauge.storage.hdd.free Free harddrive space in the cluster (bytes) gauge
gauge.storage.hdd.quotaTotal Harddrive quota total for the cluster (bytes) gauge
gauge.storage.hdd.total Total harddrive space available to cluster (bytes) gauge
gauge.storage.hdd.used Harddrive space used by the cluster (bytes) gauge
gauge.storage.hdd.usedByData Harddrive use by the data in the cluster(bytes) gauge
gauge.storage.ram.quotaTotal Ram quota total for the cluster (bytes) gauge
gauge.storage.ram.quotaTotalPerNode Ram quota total per node (bytes) gauge
gauge.storage.ram.quotaUsed Ram quota used by the cluster (bytes) gauge
gauge.storage.ram.quotaUsedPerNode Ram quota used per node (bytes) gauge
gauge.storage.ram.total Total ram available to cluster (bytes) gauge
gauge.storage.ram.used Ram used by the cluster (bytes) gauge
gauge.storage.ram.usedByData Ram used by the data in the cluster (bytes) gauge

gauge.bucket.basic.dataUsed πŸ”—

gauge

Size of user data within buckets of the specified state that are resident in RAM (%)

gauge.bucket.basic.diskFetches πŸ”—

gauge

Number of disk fetches

gauge.bucket.basic.diskUsed πŸ”—

gauge

Amount of disk used (bytes)

gauge.bucket.basic.itemCount πŸ”—

gauge

Number of items associated with the bucket

gauge.bucket.basic.memUsed πŸ”—

gauge

Amount of memory used by the bucket (bytes)

gauge.bucket.basic.opsPerSec πŸ”—

gauge

Number of operations per second

gauge.bucket.basic.quotaPercentUsed πŸ”—

gauge

Percentage of RAM used (for active objects) against the configure bucket size (%)

gauge.bucket.op.cmd_get πŸ”—

gauge

requested objects

gauge.bucket.op.couch_docs_fragmentation πŸ”—

gauge

Percent fragmentation of documents in this bucket.

gauge.bucket.op.couch_views_ops πŸ”—

gauge

view operations per second

gauge.bucket.op.curr_connections πŸ”—

gauge

open connection per bucket

gauge.bucket.op.curr_items πŸ”—

gauge

total number of stored items per bucket

gauge.bucket.op.disk_write_queue πŸ”—

gauge

number of items waiting to be written to disk

gauge.bucket.op.ep_bg_fetched πŸ”—

gauge

number of items fetched from disk

gauge.bucket.op.ep_cache_miss_rate πŸ”—

gauge

ratio of requested objects found in cache vs retrieved from disk

gauge.bucket.op.ep_diskqueue_drain πŸ”—

gauge

items removed from disk queue

gauge.bucket.op.ep_diskqueue_fill πŸ”—

gauge

enqueued items on disk queue

gauge.bucket.op.ep_mem_high_wat πŸ”—

gauge

memory high water mark - point at which active objects begin to be ejected from bucket

gauge.bucket.op.ep_mem_low_wat πŸ”—

gauge

memory low water mark

gauge.bucket.op.ep_num_value_ejects πŸ”—

gauge

number of objects ejected out of the bucket

gauge.bucket.op.ep_oom_errors πŸ”—

gauge

request rejected - bucket is at quota, panic

gauge.bucket.op.ep_queue_size πŸ”—

gauge

number of items queued for storage

gauge.bucket.op.ep_tmp_oom_errors πŸ”—

gauge

request rejected - couchbase is making room by ejecting objects, try again later

gauge.bucket.op.mem_used πŸ”—

gauge

memory used

gauge.bucket.op.ops πŸ”—

gauge

total of gets, sets, increment and decrement

gauge.bucket.op.vb_active_resident_items_ratio πŸ”—

gauge

ratio of items kept in memory vs stored on disk

gauge.bucket.quota.ram πŸ”—

gauge

Amount of RAM used by the bucket (bytes).

gauge.bucket.quota.rawRAM πŸ”—

gauge

Amount of raw RAM used by the bucket (bytes).

gauge.nodes.cmd_get πŸ”—

gauge

Number of get commands

gauge.nodes.couch_docs_actual_disk_size πŸ”—

gauge

Amount of disk space used by Couch docs.(bytes)

gauge.nodes.couch_docs_data_size πŸ”—

gauge

Data size of couch documents associated with a node (bytes)

gauge.nodes.couch_spatial_data_size πŸ”—

gauge

Size of object data for spatial views (bytes)

gauge.nodes.couch_spatial_disk_size πŸ”—

gauge

Amount of disk space occupied by spatial views, in bytes.

gauge.nodes.couch_views_actual_disk_size πŸ”—

gauge

Amount of disk space occupied by Couch views (bytes).

gauge.nodes.couch_views_data_size πŸ”—

gauge

Size of object data for Couch views (bytes).

gauge.nodes.curr_items πŸ”—

gauge

Number of current items

gauge.nodes.curr_items_tot πŸ”—

gauge

Total number of items associated with node

gauge.nodes.ep_bg_fetched πŸ”—

gauge

Number of disk fetches performed since server was started

gauge.nodes.get_hits πŸ”—

gauge

Number of get hits

gauge.nodes.mcdMemoryAllocated πŸ”—

gauge

Amount of memcached memory allocated (bytes).

gauge.nodes.mcdMemoryReserved πŸ”—

gauge

Amount of memcached memory reserved (bytes).

gauge.nodes.mem_used πŸ”—

gauge

Memory used by the node (bytes)

gauge.nodes.memoryFree πŸ”—

gauge

Amount of memory free for the node (bytes).

gauge.nodes.memoryTotal πŸ”—

gauge

Total memory available to the node (bytes).

gauge.nodes.ops πŸ”—

gauge

Number of operations performed on Couchbase

gauge.nodes.system.cpu_utilization_rate πŸ”—

gauge

The CPU utilization rate (%)

gauge.nodes.system.mem_free πŸ”—

gauge

Free memory available to the node (bytes)

gauge.nodes.system.mem_total πŸ”—

gauge

Total memory available to the node (bytes)

gauge.nodes.system.swap_total πŸ”—

gauge

Total swap size allocated (bytes)

gauge.nodes.system.swap_used πŸ”—

gauge

Amount of swap space used (bytes)

gauge.nodes.vb_replica_curr_items πŸ”—

gauge

Number of items/documents that are replicas

gauge.storage.hdd.free πŸ”—

gauge

Free harddrive space in the cluster (bytes)

gauge.storage.hdd.quotaTotal πŸ”—

gauge

Harddrive quota total for the cluster (bytes)

gauge.storage.hdd.total πŸ”—

gauge

Total harddrive space available to cluster (bytes)

gauge.storage.hdd.used πŸ”—

gauge

Harddrive space used by the cluster (bytes)

gauge.storage.hdd.usedByData πŸ”—

gauge

Harddrive use by the data in the cluster(bytes)

gauge.storage.ram.quotaTotal πŸ”—

gauge

Ram quota total for the cluster (bytes)

gauge.storage.ram.quotaTotalPerNode πŸ”—

gauge

Ram quota total per node (bytes)

gauge.storage.ram.quotaUsed πŸ”—

gauge

Ram quota used by the cluster (bytes)

gauge.storage.ram.quotaUsedPerNode πŸ”—

gauge

Ram quota used per node (bytes)

gauge.storage.ram.total πŸ”—

gauge

Total ram available to cluster (bytes)

gauge.storage.ram.used πŸ”—

gauge

Ram used by the cluster (bytes)

gauge.storage.ram.usedByData πŸ”—

gauge

Ram used by the data in the cluster (bytes)

Metrics that are categorized as container/host (default) are in bold and italics in the list below.

These are the metrics available for this integration.

Group bucket πŸ”—

All of the following metrics are part of the bucket metric group. All of the non-default metrics below can be turned on by adding bucket to the monitor config option extraGroups:

  • gauge.bucket.basic.dataUsed (gauge)
    Size of user data within buckets of the specified state that are resident in RAM (%)
  • gauge.bucket.basic.diskFetches (gauge)
    Number of disk fetches
  • gauge.bucket.basic.diskUsed (gauge)
    Amount of disk used (bytes)
  • gauge.bucket.basic.itemCount (gauge)
    Number of items associated with the bucket
  • gauge.bucket.basic.memUsed (gauge)
    Amount of memory used by the bucket (bytes)
  • gauge.bucket.basic.opsPerSec (gauge)
    Number of operations per second
  • gauge.bucket.basic.quotaPercentUsed (gauge)
    Percentage of RAM used (for active objects) against the configure bucket size (%)
  • gauge.bucket.op.cmd_get (gauge)
    requested objects
  • gauge.bucket.op.couch_docs_fragmentation (gauge)
    Percent fragmentation of documents in this bucket.
  • gauge.bucket.op.couch_views_ops (gauge)
    view operations per second
  • gauge.bucket.op.curr_connections (gauge)
    open connection per bucket
  • gauge.bucket.op.curr_items (gauge)
    total number of stored items per bucket
  • gauge.bucket.op.disk_write_queue (gauge)
    number of items waiting to be written to disk
  • gauge.bucket.op.ep_bg_fetched (gauge)
    number of items fetched from disk
  • gauge.bucket.op.ep_cache_miss_rate (gauge)
    ratio of requested objects found in cache vs retrieved from disk
  • gauge.bucket.op.ep_diskqueue_drain (gauge)
    items removed from disk queue
  • gauge.bucket.op.ep_diskqueue_fill (gauge)
    enqueued items on disk queue
  • gauge.bucket.op.ep_mem_high_wat (gauge)
    memory high water mark - point at which active objects begin to be ejected from bucket
  • gauge.bucket.op.ep_mem_low_wat (gauge)
    memory low water mark
  • gauge.bucket.op.ep_num_value_ejects (gauge)
    number of objects ejected out of the bucket
  • gauge.bucket.op.ep_oom_errors (gauge)
    request rejected - bucket is at quota, panic
  • gauge.bucket.op.ep_queue_size (gauge)
    number of items queued for storage
  • gauge.bucket.op.ep_tmp_oom_errors (gauge)
    request rejected - couchbase is making room by ejecting objects, try again later
  • gauge.bucket.op.mem_used (gauge)
    memory used
  • gauge.bucket.op.ops (gauge)
    total of gets, sets, increment and decrement
  • gauge.bucket.op.vb_active_resident_items_ratio (gauge)
    ratio of items kept in memory vs stored on disk
  • gauge.bucket.quota.ram (gauge)
    Amount of RAM used by the bucket (bytes).
  • gauge.bucket.quota.rawRAM (gauge)
    Amount of raw RAM used by the bucket (bytes).

Group nodes πŸ”—

All of the following metrics are part of the nodes metric group. All of the non-default metrics below can be turned on by adding nodes to the monitor config option extraGroups:

  • gauge.nodes.cmd_get (gauge)
    Number of get commands
  • gauge.nodes.couch_docs_actual_disk_size (gauge)
    Amount of disk space used by Couch docs.(bytes)
  • gauge.nodes.couch_docs_data_size (gauge)
    Data size of couch documents associated with a node (bytes)
  • gauge.nodes.couch_spatial_data_size (gauge)
    Size of object data for spatial views (bytes)
  • gauge.nodes.couch_spatial_disk_size (gauge)
    Amount of disk space occupied by spatial views, in bytes.
  • gauge.nodes.couch_views_actual_disk_size (gauge)
    Amount of disk space occupied by Couch views (bytes).
  • gauge.nodes.couch_views_data_size (gauge)
    Size of object data for Couch views (bytes).
  • gauge.nodes.curr_items (gauge)
    Number of current items
  • gauge.nodes.curr_items_tot (gauge)
    Total number of items associated with node
  • gauge.nodes.ep_bg_fetched (gauge)
    Number of disk fetches performed since server was started
  • gauge.nodes.get_hits (gauge)
    Number of get hits
  • gauge.nodes.mcdMemoryAllocated (gauge)
    Amount of memcached memory allocated (bytes).
  • gauge.nodes.mcdMemoryReserved (gauge)
    Amount of memcached memory reserved (bytes).
  • gauge.nodes.mem_used (gauge)
    Memory used by the node (bytes)
  • gauge.nodes.memoryFree (gauge)
    Amount of memory free for the node (bytes).
  • gauge.nodes.memoryTotal (gauge)
    Total memory available to the node (bytes).
  • gauge.nodes.ops (gauge)
    Number of operations performed on Couchbase
  • gauge.nodes.system.cpu_utilization_rate (gauge)
    The CPU utilization rate (%)
  • gauge.nodes.system.mem_free (gauge)
    Free memory available to the node (bytes)
  • gauge.nodes.system.mem_total (gauge)
    Total memory available to the node (bytes)
  • gauge.nodes.system.swap_total (gauge)
    Total swap size allocated (bytes)
  • gauge.nodes.system.swap_used (gauge)
    Amount of swap space used (bytes)
  • gauge.nodes.vb_replica_curr_items (gauge)
    Number of items/documents that are replicas

Group storage πŸ”—

All of the following metrics are part of the storage metric group. All of the non-default metrics below can be turned on by adding storage to the monitor config option extraGroups:

  • gauge.storage.hdd.free (gauge)
    Free harddrive space in the cluster (bytes)
  • gauge.storage.hdd.quotaTotal (gauge)
    Harddrive quota total for the cluster (bytes)
  • gauge.storage.hdd.total (gauge)
    Total harddrive space available to cluster (bytes)
  • gauge.storage.hdd.used (gauge)
    Harddrive space used by the cluster (bytes)
  • gauge.storage.hdd.usedByData (gauge)
    Harddrive use by the data in the cluster(bytes)
  • gauge.storage.ram.quotaTotal (gauge)
    Ram quota total for the cluster (bytes)
  • gauge.storage.ram.quotaTotalPerNode (gauge)
    Ram quota total per node (bytes)
  • gauge.storage.ram.quotaUsed (gauge)
    Ram quota used by the cluster (bytes)
  • gauge.storage.ram.quotaUsedPerNode (gauge)
    Ram quota used per node (bytes)
  • gauge.storage.ram.total (gauge)
    Total ram available to cluster (bytes)
  • gauge.storage.ram.used (gauge)
    Ram used by the cluster (bytes)
  • gauge.storage.ram.usedByData (gauge)
    Ram used by the data in the cluster (bytes)

Non-default metrics (version 4.7.0+) πŸ”—

The following information applies to the agent version 4.7.0+ that has enableBuiltInFiltering: true set on the top level of the agent config.

To emit metrics that are not default, you can add those metrics in the generic monitor-level extraMetrics config option. Metrics that are derived from specific configuration options that do not appear in the above list of metrics do not need to be added to extraMetrics.

To see a list of metrics that will be emitted you can run agent-status monitors after configuring this monitor in a running agent instance.

Legacy non-default metrics (version < 4.7.0) πŸ”—

The following information only applies to agent version older than 4.7.0. If you have a newer agent and have set enableBuiltInFiltering: true at the top level of your agent config, see the section above. See upgrade instructions in Old-style whitelist filtering.

If you have a reference to the whitelist.json in your agent’s top-level metricsToExclude config option, and you want to emit metrics that are not in that whitelist, then you need to add an item to the top-level metricsToInclude config option to override that whitelist (see Inclusion filtering. Or you can just copy the whitelist.json, modify it, and reference that in metricsToExclude.