summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/rethinkdbs/README.md
blob: 527ce4c316c14606cbb8c6ac8b1bab39eea95250 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
<!--
title: "RethinkDB monitoring with Netdata"
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/rethinkdbs/README.md"
sidebar_label: "RethinkDB"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Integrations/Monitor/Databases"
-->

# RethinkDB collector

Collects database server and cluster statistics.

Following charts are drawn:

1. **Connected Servers**

    - connected
    - missing

2. **Active Clients**

    - active

3. **Queries** per second

    - queries

4. **Documents** per second

    - documents

## Configuration

Edit the `python.d/rethinkdbs.conf` configuration file using `edit-config` from the
Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically
at `/etc/netdata`.

```bash
cd /etc/netdata   # Replace this path with your Netdata config directory, if different
sudo ./edit-config python.d/rethinkdbs.conf
```

```yaml
localhost:
  name: 'local'
  host: '127.0.0.1'
  port: 28015
  user: "user"
  password: "pass"
```

When no configuration file is found, module tries to connect to `127.0.0.1:28015`.




### Troubleshooting

To troubleshoot issues with the `rethinkdbs` module, run the `python.d.plugin` with the debug option enabled. The 
output will give you the output of the data collection job or error messages on why the collector isn't working.

First, navigate to your plugins directory, usually they are located under `/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.

```bash
cd /usr/libexec/netdata/plugins.d/
sudo su -s /bin/bash netdata
```

Now you can manually run the `rethinkdbs` module in debug mode:

```bash
./python.d.plugin rethinkdbs debug trace
```