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

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