summaryrefslogtreecommitdiffstats
path: root/src/go/collectors/go.d.plugin/modules/logstash/metadata.yaml
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/go/collectors/go.d.plugin/modules/logstash/metadata.yaml274
1 files changed, 274 insertions, 0 deletions
diff --git a/src/go/collectors/go.d.plugin/modules/logstash/metadata.yaml b/src/go/collectors/go.d.plugin/modules/logstash/metadata.yaml
new file mode 100644
index 000000000..2b3ddfd27
--- /dev/null
+++ b/src/go/collectors/go.d.plugin/modules/logstash/metadata.yaml
@@ -0,0 +1,274 @@
+plugin_name: go.d.plugin
+modules:
+ - meta:
+ id: collector-go.d.plugin-logstash
+ plugin_name: go.d.plugin
+ module_name: logstash
+ monitored_instance:
+ name: Logstash
+ link: https://www.elastic.co/products/logstash
+ icon_filename: elastic-logstash.svg
+ categories:
+ - data-collection.logs-servers
+ keywords:
+ - logstatsh
+ related_resources:
+ integrations:
+ list: []
+ info_provided_to_referring_integrations:
+ description: ""
+ most_popular: false
+ overview:
+ data_collection:
+ metrics_description: |
+ This collector monitors Logstash instances.
+ method_description: ""
+ supported_platforms:
+ include: []
+ exclude: []
+ multi_instance: true
+ additional_permissions:
+ description: ""
+ default_behavior:
+ auto_detection:
+ description: ""
+ limits:
+ description: ""
+ performance_impact:
+ description: ""
+ setup:
+ prerequisites:
+ list: []
+ configuration:
+ file:
+ name: go.d/logstatsh.conf
+ options:
+ description: |
+ The following options can be defined globally: update_every, autodetection_retry.
+ folding:
+ title: Config options
+ enabled: true
+ list:
+ - name: update_every
+ description: Data collection frequency.
+ default_value: 1
+ required: false
+ - name: autodetection_retry
+ description: Recheck interval in seconds. Zero means no recheck will be scheduled.
+ default_value: 0
+ required: false
+ - name: url
+ description: Server URL.
+ default_value: http://localhost:9600
+ required: true
+ - name: timeout
+ description: HTTP request timeout.
+ default_value: 1
+ required: false
+ - name: username
+ description: Username for basic HTTP authentication.
+ default_value: ""
+ required: false
+ - name: password
+ description: Password for basic HTTP authentication.
+ default_value: ""
+ required: false
+ - name: proxy_url
+ description: Proxy URL.
+ default_value: ""
+ required: false
+ - name: proxy_username
+ description: Username for proxy basic HTTP authentication.
+ default_value: ""
+ required: false
+ - name: proxy_password
+ description: Password for proxy basic HTTP authentication.
+ default_value: ""
+ required: false
+ - name: method
+ description: HTTP request method.
+ default_value: GET
+ required: false
+ - name: body
+ description: HTTP request body.
+ default_value: ""
+ required: false
+ - name: headers
+ description: HTTP request headers.
+ default_value: ""
+ required: false
+ - name: not_follow_redirects
+ description: Redirect handling policy. Controls whether the client follows redirects.
+ default_value: false
+ required: false
+ - name: tls_skip_verify
+ description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
+ default_value: false
+ required: false
+ - name: tls_ca
+ description: Certification authority that the client uses when verifying the server's certificates.
+ default_value: ""
+ required: false
+ - name: tls_cert
+ description: Client TLS certificate.
+ default_value: ""
+ required: false
+ - name: tls_key
+ description: Client TLS key.
+ default_value: ""
+ required: false
+ examples:
+ folding:
+ title: Config
+ enabled: true
+ list:
+ - name: Basic
+ description: A basic example configuration.
+ config: |
+ jobs:
+ - name: local
+ url: http://localhost:9600
+ - name: HTTP authentication
+ description: HTTP authentication.
+ config: |
+ jobs:
+ - name: local
+ url: http://localhost:9600
+ username: username
+ password: password
+ - name: HTTPS with self-signed certificate
+ description: HTTPS and self-signed certificate.
+ config: |
+ jobs:
+ - name: local
+ url: https://localhost:9600
+ tls_skip_verify: yes
+ - name: Multi-instance
+ description: |
+ > **Note**: When you define multiple jobs, their names must be unique.
+
+ Collecting metrics from local and remote instances.
+ config: |
+ jobs:
+ - name: local
+ url: http://localhost:9600
+
+ - name: remote
+ url: http://192.0.2.1:9600
+ troubleshooting:
+ problems:
+ list: []
+ alerts: []
+ metrics:
+ folding:
+ title: Metrics
+ enabled: false
+ description: ""
+ availability: []
+ scopes:
+ - name: global
+ description: These metrics refer to the entire monitored application.
+ labels: []
+ metrics:
+ - name: logstash.jvm_threads
+ description: JVM Threads
+ unit: count
+ chart_type: line
+ dimensions:
+ - name: threads
+ - name: logstash.jvm_mem_heap_used
+ description: JVM Heap Memory Percentage
+ unit: percentage
+ chart_type: line
+ dimensions:
+ - name: in_use
+ - name: logstash.jvm_mem_heap
+ description: JVM Heap Memory
+ unit: KiB
+ chart_type: area
+ dimensions:
+ - name: committed
+ - name: used
+ - name: logstash.jvm_mem_pools_eden
+ description: JVM Pool Eden Memory
+ unit: KiB
+ chart_type: area
+ dimensions:
+ - name: committed
+ - name: used
+ - name: logstash.jvm_mem_pools_survivor
+ description: JVM Pool Survivor Memory
+ unit: KiB
+ chart_type: area
+ dimensions:
+ - name: committed
+ - name: used
+ - name: logstash.jvm_mem_pools_old
+ description: JVM Pool Old Memory
+ unit: KiB
+ chart_type: area
+ dimensions:
+ - name: committed
+ - name: used
+ - name: logstash.jvm_gc_collector_count
+ description: Garbage Collection Count
+ unit: counts/s
+ chart_type: line
+ dimensions:
+ - name: eden
+ - name: old
+ - name: logstash.jvm_gc_collector_time
+ description: Time Spent On Garbage Collection
+ unit: ms
+ chart_type: line
+ dimensions:
+ - name: eden
+ - name: old
+ - name: logstash.open_file_descriptors
+ description: Open File Descriptors
+ unit: fd
+ chart_type: line
+ dimensions:
+ - name: open
+ - name: logstash.event
+ description: Events Overview
+ unit: events/s
+ chart_type: line
+ dimensions:
+ - name: in
+ - name: filtered
+ - name: out
+ - name: logstash.event_duration
+ description: Events Duration
+ unit: seconds
+ chart_type: line
+ dimensions:
+ - name: event
+ - name: queue
+ - name: logstash.uptime
+ description: Uptime
+ unit: seconds
+ chart_type: line
+ dimensions:
+ - name: uptime
+ - name: pipeline
+ description: These metrics refer to the pipeline.
+ labels:
+ - name: pipeline
+ description: pipeline name
+ metrics:
+ - name: logstash.pipeline_event
+ description: Pipeline Events
+ unit: events/s
+ chart_type: line
+ dimensions:
+ - name: in
+ - name: filtered
+ - name: out
+ - name: logstash.pipeline_event
+ description: Pipeline Events Duration
+ unit: seconds
+ chart_type: line
+ dimensions:
+ - name: event
+ - name: queue