pika

README

Pika monitoring with Netdata

Pika is a persistent huge storage service, compatible with the vast majority of redis interfaces (details), including string, hash, list, zset, set and management interfaces.

---

This module monitors one or more Pika instances, depending on your configuration.

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

• INFO ALL

Metrics

All metrics have "pika." prefix.

Metric	Scope	Dimensions	Units
connections	global	accepted	connections
clients	global	connected	clients
memory	global	used	bytes
connected_replicas	global	connected	replicas
commands	global	processed	commands/s
commands_calls	global	a dimension per command	calls/s
database_strings_keys	global	a dimension per database	keys
database_strings_expires_keys	global	a dimension per database	keys
database_strings_invalid_keys	global	a dimension per database	keys
database_hashes_keys	global	a dimension per database	keys
database_hashes_expires_keys	global	a dimension per database	keys
database_hashes_invalid_keys	global	a dimension per database	keys
database_lists_keys	global	a dimension per database	keys
database_lists_expires_keys	global	a dimension per database	keys
database_lists_invalid_keys	global	a dimension per database	keys
database_zsets_keys	global	a dimension per database	keys
database_zsets_expires_keys	global	a dimension per database	keys
database_zsets_invalid_keys	global	a dimension per database	keys
database_sets_keys	global	a dimension per database	keys
database_sets_expires_keys	global	a dimension per database	keys
database_sets_invalid_keys	global	a dimension per database	keys
uptime	global	uptime	seconds

Configuration

Edit the go.d/pika.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/pika.conf

There are two connection types: by tcp socket and by unix socket.

# by tcp socket
redis://<user>:<password>@<host>:<port>

# by unix socket
unix://<user>:<password>@</path/to/pika.sock

Needs only address, here is an example with two jobs:

jobs:
  - name: local
    address: 'redis://@127.0.0.1:6379'

  - name: remote
    address: 'redis://user:password@203.0.113.0:6379'

For all available options, see the pika collector's configuration file.

Troubleshooting

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. ' First, navigate to your plugins' directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the setting plugins directory. Once you're in the plugin's directory, switch to the netdata user.

cd /usr/libexec/netdata/plugins.d/
sudo -u netdata -s

You can now run the go.d.plugin to debug the collector:

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

Documentation

Index

• type Config
• type Pika
  • func New() *Pika
  • func (p *Pika) Charts() *module.Charts
  • func (p *Pika) Check() bool
  • func (p *Pika) Cleanup()
  • func (p *Pika) Collect() map[string]int64
  • func (p *Pika) Init() bool

Types

type Config

type Config struct {
	Address          string       `yaml:"address"`
	Timeout          web.Duration `yaml:"timeout"`
	tlscfg.TLSConfig `yaml:",inline"`
}

type Pika

type Pika struct {
	module.Base
	Config `yaml:",inline"`
	// contains filtered or unexported fields
}

func New

func New() *Pika

func (*Pika) Charts

func (p *Pika) Charts() *module.Charts

func (*Pika) Check

func (p *Pika) Check() bool

func (*Pika) Cleanup

func (p *Pika) Cleanup()

func (*Pika) Collect

func (p *Pika) Collect() map[string]int64

func (*Pika) Init

func (p *Pika) Init() bool