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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-lighttpd
     5        plugin_name: go.d.plugin
     6        module_name: lighttpd
     7        monitored_instance:
     8          name: Lighttpd
     9          link: https://www.lighttpd.net/
    10          icon_filename: lighttpd.svg
    11          categories:
    12            - data-collection.web-servers-and-web-proxies
    13        keywords:
    14          - webserver
    15        related_resources:
    16          integrations:
    17            list:
    18              - plugin_name: go.d.plugin
    19                module_name: weblog
    20              - plugin_name: go.d.plugin
    21                module_name: httpcheck
    22              - plugin_name: apps.plugin
    23                module_name: apps
    24        info_provided_to_referring_integrations:
    25          description: ""
    26        most_popular: true
    27      overview:
    28        data_collection:
    29          metrics_description: |
    30            This collector monitors the activity and performance of Lighttpd servers, and collects metrics such as the number of connections, workers, requests and more.
    31          method_description: |
    32            It sends HTTP requests to the Lighttpd location [server-status](https://redmine.lighttpd.net/projects/lighttpd/wiki/Mod_status), 
    33            which is a built-in location that provides metrics about the Lighttpd server.
    34        supported_platforms:
    35          include: []
    36          exclude: []
    37        multi_instance: true
    38        additional_permissions:
    39          description: ""
    40        default_behavior:
    41          auto_detection:
    42            description: |
    43              By default, it detects Lighttpd instances running on localhost that are listening on port 80.
    44              On startup, it tries to collect metrics from:
    45              
    46              - http://localhost/server-status?auto
    47              - http://127.0.0.1/server-status?auto
    48          limits:
    49            description: ""
    50          performance_impact:
    51            description: ""
    52      setup:
    53        prerequisites:
    54          list:
    55            - title: Enable Lighttpd status support
    56              description: |
    57                To enable status support, see the [official documentation](https://redmine.lighttpd.net/projects/lighttpd/wiki/Mod_status).
    58        configuration:
    59          file:
    60            name: go.d/lighttpd.conf
    61          options:
    62            description: |
    63              The following options can be defined globally: update_every, autodetection_retry.
    64            folding:
    65              title: Config options
    66              enabled: true
    67            list:
    68              - name: update_every
    69                description: Data collection frequency.
    70                default_value: 1
    71                required: false
    72              - name: autodetection_retry
    73                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    74                default_value: 0
    75                required: false
    76              - name: url
    77                description: Server URL.
    78                default_value: http://127.0.0.1/server-status?auto
    79                required: true
    80              - name: timeout
    81                description: HTTP request timeout.
    82                default_value: 1
    83                required: false
    84              - name: username
    85                description: Username for basic HTTP authentication.
    86                default_value: ""
    87                required: false
    88              - name: password
    89                description: Password for basic HTTP authentication.
    90                default_value: ""
    91                required: false
    92              - name: proxy_url
    93                description: Proxy URL.
    94                default_value: ""
    95                required: false
    96              - name: proxy_username
    97                description: Username for proxy basic HTTP authentication.
    98                default_value: ""
    99                required: false
   100              - name: proxy_password
   101                description: Password for proxy basic HTTP authentication.
   102                default_value: ""
   103                required: false
   104              - name: method
   105                description: HTTP request method.
   106                default_value: "GET"
   107                required: false
   108              - name: body
   109                description: HTTP request body.
   110                default_value: ""
   111                required: false
   112              - name: headers
   113                description: HTTP request headers.
   114                default_value: ""
   115                required: false
   116              - name: not_follow_redirects
   117                description: Redirect handling policy. Controls whether the client follows redirects.
   118                default_value: no
   119                required: false
   120              - name: tls_skip_verify
   121                description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
   122                default_value: no
   123                required: false
   124              - name: tls_ca
   125                description: Certification authority that the client uses when verifying the server's certificates.
   126                default_value: ""
   127                required: false
   128              - name: tls_cert
   129                description: Client TLS certificate.
   130                default_value: ""
   131                required: false
   132              - name: tls_key
   133                description: Client TLS key.
   134                default_value: ""
   135                required: false
   136          examples:
   137            folding:
   138              title: Config
   139              enabled: true
   140            list:
   141              - name: Basic
   142                folding:
   143                  enabled: false
   144                description: A basic example configuration.
   145                config: |
   146                  jobs:
   147                    - name: local
   148                      url: http://127.0.0.1/server-status?auto
   149              - name: HTTP authentication
   150                description: Basic HTTP authentication.
   151                config: |
   152                  jobs:
   153                    - name: local
   154                      url: http://127.0.0.1/server-status?auto
   155                      username: username
   156                      password: password
   157              - name: HTTPS with self-signed certificate
   158                description: Lighttpd with enabled HTTPS and self-signed certificate.
   159                config: |
   160                  jobs:
   161                    - name: local
   162                      url: https://127.0.0.1/server-status?auto
   163                      tls_skip_verify: yes
   164              - name: Multi-instance
   165                description: |
   166                  > **Note**: When you define multiple jobs, their names must be unique.
   167                  
   168                  Collecting metrics from local and remote instances.
   169                config: |
   170                  jobs:
   171                    - name: local
   172                      url: http://127.0.0.1/server-status?auto
   173                  
   174                    - name: remote
   175                      url: http://192.0.2.1/server-status?auto
   176      troubleshooting:
   177        problems:
   178          list: []
   179      alerts: []
   180      metrics:
   181        folding:
   182          title: Metrics
   183          enabled: false
   184        description: ""
   185        availability: []
   186        scopes:
   187          - name: global
   188            description: These metrics refer to the entire monitored application.
   189            labels: []
   190            metrics:
   191              - name: lighttpd.requests
   192                description: Requests
   193                unit: requests/s
   194                chart_type: line
   195                dimensions:
   196                  - name: requests
   197              - name: lighttpd.net
   198                description: Bandwidth
   199                unit: kilobits/s
   200                chart_type: area
   201                dimensions:
   202                  - name: sent
   203              - name: lighttpd.workers
   204                description: Servers
   205                unit: servers
   206                chart_type: stacked
   207                dimensions:
   208                  - name: idle
   209                  - name: busy
   210              - name: lighttpd.scoreboard
   211                description: ScoreBoard
   212                unit: connections
   213                chart_type: line
   214                dimensions:
   215                  - name: waiting
   216                  - name: open
   217                  - name: close
   218                  - name: hard_error
   219                  - name: keepalive
   220                  - name: read
   221                  - name: read_post
   222                  - name: write
   223                  - name: handle_request
   224                  - name: request_start
   225                  - name: request_end
   226              - name: lighttpd.uptime
   227                description: Uptime
   228                unit: seconds
   229                chart_type: line
   230                dimensions:
   231                  - name: uptime