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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-fluentd
     5        plugin_name: go.d.plugin
     6        module_name: fluentd
     7        monitored_instance:
     8          name: Fluentd
     9          link: https://www.fluentd.org/
    10          icon_filename: fluentd.svg
    11          categories:
    12            - data-collection.logs-servers
    13        keywords:
    14          - fluentd
    15          - logging
    16        related_resources:
    17          integrations:
    18            list: []
    19        info_provided_to_referring_integrations:
    20          description: ""
    21        most_popular: false
    22      overview:
    23        data_collection:
    24          metrics_description: |
    25            This collector monitors Fluentd servers.
    26          method_description: ""
    27        supported_platforms:
    28          include: []
    29          exclude: []
    30        multi_instance: true
    31        additional_permissions:
    32          description: ""
    33        default_behavior:
    34          auto_detection:
    35            description: ""
    36          limits:
    37            description: ""
    38          performance_impact:
    39            description: ""
    40      setup:
    41        prerequisites:
    42          list:
    43            - title: Enable monitor agent
    44              description: |
    45                To enable monitor agent, follow the [official documentation](https://docs.fluentd.org/v1.0/articles/monitoring-rest-api).
    46        configuration:
    47          file:
    48            name: go.d/fluentd.conf
    49          options:
    50            description: |
    51              The following options can be defined globally: update_every, autodetection_retry.
    52            folding:
    53              title: Config options
    54              enabled: true
    55            list:
    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://127.0.0.1:24220
    63                required: true
    64              - name: timeout
    65                description: HTTP request timeout.
    66                default_value: 2
    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: no
   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: no
   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                folding:
   127                  enabled: false
   128                description: A basic example configuration.
   129                config: |
   130                  jobs:
   131                    - name: local
   132                      url: http://127.0.0.1:24220
   133              - name: HTTP authentication
   134                description: Basic HTTP authentication.
   135                config: |
   136                  jobs:
   137                    - name: local
   138                      url: http://127.0.0.1:24220
   139                      username: username
   140                      password: password
   141              - name: HTTPS with self-signed certificate
   142                description: Fluentd with enabled HTTPS and self-signed certificate.
   143                config: |
   144                  jobs:
   145                    - name: local
   146                      url: https://127.0.0.1:24220
   147                      tls_skip_verify: yes
   148              - name: Multi-instance
   149                description: |
   150                  > **Note**: When you define multiple jobs, their names must be unique.
   151                  
   152                  Collecting metrics from local and remote instances.
   153                config: |
   154                  jobs:
   155                    - name: local
   156                      url: http://127.0.0.1:24220
   157                  
   158                    - name: remote
   159                      url: http://192.0.2.1:24220
   160      troubleshooting:
   161        problems:
   162          list: []
   163      alerts: []
   164      metrics:
   165        folding:
   166          title: Metrics
   167          enabled: false
   168        description: ""
   169        availability: []
   170        scopes:
   171          - name: global
   172            description: These metrics refer to the entire monitored application.
   173            labels: []
   174            metrics:
   175              - name: fluentd.retry_count
   176                description: Plugin Retry Count
   177                unit: count
   178                chart_type: line
   179                dimensions:
   180                  - name: a dimension per plugin
   181              - name: fluentd.buffer_queue_length
   182                description: Plugin Buffer Queue Length
   183                unit: queue_length
   184                chart_type: line
   185                dimensions:
   186                  - name: a dimension per plugin
   187              - name: fluentd.buffer_total_queued_size
   188                description: Plugin Buffer Total Size
   189                unit: queued_size
   190                chart_type: line
   191                dimensions:
   192                  - name: a dimension per plugin