github.com/netdata/go.d.plugin@v0.58.1/modules/logstash/metadata.yaml (about)

     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.logs-servers
    13        keywords:
    14          - logstatsh
    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 Logstash 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        configuration:
    43          file:
    44            name: go.d/logstatsh.conf
    45          options:
    46            description: |
    47              The following options can be defined globally: update_every, autodetection_retry.
    48            folding:
    49              title: Config options
    50              enabled: true
    51            list:
    52              - name: update_every
    53                description: Data collection frequency.
    54                default_value: 1
    55                required: false
    56              - name: autodetection_retry
    57                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    58                default_value: 0
    59                required: false
    60              - name: url
    61                description: Server URL.
    62                default_value: http://localhost:9600
    63                required: true
    64              - name: timeout
    65                description: HTTP request timeout.
    66                default_value: 1
    67                required: false
    68              - name: username
    69                description: Username for basic HTTP authentication.
    70                default_value: ""
    71                required: false
    72              - name: password
    73                description: Password for basic HTTP authentication.
    74                default_value: ""
    75                required: false
    76              - name: proxy_url
    77                description: Proxy URL.
    78                default_value: ""
    79                required: false
    80              - name: proxy_username
    81                description: Username for proxy basic HTTP authentication.
    82                default_value: ""
    83                required: false
    84              - name: proxy_password
    85                description: Password for proxy basic HTTP authentication.
    86                default_value: ""
    87                required: false
    88              - name: method
    89                description: HTTP request method.
    90                default_value: GET
    91                required: false
    92              - name: body
    93                description: HTTP request body.
    94                default_value: ""
    95                required: false
    96              - name: headers
    97                description: HTTP request headers.
    98                default_value: ""
    99                required: false
   100              - name: not_follow_redirects
   101                description: Redirect handling policy. Controls whether the client follows redirects.
   102                default_value: false
   103                required: false
   104              - name: tls_skip_verify
   105                description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
   106                default_value: false
   107                required: false
   108              - name: tls_ca
   109                description: Certification authority that the client uses when verifying the server's certificates.
   110                default_value: ""
   111                required: false
   112              - name: tls_cert
   113                description: Client TLS certificate.
   114                default_value: ""
   115                required: false
   116              - name: tls_key
   117                description: Client TLS key.
   118                default_value: ""
   119                required: false
   120          examples:
   121            folding:
   122              title: Config
   123              enabled: true
   124            list:
   125              - name: Basic
   126                description: A basic example configuration.
   127                config: |
   128                  jobs:
   129                    - name: local
   130                      url: http://localhost:9600
   131              - name: HTTP authentication
   132                description: HTTP authentication.
   133                config: |
   134                  jobs:
   135                    - name: local
   136                      url: http://localhost:9600
   137                      username: username
   138                      password: password
   139              - name: HTTPS with self-signed certificate
   140                description: HTTPS and self-signed certificate.
   141                config: |
   142                  jobs:
   143                    - name: local
   144                      url: https://localhost:9600
   145                      tls_skip_verify: yes
   146              - name: Multi-instance
   147                description: |
   148                  > **Note**: When you define multiple jobs, their names must be unique.
   149                  
   150                  Collecting metrics from local and remote instances.
   151                config: |
   152                  jobs:
   153                    - name: local
   154                      url: http://localhost:9600
   155                  
   156                    - name: remote
   157                      url: http://192.0.2.1:9600
   158      troubleshooting:
   159        problems:
   160          list: []
   161      alerts: []
   162      metrics:
   163        folding:
   164          title: Metrics
   165          enabled: false
   166        description: ""
   167        availability: []
   168        scopes:
   169          - name: global
   170            description: These metrics refer to the entire monitored application.
   171            labels: []
   172            metrics:
   173              - name: logstash.jvm_threads
   174                description: JVM Threads
   175                unit: count
   176                chart_type: line
   177                dimensions:
   178                  - name: threads
   179              - name: logstash.jvm_mem_heap_used
   180                description: JVM Heap Memory Percentage
   181                unit: percentage
   182                chart_type: line
   183                dimensions:
   184                  - name: in_use
   185              - name: logstash.jvm_mem_heap
   186                description: JVM Heap Memory
   187                unit: KiB
   188                chart_type: area
   189                dimensions:
   190                  - name: committed
   191                  - name: used
   192              - name: logstash.jvm_mem_pools_eden
   193                description: JVM Pool Eden Memory
   194                unit: KiB
   195                chart_type: area
   196                dimensions:
   197                  - name: committed
   198                  - name: used
   199              - name: logstash.jvm_mem_pools_survivor
   200                description: JVM Pool Survivor Memory
   201                unit: KiB
   202                chart_type: area
   203                dimensions:
   204                  - name: committed
   205                  - name: used
   206              - name: logstash.jvm_mem_pools_old
   207                description: JVM Pool Old Memory
   208                unit: KiB
   209                chart_type: area
   210                dimensions:
   211                  - name: committed
   212                  - name: used
   213              - name: logstash.jvm_gc_collector_count
   214                description: Garbage Collection Count
   215                unit: counts/s
   216                chart_type: line
   217                dimensions:
   218                  - name: eden
   219                  - name: old
   220              - name: logstash.jvm_gc_collector_time
   221                description: Time Spent On Garbage Collection
   222                unit: ms
   223                chart_type: line
   224                dimensions:
   225                  - name: eden
   226                  - name: old
   227              - name: logstash.open_file_descriptors
   228                description: Open File Descriptors
   229                unit: fd
   230                chart_type: line
   231                dimensions:
   232                  - name: open
   233              - name: logstash.event
   234                description: Events Overview
   235                unit: events/s
   236                chart_type: line
   237                dimensions:
   238                  - name: in
   239                  - name: filtered
   240                  - name: out
   241              - name: logstash.event_duration
   242                description: Events Duration
   243                unit: seconds
   244                chart_type: line
   245                dimensions:
   246                  - name: event
   247                  - name: queue
   248              - name: logstash.uptime
   249                description: Uptime
   250                unit: seconds
   251                chart_type: line
   252                dimensions:
   253                  - name: uptime
   254          - name: pipeline
   255            description: These metrics refer to the pipeline.
   256            labels:
   257              - name: pipeline
   258                description: pipeline name
   259            metrics:
   260              - name: logstash.pipeline_event
   261                description: Pipeline Events
   262                unit: events/s
   263                chart_type: line
   264                dimensions:
   265                  - name: in
   266                  - name: filtered
   267                  - name: out
   268              - name: logstash.pipeline_event
   269                description: Pipeline Events Duration
   270                unit: seconds
   271                chart_type: line
   272                dimensions:
   273                  - name: event
   274                  - name: queue