Skip to content

Commit

Permalink
Merge pull request #4 from signalfx/docupdate
Browse files Browse the repository at this point in the history
refer users to the integrations documentation for the plugin
  • Loading branch information
charless-splunk authored Aug 23, 2017
2 parents d1ed874 + 9594804 commit 1e7f115
Show file tree
Hide file tree
Showing 7 changed files with 3 additions and 178 deletions.
143 changes: 3 additions & 140 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,149 +14,12 @@ You can capture any kind of Redis metrics like:
* Changes since last save
* Replication delay (per slave)

Install
-------
1. Place redis_info.py in /opt/collectd/lib/collectd/plugins/python (assuming you have collectd installed to /opt/collectd).
2. Configure the plugin (see below).
3. Restart collectd.

Configuration
-------------
Add the following to your collectd config **or** use the included redis.conf.

```
# Configure the redis_info-collectd-plugin
<LoadPlugin python>
Globals true
</LoadPlugin>
<Plugin python>
ModulePath "/opt/collectd/lib/collectd/plugins/python"
Import "redis_info"
<Module redis_info>
Host "localhost"
Port 6379
# Un-comment to use AUTH
#Auth "1234"
Verbose false
#Instance "instance_1"
# Redis metrics to collect (prefix with Redis_)
Redis_db0_keys "gauge"
Redis_uptime_in_seconds "gauge"
Redis_uptime_in_days "gauge"
Redis_lru_clock "counter"
Redis_connected_clients "gauge"
Redis_connected_slaves "gauge"
Redis_blocked_clients "gauge"
Redis_evicted_keys "gauge"
Redis_used_memory "bytes"
Redis_used_memory_peak "bytes"
Redis_changes_since_last_save "gauge"
Redis_instantaneous_ops_per_sec "gauge"
Redis_rdb_bgsave_in_progress "gauge"
Redis_total_connections_received "counter"
Redis_total_commands_processed "counter"
Redis_keyspace_hits "derive"
Redis_keyspace_misses "derive"
#Redis_master_repl_offset "gauge"
#Redis_master_last_io_seconds_ago "gauge"
#Redis_slave_repl_offset "gauge"
</Module>
</Plugin>
```

### Multiple Redis instances

You can configure to monitor multiple redis instances by the same machine by repeating the <Module> section, such as:

```
<Plugin python>
ModulePath "/opt/collectd_plugins"
Import "redis_info"
<Module redis_info>
Host "127.0.0.1"
Port 9100
Verbose true
Instance "instance_9100"
Redis_uptime_in_seconds "gauge"
Redis_used_memory "bytes"
Redis_used_memory_peak "bytes"
</Module>
<Module redis_info>
Host "127.0.0.1"
Port 9101
Verbose true
Instance "instance_9101"
Redis_uptime_in_seconds "gauge"
Redis_used_memory "bytes"
Redis_used_memory_peak "bytes"
Redis_master_repl_offset "gauge"
</Module>
<Module redis_info>
Host "127.0.0.1"
Port 9102
Verbose true
Instance "instance_9102"
Redis_uptime_in_seconds "gauge"
Redis_used_memory "bytes"
Redis_used_memory_peak "bytes"
Redis_slave_repl_offset "gauge"
</Module>
</Plugin>
```

These 3 redis instances listen on different ports, they have different plugin_instance combined by Host and Port:

```
"plugin_instance" => "127.0.0.1:9100",
"plugin_instance" => "127.0.0.1:9101",
"plugin_instance" => "127.0.0.1:9102",
```

These values will be part of the metric name emitted by collectd, e.g. ```collectd.redis_info.127.0.0.1:9100.bytes.used_memory```

If you want to set a static value for the plugin instance, use the ```Instance``` configuration option:

```
...
<Module redis_info>
Host "127.0.0.1"
Port 9102
Instance "redis-prod"
</Module>
...
```
This will result in metric names like: ```collectd.redis_info.redis-prod.bytes.used_memory```

```Instance``` can be empty, in this case the name of the metric will not contain any reference to the host/port. If it is omitted, the host:port value is added to the metric name.

### Multiple Data source types
You can send multiple data source types from same key by specifying it in the Module:

```
...
<Module redis_info>
Host "localhost"
Port 6379
Redis_total_net_input_bytes "bytes"
Redis_total_net_output_bytes "bytes"
Redis_total_net_input_bytes "derive"
Redis_total_net_output_bytes "derive"
</Module>
...
```
Installation and Configuration
------------

Graph examples
--------------
This is a screenshot of the SignalFx redis Service Discovery Dashboard:
Please refer to the documentation located in the [SignalFx Integrations repo](https://github.com/signalfx/integrations/tree/release/collectd-redis) for information on the installation and configuration of this plugin.

![](https://github.com/signalfx/redis-collectd-plugin/blob/master/screenshots/dashboard_redis.png)

Requirements
------------
Expand Down
38 changes: 0 additions & 38 deletions redis.conf

This file was deleted.

Binary file removed screenshots/dashboard_redis.png
Binary file not shown.
Binary file removed screenshots/graph_clients_connected.png
Binary file not shown.
Binary file removed screenshots/graph_commands_per_sec.png
Binary file not shown.
Binary file removed screenshots/graph_db0_keys.png
Binary file not shown.
Binary file removed screenshots/graph_memory_used.png
Binary file not shown.

0 comments on commit 1e7f115

Please sign in to comment.