github.com/netdata/go.d.plugin@v0.58.1/modules/solr/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-solr 5 plugin_name: go.d.plugin 6 module_name: solr 7 monitored_instance: 8 name: Solr 9 link: https://lucene.apache.org/solr/ 10 icon_filename: solr.svg 11 categories: 12 - data-collection.search-engines 13 keywords: 14 - solr 15 related_resources: 16 integrations: 17 list: [] 18 info_provided_to_referring_integrations: 19 description: "" 20 most_popular: false 21 overview: 22 data_collection: 23 metrics_description: | 24 This collector monitors Solr instances. 25 method_description: "" 26 supported_platforms: 27 include: [] 28 exclude: [] 29 multi_instance: true 30 additional_permissions: 31 description: "" 32 default_behavior: 33 auto_detection: 34 description: "" 35 limits: 36 description: "" 37 performance_impact: 38 description: "" 39 setup: 40 prerequisites: 41 list: 42 - title: Solr version 6.4+ 43 description: | 44 This collector does not work with Solr versions lower 6.4. 45 configuration: 46 file: 47 name: go.d/solr.conf 48 options: 49 description: | 50 The following options can be defined globally: update_every, autodetection_retry. 51 folding: 52 title: All options 53 enabled: true 54 list: 55 - name: update_every 56 description: Data collection frequency. 57 default_value: 1 58 required: false 59 - name: autodetection_retry 60 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 61 default_value: 0 62 required: false 63 - name: url 64 description: Server URL. 65 default_value: http://127.0.0.1:8983 66 required: true 67 - name: socket 68 description: Server Unix socket. 69 default_value: "" 70 required: false 71 - name: address 72 description: Server address in IP:PORT format. 73 default_value: "" 74 required: false 75 - name: fcgi_path 76 description: Status path. 77 default_value: /status 78 required: false 79 - name: timeout 80 description: HTTP request timeout. 81 default_value: 1 82 required: false 83 - name: username 84 description: Username for basic HTTP authentication. 85 default_value: "" 86 required: false 87 - name: password 88 description: Password for basic HTTP authentication. 89 default_value: "" 90 required: false 91 - name: proxy_url 92 description: Proxy URL. 93 default_value: "" 94 required: false 95 - name: proxy_username 96 description: Username for proxy basic HTTP authentication. 97 default_value: "" 98 required: false 99 - name: proxy_password 100 description: Password for proxy basic HTTP authentication. 101 default_value: "" 102 required: false 103 - name: method 104 description: HTTP request method. 105 default_value: GET 106 required: false 107 - name: body 108 description: HTTP request body. 109 default_value: "" 110 required: false 111 - name: headers 112 description: HTTP request headers. 113 default_value: "" 114 required: false 115 - name: not_follow_redirects 116 description: Redirect handling policy. Controls whether the client follows redirects. 117 default_value: false 118 required: false 119 - name: tls_skip_verify 120 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 121 default_value: false 122 required: false 123 - name: tls_ca 124 description: Certification authority that the client uses when verifying the server's certificates. 125 default_value: "" 126 required: false 127 - name: tls_cert 128 description: Client TLS certificate. 129 default_value: "" 130 required: false 131 - name: tls_key 132 description: Client TLS key. 133 default_value: "" 134 required: false 135 examples: 136 folding: 137 title: Config 138 enabled: true 139 list: 140 - name: Basic 141 description: An example configuration. 142 config: | 143 jobs: 144 - name: local 145 url: http://localhost:8983 146 - name: Basic HTTP auth 147 description: Local Solr instance with basic HTTP authentication. 148 config: | 149 jobs: 150 - name: local 151 url: http://localhost:8983 152 username: foo 153 password: bar 154 - name: Multi-instance 155 description: | 156 > **Note**: When you define multiple jobs, their names must be unique. 157 158 Local and remote instances. 159 config: | 160 jobs: 161 - name: local 162 url: http://localhost:8983 163 164 - name: remote 165 url: http://203.0.113.10:8983 166 troubleshooting: 167 problems: 168 list: [] 169 alerts: [] 170 metrics: 171 folding: 172 title: Metrics 173 enabled: false 174 description: "" 175 availability: [] 176 scopes: 177 - name: global 178 description: These metrics refer to the entire monitored application. 179 labels: [] 180 metrics: 181 - name: solr.search_requests 182 description: Search Requests 183 unit: requests/s 184 chart_type: line 185 dimensions: 186 - name: search 187 - name: solr.search_errors 188 description: Search Errors 189 unit: errors/s 190 chart_type: line 191 dimensions: 192 - name: errors 193 - name: solr.search_errors_by_type 194 description: Search Errors By Type 195 unit: errors/s 196 chart_type: line 197 dimensions: 198 - name: client 199 - name: server 200 - name: timeouts 201 - name: solr.search_requests_processing_time 202 description: Search Requests Processing Time 203 unit: milliseconds 204 chart_type: line 205 dimensions: 206 - name: time 207 - name: solr.search_requests_timings 208 description: Search Requests Timings 209 unit: milliseconds 210 chart_type: line 211 dimensions: 212 - name: min 213 - name: median 214 - name: mean 215 - name: max 216 - name: solr.search_requests_processing_time_percentile 217 description: Search Requests Processing Time Percentile 218 unit: milliseconds 219 chart_type: line 220 dimensions: 221 - name: p75 222 - name: p95 223 - name: p99 224 - name: p999 225 - name: solr.update_requests 226 description: Update Requests 227 unit: requests/s 228 chart_type: line 229 dimensions: 230 - name: search 231 - name: solr.update_errors 232 description: Update Errors 233 unit: errors/s 234 chart_type: line 235 dimensions: 236 - name: errors 237 - name: solr.update_errors_by_type 238 description: Update Errors By Type 239 unit: errors/s 240 chart_type: line 241 dimensions: 242 - name: client 243 - name: server 244 - name: timeouts 245 - name: solr.update_requests_processing_time 246 description: Update Requests Processing Time 247 unit: milliseconds 248 chart_type: line 249 dimensions: 250 - name: time 251 - name: solr.update_requests_timings 252 description: Update Requests Timings 253 unit: milliseconds 254 chart_type: line 255 dimensions: 256 - name: min 257 - name: median 258 - name: mean 259 - name: max 260 - name: solr.update_requests_processing_time_percentile 261 description: Update Requests Processing Time Percentile 262 unit: milliseconds 263 chart_type: line 264 dimensions: 265 - name: p75 266 - name: p95 267 - name: p99 268 - name: p999