33cdac2f6 · cryptotaxi247/netdata-1

@@ -1,70 +1,142 @@

1 +# yamllint disable rule:line-length

2 +---

3 meta:

4 plugin_name: python.d.plugin

5 module_name: memcached

6 monitored_instance:

7 name: Memcached

6 - link: ''

8 + link: https://memcached.org/

9 categories:

8 - - data-collection.database-servers

9 - icon_filename: 'memcached.png'

10 + - data-collection.database-servers

11 + icon_filename: "memcached.png"

12 related_resources:

13 integrations:

14 list: []

15 info_provided_to_referring_integrations:

14 - description: ''

15 - keywords: []

16 + description: ""

17 + keywords:

18 + - memcached

19 + - memcache

20 + - cache

21 + - database

22 most_popular: false

23 overview:

24 data_collection:

19 - metrics_description: 'Monitor Memcached metrics for proficient in-memory key-value store operations. Track cache hits, misses, and memory usage for efficient data caching.'

20 - method_description: ''

25 + metrics_description: "Monitor Memcached metrics for proficient in-memory key-value store operations. Track cache hits, misses, and memory usage for efficient data caching."

26 + method_description: "It reads server response to stats command ([stats interface](https://github.com/memcached/memcached/wiki/Commands#stats))."

27 supported_platforms:

28 include: []

29 exclude: []

30 multi_instance: true

31 additional_permissions:

26 - description: ''

32 + description: ""

33 default_behavior:

34 auto_detection:

29 - description: ''

35 + description: |

36 + If no configuration is given, collector will attempt to connect to memcached instance on `127.0.0.1:11211` address.

37 limits:

31 - description: ''

38 + description: ""

39 performance_impact:

33 - description: ''

40 + description: ""

41 setup:

42 prerequisites:

43 list: []

44 configuration:

45 file:

39 - name: ''

40 - description: ''

46 + name: python.d/memcached.conf

47 + description: ""

48 options:

42 - description: ''

49 + description: |

50 + There are 2 sections:

51 +

52 + * Global variables

53 + * One or more JOBS that can define multiple different instances to monitor.

54 +

55 + 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.

56 +

57 + Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.

58 +

59 + Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.

60 folding:

44 - title: ''

61 + title: Config options

62 enabled: true

46 - list: []

63 + list:

64 + - name: host

65 + description: the host to connect to.

66 + default_value: "127.0.0.1"

67 + required: false

68 + - name: port

69 + description: the port to connect to.

70 + default_value: "11211"

71 + required: false

72 + - name: update_every

73 + description: Sets the default data collection frequency.

74 + default_value: 10

75 + required: false

76 + - name: priority

77 + description: Controls the order of charts at the netdata dashboard.

78 + default_value: 60000

79 + required: false

80 + - name: autodetection_retry

81 + description: Sets the job re-check interval in seconds.

82 + default_value: 0

83 + required: false

84 + - name: penalty

85 + description: Indicates whether to apply penalty to update_every in case of failures.

86 + default_value: yes

87 + required: false

88 + - name: name

89 + 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.

90 + default_value: ""

91 + required: false

92 examples:

93 folding:

94 enabled: true

50 - title: ''

51 - list: []

95 + title: "Config"

96 + list:

97 + - name: localhost

98 + description: An example configuration for localhost.

99 + folding:

100 + enabled: false

101 + config: |

102 + localhost:

103 + name: 'local'

104 + host: 'localhost'

105 + port: 11211

106 + - name: localipv4

107 + description: An example configuration for localipv4.

108 + folding:

109 + enabled: true

110 + config: |

111 + localhost:

112 + name: 'local'

113 + host: '127.0.0.1'

114 + port: 11211

115 + - name: localipv6

116 + description: An example configuration for localipv6.

117 + folding:

118 + enabled: true

119 + config: |

120 + localhost:

121 + name: 'local'

122 + host: '::1'

123 + port: 11211

124 troubleshooting:

125 problems:

126 list: []

127 alerts:

56 -- name: memcached_cache_memory_usage

57 - link: https://github.com/netdata/netdata/blob/master/health/health.d/memcached.conf

58 - metric: memcached.cache

59 - info: cache memory utilization

60 -- name: memcached_cache_fill_rate

61 - link: https://github.com/netdata/netdata/blob/master/health/health.d/memcached.conf

62 - metric: memcached.cache

63 - info: average rate the cache fills up (positive), or frees up (negative) space over the last hour

64 -- name: memcached_out_of_cache_space_time

65 - link: https://github.com/netdata/netdata/blob/master/health/health.d/memcached.conf

66 - metric: memcached.cache

67 - info: estimated time the cache will run out of space if the system continues to add data at the same rate as the past hour

128 + - name: memcached_cache_memory_usage

129 + link: https://github.com/netdata/netdata/blob/master/health/health.d/memcached.conf

130 + metric: memcached.cache

131 + info: cache memory utilization

132 + - name: memcached_cache_fill_rate

133 + link: https://github.com/netdata/netdata/blob/master/health/health.d/memcached.conf

134 + metric: memcached.cache

135 + info: average rate the cache fills up (positive), or frees up (negative) space over the last hour

136 + - name: memcached_out_of_cache_space_time

137 + link: https://github.com/netdata/netdata/blob/master/health/health.d/memcached.conf

138 + metric: memcached.cache

139 + info: estimated time the cache will run out of space if the system continues to add data at the same rate as the past hour

140 metrics:

141 folding:

142 title: Metrics

@@ -72,104 +144,104 @@ metrics:

144 description: ""

