| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-logstash |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: logstash |
| 7 | monitored_instance: |
| 8 | name: Logstash |
| 9 | link: https://www.elastic.co/products/logstash |
| 10 | icon_filename: elastic-logstash.svg |
| 11 | categories: |
| 12 | - data-collection.applications |
| 13 | keywords: |
| 14 | - logstash |
| 15 | related_resources: |
| 16 | integrations: |
| 17 | list: [] |
| 18 | info_provided_to_referring_integrations: |
| 19 | description: "" |
| 20 | overview: |
| 21 | data_collection: |
| 22 | metrics_description: | |
| 23 | This collector monitors Logstash instances. |
| 24 | method_description: "" |
| 25 | supported_platforms: |
| 26 | include: [] |
| 27 | exclude: [] |
| 28 | multi_instance: true |
| 29 | additional_permissions: |
| 30 | description: "" |
| 31 | default_behavior: |
| 32 | auto_detection: |
| 33 | description: "" |
| 34 | limits: |
| 35 | description: "" |
| 36 | performance_impact: |
| 37 | description: "" |
| 38 | setup: |
| 39 | prerequisites: |
| 40 | list: [] |
| 41 | configuration: |
| 42 | file: |
| 43 | name: go.d/logstatsh.conf |
| 44 | options: |
| 45 | description: | |
| 46 | The following options can be defined globally: update_every, autodetection_retry. |
| 47 | folding: |
| 48 | title: Config options |
| 49 | enabled: true |
| 50 | list: |
| 51 | - name: update_every |
| 52 | description: Data collection interval (seconds). |
| 53 | default_value: 1 |
| 54 | required: false |
| 55 | group: Collection |
| 56 | - name: autodetection_retry |
| 57 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 58 | default_value: 0 |
| 59 | required: false |
| 60 | group: Collection |
| 61 | |
| 62 | - name: url |
| 63 | description: Target endpoint URL. |
| 64 | default_value: http://localhost:9600 |
| 65 | required: true |
| 66 | group: Target |
| 67 | - name: timeout |
| 68 | description: HTTP request timeout (seconds). |
| 69 | default_value: 1 |
| 70 | required: false |
| 71 | group: Target |
| 72 | |
| 73 | - name: username |
| 74 | description: Username for Basic HTTP authentication. |
| 75 | default_value: "" |
| 76 | required: false |
| 77 | group: HTTP Auth |
| 78 | - name: password |
| 79 | description: Password for Basic HTTP authentication. |
| 80 | default_value: "" |
| 81 | required: false |
| 82 | group: HTTP Auth |
| 83 | - name: bearer_token_file |
| 84 | description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)." |
| 85 | default_value: "" |
| 86 | required: false |
| 87 | group: HTTP Auth |
| 88 | |
| 89 | - name: tls_skip_verify |
| 90 | description: Skip TLS certificate and hostname verification (insecure). |
| 91 | default_value: no |
| 92 | required: false |
| 93 | group: TLS |
| 94 | - name: tls_ca |
| 95 | description: Path to CA bundle used to validate the server certificate. |
| 96 | default_value: "" |
| 97 | required: false |
| 98 | group: TLS |
| 99 | - name: tls_cert |
| 100 | description: Path to client TLS certificate (for mTLS). |
| 101 | default_value: "" |
| 102 | required: false |
| 103 | group: TLS |
| 104 | - name: tls_key |
| 105 | description: Path to client TLS private key (for mTLS). |
| 106 | default_value: "" |
| 107 | required: false |
| 108 | group: TLS |
| 109 | |
| 110 | - name: proxy_url |
| 111 | description: HTTP proxy URL. |
| 112 | default_value: "" |
| 113 | required: false |
| 114 | group: Proxy |
| 115 | - name: proxy_username |
| 116 | description: Username for proxy Basic HTTP authentication. |
| 117 | default_value: "" |
| 118 | required: false |
| 119 | group: Proxy |
| 120 | - name: proxy_password |
| 121 | description: Password for proxy Basic HTTP authentication. |
| 122 | default_value: "" |
| 123 | required: false |
| 124 | group: Proxy |
| 125 | |
| 126 | - name: method |
| 127 | description: HTTP method to use. |
| 128 | default_value: "GET" |
| 129 | required: false |
| 130 | group: Request |
| 131 | - name: body |
| 132 | description: Request body (e.g., for POST/PUT). |
| 133 | default_value: "" |
| 134 | required: false |
| 135 | group: Request |
| 136 | - name: headers |
| 137 | description: "Additional HTTP headers (one per line as key: value)." |
| 138 | default_value: "" |
| 139 | required: false |
| 140 | group: Request |
| 141 | - name: not_follow_redirects |
| 142 | description: Do not follow HTTP redirects. |
| 143 | default_value: no |
| 144 | required: false |
| 145 | group: Request |
| 146 | - name: force_http2 |
| 147 | description: Force HTTP/2 (including h2c over TCP). |
| 148 | default_value: no |
| 149 | required: false |
| 150 | group: Request |
| 151 | |
| 152 | - name: vnode |
| 153 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 154 | default_value: "" |
| 155 | required: false |
| 156 | group: Virtual Node |
| 157 | examples: |
| 158 | folding: |
| 159 | title: Config |
| 160 | enabled: true |
| 161 | list: |
| 162 | - name: Basic |
| 163 | description: A basic example configuration. |
| 164 | config: | |
| 165 | jobs: |
| 166 | - name: local |
| 167 | url: http://localhost:9600 |
| 168 | - name: HTTP authentication |
| 169 | description: HTTP authentication. |
| 170 | config: | |
| 171 | jobs: |
| 172 | - name: local |
| 173 | url: http://localhost:9600 |
| 174 | username: username |
| 175 | password: password |
| 176 | - name: HTTPS with self-signed certificate |
| 177 | description: HTTPS and self-signed certificate. |
| 178 | config: | |
| 179 | jobs: |
| 180 | - name: local |
| 181 | url: https://localhost:9600 |
| 182 | tls_skip_verify: yes |
| 183 | - name: Multi-instance |
| 184 | description: | |
| 185 | > **Note**: When you define multiple jobs, their names must be unique. |
| 186 | |
| 187 | Collecting metrics from local and remote instances. |
| 188 | config: | |
| 189 | jobs: |
| 190 | - name: local |
| 191 | url: http://localhost:9600 |
| 192 | |
| 193 | - name: remote |
| 194 | url: http://192.0.2.1:9600 |
| 195 | troubleshooting: |
| 196 | problems: |
| 197 | list: [] |
| 198 | alerts: [] |
| 199 | metrics: |
| 200 | folding: |
| 201 | title: Metrics |
| 202 | enabled: false |
| 203 | description: "" |
| 204 | availability: [] |
| 205 | scopes: |
| 206 | - name: global |
| 207 | description: These metrics refer to the entire monitored application. |
| 208 | labels: [] |
| 209 | metrics: |
| 210 | - name: logstash.jvm_threads |
| 211 | description: JVM Threads |
| 212 | unit: count |
| 213 | chart_type: line |
| 214 | dimensions: |
| 215 | - name: threads |
| 216 | - name: logstash.jvm_mem_heap_used |
| 217 | description: JVM Heap Memory Percentage |
| 218 | unit: percentage |
| 219 | chart_type: line |
| 220 | dimensions: |
| 221 | - name: in_use |
| 222 | - name: logstash.jvm_mem_heap |
| 223 | description: JVM Heap Memory |
| 224 | unit: KiB |
| 225 | chart_type: area |
| 226 | dimensions: |
| 227 | - name: committed |
| 228 | - name: used |
| 229 | - name: logstash.jvm_mem_pools_eden |
| 230 | description: JVM Pool Eden Memory |
| 231 | unit: KiB |
| 232 | chart_type: area |
| 233 | dimensions: |
| 234 | - name: committed |
| 235 | - name: used |
| 236 | - name: logstash.jvm_mem_pools_survivor |
| 237 | description: JVM Pool Survivor Memory |
| 238 | unit: KiB |
| 239 | chart_type: area |
| 240 | dimensions: |
| 241 | - name: committed |
| 242 | - name: used |
| 243 | - name: logstash.jvm_mem_pools_old |
| 244 | description: JVM Pool Old Memory |
| 245 | unit: KiB |
| 246 | chart_type: area |
| 247 | dimensions: |
| 248 | - name: committed |
| 249 | - name: used |
| 250 | - name: logstash.jvm_gc_collector_count |
| 251 | description: Garbage Collection Count |
| 252 | unit: counts/s |
| 253 | chart_type: line |
| 254 | dimensions: |
| 255 | - name: eden |
| 256 | - name: old |
| 257 | - name: logstash.jvm_gc_collector_time |
| 258 | description: Time Spent On Garbage Collection |
| 259 | unit: ms |
| 260 | chart_type: line |
| 261 | dimensions: |
| 262 | - name: eden |
| 263 | - name: old |
| 264 | - name: logstash.open_file_descriptors |
| 265 | description: Open File Descriptors |
| 266 | unit: fd |
| 267 | chart_type: line |
| 268 | dimensions: |
| 269 | - name: open |
| 270 | - name: logstash.event |
| 271 | description: Events Overview |
| 272 | unit: events/s |
| 273 | chart_type: line |
| 274 | dimensions: |
| 275 | - name: in |
| 276 | - name: filtered |
| 277 | - name: out |
| 278 | - name: logstash.event_duration |
| 279 | description: Events Duration |
| 280 | unit: seconds |
| 281 | chart_type: line |
| 282 | dimensions: |
| 283 | - name: event |
| 284 | - name: queue |
| 285 | - name: logstash.uptime |
| 286 | description: Uptime |
| 287 | unit: seconds |
| 288 | chart_type: line |
| 289 | dimensions: |
| 290 | - name: uptime |
| 291 | - name: pipeline |
| 292 | description: These metrics refer to the pipeline. |
| 293 | labels: |
| 294 | - name: pipeline |
| 295 | description: pipeline name |
| 296 | metrics: |
| 297 | - name: logstash.pipeline_event |
| 298 | description: Pipeline Events |
| 299 | unit: events/s |
| 300 | chart_type: line |
| 301 | dimensions: |
| 302 | - name: in |
| 303 | - name: filtered |
| 304 | - name: out |
| 305 | - name: logstash.pipeline_event_duration |
| 306 | description: Pipeline Events Duration |
| 307 | unit: seconds |
| 308 | chart_type: line |
| 309 | dimensions: |
| 310 | - name: event |
| 311 | - name: queue |