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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-portcheck
     5        plugin_name: go.d.plugin
     6        module_name: portcheck
     7        monitored_instance:
     8          name: TCP Endpoints
     9          link: ""
    10          icon_filename: globe.svg
    11          categories:
    12            - data-collection.synthetic-checks
    13        keywords: []
    14        related_resources:
    15          integrations:
    16            list: []
    17        info_provided_to_referring_integrations:
    18          description: ""
    19        most_popular: false
    20      overview:
    21        data_collection:
    22          metrics_description: |
    23            This collector monitors TCP services availability and response time.
    24          method_description: ""
    25        supported_platforms:
    26          include: []
    27          exclude: []
    28        multi_instance: true
    29        additional_permissions:
    30          description: ""
    31        default_behavior:
    32          auto_detection:
    33            description: ""
    34          limits:
    35            description: ""
    36          performance_impact:
    37            description: ""
    38      setup:
    39        prerequisites:
    40          list: []
    41        configuration:
    42          file:
    43            name: go.d/portcheck.conf
    44          options:
    45            description: |
    46              The following options can be defined globally: update_every, autodetection_retry.
    47            folding:
    48              title: Config options
    49              enabled: true
    50            list:
    51              - name: update_every
    52                description: Data collection frequency.
    53                default_value: 5
    54                required: false
    55              - name: autodetection_retry
    56                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    57                default_value: 0
    58                required: false
    59              - name: host
    60                description: Remote host address in IPv4, IPv6 format, or DNS name.
    61                default_value: ""
    62                required: true
    63              - name: ports
    64                description: Remote host ports. Must be specified in numeric format.
    65                default_value: ""
    66                required: true
    67              - name: timeout
    68                description: HTTP request timeout.
    69                default_value: 2
    70                required: false
    71          examples:
    72            folding:
    73              title: Config
    74              enabled: true
    75            list:
    76              - name: Check SSH and telnet
    77                description: An example configuration.
    78                config: |
    79                  jobs:
    80                    - name: server1
    81                      host: 127.0.0.1
    82                      ports:
    83                        - 22
    84                        - 23
    85              - name: Check webserver with IPv6 address
    86                description: An example configuration.
    87                config: |
    88                  jobs:
    89                    - name: server2
    90                      host: "[2001:DB8::1]"
    91                      ports:
    92                        - 80
    93                        - 8080
    94              - name: Multi-instance
    95                description: |
    96                  > **Note**: When you define multiple jobs, their names must be unique.
    97                  
    98                  Multiple instances.
    99                config: |
   100                  jobs:
   101                    - name: server1
   102                      host: 127.0.0.1
   103                      ports:
   104                        - 22
   105                        - 23
   106                  
   107                    - name: server2
   108                      host: 203.0.113.10
   109                      ports:
   110                        - 22
   111                        - 23
   112      troubleshooting:
   113        problems:
   114          list: []
   115      alerts:
   116        - name: portcheck_service_reachable
   117          metric: portcheck.status
   118          info: "TCP host ${label:host} port ${label:port} liveness status"
   119          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/portcheck.conf
   120        - name: portcheck_connection_timeouts
   121          metric: portcheck.status
   122          info: "percentage of timed-out TCP connections to host ${label:host} port ${label:port} in the last 5 minutes"
   123          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/portcheck.conf
   124        - name: portcheck_connection_fails
   125          metric: portcheck.status
   126          info: "percentage of failed TCP connections to host ${label:host} port ${label:port} in the last 5 minutes"
   127          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/portcheck.conf
   128      metrics:
   129        folding:
   130          title: Metrics
   131          enabled: false
   132        description: ""
   133        availability: []
   134        scopes:
   135          - name: tcp endpoint
   136            description: These metrics refer to the TCP endpoint.
   137            labels:
   138              - name: host
   139                description: host
   140              - name: port
   141                description: port
   142            metrics:
   143              - name: portcheck.status
   144                description: TCP Check Status
   145                unit: boolean
   146                chart_type: line
   147                dimensions:
   148                  - name: success
   149                  - name: failed
   150                  - name: timeout
   151              - name: portcheck.state_duration
   152                description: Current State Duration
   153                unit: seconds
   154                chart_type: line
   155                dimensions:
   156                  - name: time
   157              - name: portcheck.latency
   158                description: TCP Connection Latency
   159                unit: ms
   160                chart_type: line
   161                dimensions:
   162                  - name: time