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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-tengine
     5        plugin_name: go.d.plugin
     6        module_name: tengine
     7        monitored_instance:
     8          name: Tengine
     9          link: https://tengine.taobao.org/
    10          icon_filename: tengine.jpeg
    11          categories:
    12            - data-collection.web-servers-and-web-proxies
    13        keywords:
    14          - tengine
    15          - web
    16          - webserver
    17        related_resources:
    18          integrations:
    19            list: []
    20        info_provided_to_referring_integrations:
    21          description: ""
    22        most_popular: false
    23      overview:
    24        data_collection:
    25          metrics_description: |
    26            This collector monitors Tengine servers.
    27          method_description: ""
    28        supported_platforms:
    29          include: []
    30          exclude: []
    31        multi_instance: true
    32        additional_permissions:
    33          description: ""
    34        default_behavior:
    35          auto_detection:
    36            description: ""
    37          limits:
    38            description: ""
    39          performance_impact:
    40            description: ""
    41      setup:
    42        prerequisites:
    43          list:
    44            - title: Enable ngx_http_reqstat_module module.
    45              description: |
    46                To enable the module, see the [official documentation](ngx_http_reqstat_module](https://tengine.taobao.org/document/http_reqstat.html).
    47                The default line format is the only supported format.
    48        configuration:
    49          file:
    50            name: go.d/tengine.conf
    51          options:
    52            description: |
    53              The following options can be defined globally: update_every, autodetection_retry.
    54            folding:
    55              title: Config options
    56              enabled: true
    57            list:
    58              - name: update_every
    59                description: Data collection frequency.
    60                default_value: 1
    61                required: false
    62              - name: autodetection_retry
    63                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    64                default_value: 0
    65                required: false
    66              - name: url
    67                description: Server URL.
    68                default_value: http://127.0.0.1/us
    69                required: true
    70              - name: timeout
    71                description: HTTP request timeout.
    72                default_value: 2
    73                required: false
    74              - name: username
    75                description: Username for basic HTTP authentication.
    76                default_value: ""
    77                required: false
    78              - name: password
    79                description: Password for basic HTTP authentication.
    80                default_value: ""
    81                required: false
    82              - name: proxy_url
    83                description: Proxy URL.
    84                default_value: ""
    85                required: false
    86              - name: proxy_username
    87                description: Username for proxy basic HTTP authentication.
    88                default_value: ""
    89                required: false
    90              - name: proxy_password
    91                description: Password for proxy basic HTTP authentication.
    92                default_value: ""
    93                required: false
    94              - name: method
    95                description: HTTP request method.
    96                default_value: GET
    97                required: false
    98              - name: body
    99                description: HTTP request body.
   100                default_value: ""
   101                required: false
   102              - name: headers
   103                description: HTTP request headers.
   104                default_value: ""
   105                required: false
   106              - name: not_follow_redirects
   107                description: Redirect handling policy. Controls whether the client follows redirects.
   108                default_value: false
   109                required: false
   110              - name: tls_skip_verify
   111                description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
   112                default_value: false
   113                required: false
   114              - name: tls_ca
   115                description: Certification authority that the client uses when verifying the server's certificates.
   116                default_value: ""
   117                required: false
   118              - name: tls_cert
   119                description: Client TLS certificate.
   120                default_value: ""
   121                required: false
   122              - name: tls_key
   123                description: Client TLS key.
   124                default_value: ""
   125                required: false
   126          examples:
   127            folding:
   128              title: Config
   129              enabled: true
   130            list:
   131              - name: Basic
   132                description: An example configuration.
   133                config: |
   134                  jobs:
   135                    - name: local
   136                      url: http://127.0.0.1/us
   137              - name: HTTP authentication
   138                description: Local server with basic HTTP authentication.
   139                config: |
   140                  jobs:
   141                    - name: local
   142                      url: http://127.0.0.1/us
   143                      username: foo
   144                      password: bar
   145              - name: HTTPS with self-signed certificate
   146                description: Tengine with enabled HTTPS and self-signed certificate.
   147                config: |
   148                  jobs:
   149                    - name: local
   150                      url: https://127.0.0.1/us
   151                      tls_skip_verify: yes
   152              - name: Multi-instance
   153                description: |
   154                  > **Note**: When you define multiple jobs, their names must be unique.
   155                  
   156                  Local and remote instances.
   157                config: |
   158                  jobs:
   159                   - name: local
   160                     url: http://127.0.0.1/us
   161                  
   162                   - name: remote
   163                     url: http://203.0.113.10/us
   164      troubleshooting:
   165        problems:
   166          list: []
   167      alerts: []
   168      metrics:
   169        folding:
   170          title: Metrics
   171          enabled: false
   172        description: ""
   173        availability: []
   174        scopes:
   175          - name: global
   176            description: These metrics refer to the entire monitored application.
   177            labels: []
   178            metrics:
   179              - name: tengine.bandwidth_total
   180                description: Bandwidth
   181                unit: B/s
   182                chart_type: area
   183                dimensions:
   184                  - name: in
   185                  - name: out
   186              - name: tengine.connections_total
   187                description: Connections
   188                unit: connections/s
   189                chart_type: line
   190                dimensions:
   191                  - name: accepted
   192              - name: tengine.requests_total
   193                description: Requests
   194                unit: requests/s
   195                chart_type: line
   196                dimensions:
   197                  - name: processed
   198              - name: tengine.requests_per_response_code_family_total
   199                description: Requests Per Response Code Family
   200                unit: requests/s
   201                chart_type: stacked
   202                dimensions:
   203                  - name: 2xx
   204                  - name: 3xx
   205                  - name: 4xx
   206                  - name: 5xx
   207                  - name: other
   208              - name: tengine.requests_per_response_code_detailed_total
   209                description: Requests Per Response Code Detailed
   210                unit: requests/s
   211                chart_type: stacked
   212                dimensions:
   213                  - name: "200"
   214                  - name: "206"
   215                  - name: "302"
   216                  - name: "304"
   217                  - name: "403"
   218                  - name: "404"
   219                  - name: "419"
   220                  - name: "499"
   221                  - name: "500"
   222                  - name: "502"
   223                  - name: "503"
   224                  - name: "504"
   225                  - name: "508"
   226                  - name: other
   227              - name: tengine.requests_upstream_total
   228                description: Number Of Requests Calling For Upstream
   229                unit: requests/s
   230                chart_type: line
   231                dimensions:
   232                  - name: requests
   233              - name: tengine.tries_upstream_total
   234                description: Number Of Times Calling For Upstream
   235                unit: calls/s
   236                chart_type: line
   237                dimensions:
   238                  - name: calls
   239              - name: tengine.requests_upstream_per_response_code_family_total
   240                description: Upstream Requests Per Response Code Family
   241                unit: requests/s
   242                chart_type: stacked
   243                dimensions:
   244                  - name: 4xx
   245                  - name: 5xx