diff options
Diffstat (limited to '')
| -rw-r--r-- | src/go/collectors/go.d.plugin/modules/pika/integrations/pika.md | 221 |
1 files changed, 221 insertions, 0 deletions
diff --git a/src/go/collectors/go.d.plugin/modules/pika/integrations/pika.md b/src/go/collectors/go.d.plugin/modules/pika/integrations/pika.md new file mode 100644 index 000000000..15897eb0a --- /dev/null +++ b/src/go/collectors/go.d.plugin/modules/pika/integrations/pika.md @@ -0,0 +1,221 @@ +<!--startmeta +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/pika/README.md" +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/pika/metadata.yaml" +sidebar_label: "Pika" +learn_status: "Published" +learn_rel_path: "Collecting Metrics/Databases" +most_popular: False +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" +endmeta--> + +# Pika + + +<img src="https://netdata.cloud/img/pika.svg" width="150"/> + + +Plugin: go.d.plugin +Module: pika + +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> + +## Overview + +This collector monitors Pika servers. + +It collects information and statistics about the server executing the following commands: + +- [`INFO ALL`](https://github.com/OpenAtomFoundation/pika/wiki/pika-info%E4%BF%A1%E6%81%AF%E8%AF%B4%E6%98%8E) + + + + +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 + +### 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](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration.md#the-netdata-config-directory). + +```bash +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. + + +<details><summary>Config options</summary> + +| Name | Description | Default | Required | +|:----|:-----------|:-------|:--------:| +| update_every | Data collection frequency. | 5 | no | +| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | +| address | Pika server address. | redis://@localhost:9221 | yes | +| timeout | Dial (establishing new connections), read (socket reads) and write (socket writes) timeout in seconds. | 1 | no | +| username | Username used for authentication. | | no | +| password | Password used for authentication. | | no | +| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no | +| tls_ca | Certificate authority that client use when verifying server certificates. | | no | +| tls_cert | Client tls certificate. | | no | +| tls_key | Client tls key. | | no | + +</details> + +#### Examples + +##### TCP socket + +An example configuration. + +<details><summary>Config</summary> + +```yaml +jobs: + - name: local + address: 'redis://@localhost:9221' + +``` +</details> + +##### TCP socket with password + +An example configuration. + +<details><summary>Config</summary> + +```yaml +jobs: + - name: local + address: 'redis://:password@127.0.0.1:9221' + +``` +</details> + +##### Multi-instance + +> **Note**: When you define multiple jobs, their names must be unique. + +Local and remote instances. + + +<details><summary>Config</summary> + +```yaml +jobs: + - name: local + address: 'redis://:password@127.0.0.1:9221' + + - name: remote + address: 'redis://user:password@203.0.113.0:9221' + +``` +</details> + + + +## Troubleshooting + +### Debug Mode + +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]`. + + ```bash + cd /usr/libexec/netdata/plugins.d/ + ``` + +- Switch to the `netdata` user. + + ```bash + sudo -u netdata -s + ``` + +- Run the `go.d.plugin` to debug the collector: + + ```bash + ./go.d.plugin -d -m pika + ``` + + |