Skip to main content

Pika

Plugin: go.d.plugin Module: pika

Overview

This collector monitors Pika servers.

It collects information and statistics about the server executing the following commands:

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

This integration doesn't support auto-detection.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per Pika instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

MetricDimensionsUnit
pika.connectionsacceptedconnections
pika.clientsconnectedclients
pika.memoryusedbytes
pika.connected_replicasconnectedreplicas
pika.commandsprocessedcommands/s
pika.commands_callsa dimension per commandcalls/s
pika.database_strings_keysa dimension per databasekeys
pika.database_strings_expires_keysa dimension per databasekeys
pika.database_strings_invalid_keysa dimension per databasekeys
pika.database_hashes_keysa dimension per databasekeys
pika.database_hashes_expires_keysa dimension per databasekeys
pika.database_hashes_invalid_keysa dimension per databasekeys
pika.database_lists_keysa dimension per databasekeys
pika.database_lists_expires_keysa dimension per databasekeys
pika.database_lists_invalid_keysa dimension per databasekeys
pika.database_zsets_keysa dimension per databasekeys
pika.database_zsets_expires_keysa dimension per databasekeys
pika.database_zsets_invalid_keysa dimension per databasekeys
pika.database_sets_keysa dimension per databasekeys
pika.database_sets_expires_keysa dimension per databasekeys
pika.database_sets_invalid_keysa dimension per databasekeys
pika.uptimeuptimeseconds

Alerts

There are no alerts configured by default for this integration.

Setup

Prerequisites

No action required.

Configuration

File

The configuration file name for this integration is go.d/pika.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/pika.conf

Options

The following options can be defined globally: update_every, autodetection_retry.

Config options
NameDescriptionDefaultRequired
update_everyData collection frequency.5no
autodetection_retryRecheck interval in seconds. Zero means no recheck will be scheduled.0no
addressPika server address.redis://@localhost:9221yes
timeoutDial (establishing new connections), read (socket reads) and write (socket writes) timeout in seconds.1no
usernameUsername used for authentication.no
passwordPassword used for authentication.no
tls_skip_verifyServer certificate chain and hostname validation policy. Controls whether the client performs this check.nono
tls_caCertificate authority that client use when verifying server certificates.no
tls_certClient tls certificate.no
tls_keyClient tls key.no

Examples

TCP socket

An example configuration.

Config
jobs:
- name: local
address: 'redis://@localhost:9221'

TCP socket with password

An example configuration.

Config
jobs:
- name: local
address: 'redis://:[email protected]:9221'

Multi-instance

Note: When you define multiple jobs, their names must be unique.

Local and remote instances.

Config
jobs:
- name: local
address: 'redis://:[email protected]:9221'

- name: remote
address: 'redis://user:[email protected]:9221'

Troubleshooting

Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

To troubleshoot issues with the pika collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m pika

Getting Logs

If you're encountering problems with the pika collector, follow these steps to retrieve logs and identify potential issues:

  • Run the command specific to your system (systemd, non-systemd, or Docker container).
  • Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

Use the following command to view logs generated since the last Netdata service restart:

journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep pika

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:

grep pika /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

docker logs netdata 2>&1 | grep pika

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.