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:
Metric | Dimensions | Unit |
---|---|---|
pika.connections | accepted | connections |
pika.clients | connected | clients |
pika.memory | used | bytes |
pika.connected_replicas | connected | replicas |
pika.commands | processed | commands/s |
pika.commands_calls | a dimension per command | calls/s |
pika.database_strings_keys | a dimension per database | keys |
pika.database_strings_expires_keys | a dimension per database | keys |
pika.database_strings_invalid_keys | a dimension per database | keys |
pika.database_hashes_keys | a dimension per database | keys |
pika.database_hashes_expires_keys | a dimension per database | keys |
pika.database_hashes_invalid_keys | a dimension per database | keys |
pika.database_lists_keys | a dimension per database | keys |
pika.database_lists_expires_keys | a dimension per database | keys |
pika.database_lists_invalid_keys | a dimension per database | keys |
pika.database_zsets_keys | a dimension per database | keys |
pika.database_zsets_expires_keys | a dimension per database | keys |
pika.database_zsets_invalid_keys | a dimension per database | keys |
pika.database_sets_keys | a dimension per database | keys |
pika.database_sets_expires_keys | a dimension per database | keys |
pika.database_sets_invalid_keys | a dimension per database | keys |
pika.uptime | uptime | seconds |
Alerts
There are no alerts configured by default for this integration.
Setup
You can configure the pika collector in two ways:
Method | Best for | How to |
---|---|---|
UI | Fast setup without editing files | Go to Nodes → Configure this node → Collectors → Jobs, search for pika, then click + to add a job. |
File | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit go.d/pika.conf and add a job. |
UI configuration requires paid Netdata Cloud plan.
Prerequisites
No action required.
Configuration
Options
The following options can be defined globally: update_every, autodetection_retry.
Config options
Group | Option | Description | Default | Required |
---|---|---|---|---|
Collection | update_every | Data collection frequency (seconds). | 5 | no |
autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no | |
Target | address | Pika server address. | redis://@localhost:9221 | yes |
timeout | Dial (establishing new connections), read (socket reads), and write (socket writes) timeout (seconds). | 1 | no | |
Auth | username | Username for authentication. | no | |
password | Password for authentication. | no | ||
TLS | tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |
tls_ca | Certification authority that the client uses when verifying the server’s certificates. | no | ||
tls_cert | Client TLS certificate. | no | ||
tls_key | Client TLS key. | no | ||
Virtual Node | vnode | Associates this data collection job with a Virtual Node. | no |
via UI
Configure the pika collector from the Netdata web interface:
- Go to Nodes.
- Select the node where you want the pika data-collection job to run and click the ⚙ (Configure this node). That node will run the data collection.
- The Collectors → Jobs view opens by default.
- In the Search box, type pika (or scroll the list) to locate the pika collector.
- Click the + next to the pika collector to add a new job.
- Fill in the job fields, then click Test to verify the configuration and Submit to save.
- Test runs the job with the provided settings and shows whether data can be collected.
- If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
via File
The configuration file name for this integration is go.d/pika.conf
.
The file format is YAML. Generally, the structure is:
update_every: 1
autodetection_retry: 0
jobs:
- name: some_name1
- name: some_name2
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
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'