blob: 0a769616b0160bbe3aeeabb6a44f7747eb34a2db (
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
plugin_name: python.d.plugin
modules:
- meta:
plugin_name: python.d.plugin
module_name: retroshare
monitored_instance:
name: RetroShare
link: "https://retroshare.cc/"
categories:
- data-collection.media-streaming-servers
icon_filename: "retroshare.png"
related_resources:
integrations:
list: []
info_provided_to_referring_integrations:
description: ""
keywords:
- retroshare
- p2p
most_popular: false
overview:
data_collection:
metrics_description: "This collector monitors RetroShare statistics such as application bandwidth, peers, and DHT metrics."
method_description: "It connects to the RetroShare web interface to gather metrics."
supported_platforms:
include: []
exclude: []
multi_instance: true
additional_permissions:
description: ""
default_behavior:
auto_detection:
description: "The collector will attempt to connect and detect a RetroShare web interface through http://localhost:9090, even without any configuration."
limits:
description: ""
performance_impact:
description: ""
setup:
prerequisites:
list:
- title: "RetroShare web interface"
description: |
RetroShare needs to be configured to enable the RetroShare WEB Interface and allow access from the Netdata host.
configuration:
file:
name: python.d/retroshare.conf
options:
description: |
There are 2 sections:
* Global variables
* One or more JOBS that can define multiple different instances to monitor.
The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
folding:
title: "Config options"
enabled: true
list:
- name: update_every
description: Sets the default data collection frequency.
default_value: 5
required: false
- name: priority
description: Controls the order of charts at the netdata dashboard.
default_value: 60000
required: false
- name: autodetection_retry
description: Sets the job re-check interval in seconds.
default_value: 0
required: false
- name: penalty
description: Indicates whether to apply penalty to update_every in case of failures.
default_value: yes
required: false
- name: name
description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
default_value: ""
required: false
- name: url
description: The URL to the RetroShare Web UI.
default_value: "http://localhost:9090"
required: false
examples:
folding:
enabled: true
title: "Config"
list:
- name: Local RetroShare Web UI
description: A basic configuration for a RetroShare server running on localhost.
config: |
localhost:
name: 'local retroshare'
url: 'http://localhost:9090'
- name: Remote RetroShare Web UI
description: A basic configuration for a remote RetroShare server.
config: |
remote:
name: 'remote retroshare'
url: 'http://1.2.3.4:9090'
troubleshooting:
problems:
list: []
alerts:
- name: retroshare_dht_working
link: https://github.com/netdata/netdata/blob/master/health/health.d/retroshare.conf
metric: retroshare.dht
info: number of DHT peers
metrics:
folding:
title: Metrics
enabled: false
description: ""
availability: []
scopes:
- name: global
description: "These metrics refer to the entire monitored application."
labels: []
metrics:
- name: retroshare.bandwidth
description: RetroShare Bandwidth
unit: "kilobits/s"
chart_type: area
dimensions:
- name: Upload
- name: Download
- name: retroshare.peers
description: RetroShare Peers
unit: "peers"
chart_type: line
dimensions:
- name: All friends
- name: Connected friends
- name: retroshare.dht
description: Retroshare DHT
unit: "peers"
chart_type: line
dimensions:
- name: DHT nodes estimated
- name: RS nodes estimated
|