145 availability: []

146 scopes:

75 - - name: global

76 - description: ""

77 - labels: []

78 - metrics:

79 - - name: memcached.cache

80 - description: Cache Size

81 - unit: "MiB"

82 - chart_type: stacked

83 - dimensions:

84 - - name: available

85 - - name: used

86 - - name: memcached.net

87 - description: Network

88 - unit: "kilobits/s"

89 - chart_type: area

90 - dimensions:

91 - - name: in

92 - - name: out

93 - - name: memcached.connections

94 - description: Connections

95 - unit: "connections/s"

96 - chart_type: line

97 - dimensions:

98 - - name: current

99 - - name: rejected

100 - - name: total

101 - - name: memcached.items

102 - description: Items

103 - unit: "items"

104 - chart_type: line

105 - dimensions:

106 - - name: current

107 - - name: total

108 - - name: memcached.evicted_reclaimed

109 - description: Evicted and Reclaimed Items

110 - unit: "items"

111 - chart_type: line

112 - dimensions:

113 - - name: reclaimed

114 - - name: evicted

115 - - name: memcached.get

116 - description: Get Requests

117 - unit: "requests"

118 - chart_type: stacked

119 - dimensions:

120 - - name: hints

121 - - name: misses

122 - - name: memcached.get_rate

123 - description: Get Request Rate

124 - unit: "requests/s"

125 - chart_type: line

126 - dimensions:

127 - - name: rate

128 - - name: memcached.set_rate

129 - description: Set Request Rate

130 - unit: "requests/s"

131 - chart_type: line

132 - dimensions:

133 - - name: rate

134 - - name: memcached.delete

135 - description: Delete Requests

136 - unit: "requests"

137 - chart_type: stacked

138 - dimensions:

139 - - name: hits

140 - - name: misses

141 - - name: memcached.cas

142 - description: Check and Set Requests

143 - unit: "requests"

144 - chart_type: stacked

145 - dimensions:

146 - - name: hits

147 - - name: misses

148 - - name: bad value

149 - - name: memcached.increment

150 - description: Increment Requests

151 - unit: "requests"

152 - chart_type: stacked

153 - dimensions:

154 - - name: hits

155 - - name: misses

156 - - name: memcached.decrement

157 - description: Decrement Requests

158 - unit: "requests"

159 - chart_type: stacked

160 - dimensions:

161 - - name: hits

162 - - name: misses

163 - - name: memcached.touch

164 - description: Touch Requests

165 - unit: "requests"

166 - chart_type: stacked

167 - dimensions:

168 - - name: hits

169 - - name: misses

170 - - name: memcached.touch_rate

171 - description: Touch Request Rate

172 - unit: "requests/s"

173 - chart_type: line

174 - dimensions:

175 - - name: rate

147 + - name: global

148 + description: "These metrics refer to the entire monitored application."

149 + labels: []

150 + metrics:

151 + - name: memcached.cache

152 + description: Cache Size

153 + unit: "MiB"

154 + chart_type: stacked

155 + dimensions:

156 + - name: available

157 + - name: used

158 + - name: memcached.net

159 + description: Network

160 + unit: "kilobits/s"

161 + chart_type: area

162 + dimensions:

163 + - name: in

164 + - name: out

165 + - name: memcached.connections

166 + description: Connections

167 + unit: "connections/s"

168 + chart_type: line

169 + dimensions:

170 + - name: current

171 + - name: rejected

172 + - name: total

173 + - name: memcached.items

174 + description: Items

175 + unit: "items"

176 + chart_type: line

177 + dimensions:

178 + - name: current

179 + - name: total

180 + - name: memcached.evicted_reclaimed

181 + description: Evicted and Reclaimed Items

182 + unit: "items"

183 + chart_type: line

184 + dimensions:

185 + - name: reclaimed

186 + - name: evicted

187 + - name: memcached.get

188 + description: Get Requests

189 + unit: "requests"

190 + chart_type: stacked

191 + dimensions:

192 + - name: hints

193 + - name: misses

194 + - name: memcached.get_rate

195 + description: Get Request Rate

196 + unit: "requests/s"

197 + chart_type: line

198 + dimensions:

199 + - name: rate

200 + - name: memcached.set_rate

201 + description: Set Request Rate

202 + unit: "requests/s"

203 + chart_type: line

204 + dimensions:

205 + - name: rate

206 + - name: memcached.delete

207 + description: Delete Requests

208 + unit: "requests"

209 + chart_type: stacked

210 + dimensions:

211 + - name: hits

212 + - name: misses

213 + - name: memcached.cas

214 + description: Check and Set Requests

215 + unit: "requests"

216 + chart_type: stacked

217 + dimensions:

218 + - name: hits

219 + - name: misses

220 + - name: bad value

221 + - name: memcached.increment

222 + description: Increment Requests

223 + unit: "requests"

224 + chart_type: stacked

225 + dimensions:

226 + - name: hits

227 + - name: misses

228 + - name: memcached.decrement

229 + description: Decrement Requests

230 + unit: "requests"

231 + chart_type: stacked

232 + dimensions:

233 + - name: hits

234 + - name: misses

235 + - name: memcached.touch

236 + description: Touch Requests

237 + unit: "requests"

238 + chart_type: stacked

239 + dimensions:

240 + - name: hits

241 + - name: misses

242 + - name: memcached.touch_rate

243 + description: Touch Request Rate

244 + unit: "requests/s"

245 + chart_type: line

246 + dimensions:

247 + - name: rate

update memcached metadata.yaml (#15529)