blob: 64294113704be89a487cdea740b0e2a42db3b8b6 (
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
plugin_name: python.d.plugin
modules:
- meta:
plugin_name: python.d.plugin
module_name: ceph
monitored_instance:
name: Ceph
link: 'https://ceph.io/'
categories:
- data-collection.storage-mount-points-and-filesystems
icon_filename: 'ceph.svg'
related_resources:
integrations:
list: []
info_provided_to_referring_integrations:
description: ''
keywords:
- ceph
- storage
most_popular: false
overview:
data_collection:
metrics_description: 'This collector monitors Ceph metrics about Cluster statistics, OSD usage, latency and Pool statistics.'
method_description: 'Uses the `rados` python module to connect to a Ceph cluster.'
supported_platforms:
include: []
exclude: []
multi_instance: true
additional_permissions:
description: ''
default_behavior:
auto_detection:
description: ''
limits:
description: ''
performance_impact:
description: ''
setup:
prerequisites:
list:
- title: '`rados` python module'
description: 'Make sure the `rados` python module is installed'
- title: 'Granting read permissions to ceph group from keyring file'
description: 'Execute: `chmod 640 /etc/ceph/ceph.client.admin.keyring`'
- title: 'Create a specific rados_id'
description: 'You can optionally create a rados_id to use instead of admin'
configuration:
file:
name: python.d/ceph.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: config_file
description: Ceph config file
default_value: ''
required: true
- name: keyring_file
description: Ceph keyring file. netdata user must be added into ceph group and keyring file must be read group permission.
default_value: ''
required: true
- name: rados_id
description: A rados user id to use for connecting to the Ceph cluster.
default_value: 'admin'
required: false
examples:
folding:
enabled: true
title: "Config"
list:
- name: Basic local Ceph cluster
description: A basic configuration to connect to a local Ceph cluster.
folding:
enabled: false
config: |
local:
config_file: '/etc/ceph/ceph.conf'
keyring_file: '/etc/ceph/ceph.client.admin.keyring'
troubleshooting:
problems:
list: []
alerts:
- name: ceph_cluster_space_usage
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/ceph.conf
metric: ceph.general_usage
info: cluster disk space utilization
metrics:
folding:
title: Metrics
enabled: false
description: ""
availability: []
scopes:
- name: global
description: "These metrics refer to the entire monitored application."
labels: []
metrics:
- name: ceph.general_usage
description: Ceph General Space
unit: "KiB"
chart_type: stacked
dimensions:
- name: avail
- name: used
- name: ceph.general_objects
description: Ceph General Objects
unit: "objects"
chart_type: area
dimensions:
- name: cluster
- name: ceph.general_bytes
description: Ceph General Read/Write Data/s
unit: "KiB/s"
chart_type: area
dimensions:
- name: read
- name: write
- name: ceph.general_operations
description: Ceph General Read/Write Operations/s
unit: "operations"
chart_type: area
dimensions:
- name: read
- name: write
- name: ceph.general_latency
description: Ceph General Apply/Commit latency
unit: "milliseconds"
chart_type: area
dimensions:
- name: apply
- name: commit
- name: ceph.pool_usage
description: Ceph Pools
unit: "KiB"
chart_type: line
dimensions:
- name: a dimension per Ceph Pool
- name: ceph.pool_objects
description: Ceph Pools
unit: "objects"
chart_type: line
dimensions:
- name: a dimension per Ceph Pool
- name: ceph.pool_read_bytes
description: Ceph Read Pool Data/s
unit: "KiB/s"
chart_type: area
dimensions:
- name: a dimension per Ceph Pool
- name: ceph.pool_write_bytes
description: Ceph Write Pool Data/s
unit: "KiB/s"
chart_type: area
dimensions:
- name: a dimension per Ceph Pool
- name: ceph.pool_read_operations
description: Ceph Read Pool Operations/s
unit: "operations"
chart_type: area
dimensions:
- name: a dimension per Ceph Pool
- name: ceph.pool_write_operations
description: Ceph Write Pool Operations/s
unit: "operations"
chart_type: area
dimensions:
- name: a dimension per Ceph Pool
- name: ceph.osd_usage
description: Ceph OSDs
unit: "KiB"
chart_type: line
dimensions:
- name: a dimension per Ceph OSD
- name: ceph.osd_size
description: Ceph OSDs size
unit: "KiB"
chart_type: line
dimensions:
- name: a dimension per Ceph OSD
- name: ceph.apply_latency
description: Ceph OSDs apply latency
unit: "milliseconds"
chart_type: line
dimensions:
- name: a dimension per Ceph OSD
- name: ceph.commit_latency
description: Ceph OSDs commit latency
unit: "milliseconds"
chart_type: line
dimensions:
- name: a dimension per Ceph OSD
|
