blob: dbc421c9047e9a351c4f4fe14b86e1ef7c1dc169 (
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
plugin_name: python.d.plugin
modules:
- meta:
plugin_name: python.d.plugin
module_name: ipfs
monitored_instance:
name: IPFS
link: "https://ipfs.tech/"
categories:
- data-collection.storage-mount-points-and-filesystems
icon_filename: "ipfs.svg"
related_resources:
integrations:
list: []
info_provided_to_referring_integrations:
description: ""
keywords: []
most_popular: false
overview:
data_collection:
metrics_description: "This collector monitors IPFS server metrics about its quality and performance."
method_description: "It connects to an http endpoint of the IPFS server to collect the metrics"
supported_platforms:
include: []
exclude: []
multi_instance: true
additional_permissions:
description: ""
default_behavior:
auto_detection:
description: "If the endpoint is accessible by the Agent, netdata will autodetect it"
limits:
description: |
Calls to the following endpoints are disabled due to IPFS bugs:
/api/v0/stats/repo (https://github.com/ipfs/go-ipfs/issues/3874)
/api/v0/pin/ls (https://github.com/ipfs/go-ipfs/issues/7528)
performance_impact:
description: ""
setup:
prerequisites:
list: []
configuration:
file:
name: "python.d/ipfs.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: ""
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: The JOB's name as it will appear at the dashboard (by default is the job_name)
default_value: job_name
required: false
- name: url
description: URL to the IPFS API
default_value: no
required: true
- name: repoapi
description: Collect repo metrics.
default_value: no
required: false
- name: pinapi
description: Set status of IPFS pinned object polling.
default_value: no
required: false
examples:
folding:
enabled: true
title: "Config"
list:
- name: Basic (default out-of-the-box)
description: A basic example configuration, one job will run at a time. Autodetect mechanism uses it by default.
folding:
enabled: false
config: |
localhost:
name: 'local'
url: 'http://localhost:5001'
repoapi: no
pinapi: no
- name: Multi-instance
description: |
> **Note**: When you define multiple jobs, their names must be unique.
Collecting metrics from local and remote instances.
config: |
localhost:
name: 'local'
url: 'http://localhost:5001'
repoapi: no
pinapi: no
remote_host:
name: 'remote'
url: 'http://192.0.2.1:5001'
repoapi: no
pinapi: no
troubleshooting:
problems:
list: []
alerts:
- name: ipfs_datastore_usage
link: https://github.com/netdata/netdata/blob/master/health/health.d/ipfs.conf
metric: ipfs.repo_size
info: IPFS datastore utilization
metrics:
folding:
title: Metrics
enabled: false
description: ""
availability: []
scopes:
- name: global
description: "These metrics refer to the entire monitored application."
labels: []
metrics:
- name: ipfs.bandwidth
description: IPFS Bandwidth
unit: "kilobits/s"
chart_type: line
dimensions:
- name: in
- name: out
- name: ipfs.peers
description: IPFS Peers
unit: "peers"
chart_type: line
dimensions:
- name: peers
- name: ipfs.repo_size
description: IPFS Repo Size
unit: "GiB"
chart_type: area
dimensions:
- name: avail
- name: size
- name: ipfs.repo_objects
description: IPFS Repo Objects
unit: "objects"
chart_type: line
dimensions:
- name: objects
- name: pinned
- name: recursive_pins
|
