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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-x509check
     5        plugin_name: go.d.plugin
     6        module_name: x509check
     7        monitored_instance:
     8          name: X.509 certificate
     9          link: ""
    10          categories:
    11            - data-collection.synthetic-checks
    12          icon_filename: lock.svg
    13        keywords:
    14          - x509
    15          - certificate
    16        most_popular: false
    17        info_provided_to_referring_integrations:
    18          description: ""
    19        related_resources:
    20          integrations:
    21            list: []
    22      overview:
    23        data_collection:
    24          metrics_description: ""
    25          method_description: |
    26            This collectors monitors x509 certificates expiration time and revocation status.
    27        default_behavior:
    28          auto_detection:
    29            description: ""
    30          limits:
    31            description: ""
    32          performance_impact:
    33            description: ""
    34        additional_permissions:
    35          description: ""
    36        multi_instance: true
    37        supported_platforms:
    38          include: []
    39          exclude: []
    40      setup:
    41        prerequisites:
    42          list: []
    43        configuration:
    44          file:
    45            name: "go.d/x509check.conf"
    46          options:
    47            description: |
    48              The following options can be defined globally: update_every, autodetection_retry.
    49            folding:
    50              title: Config options
    51              enabled: true
    52            list:
    53              - name: update_every
    54                description: Data collection frequency.
    55                default_value: 1
    56                required: false
    57              - name: autodetection_retry
    58                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    59                default_value: 0
    60                required: false
    61              - name: source
    62                description: "Certificate source. Allowed schemes: https, tcp, tcp4, tcp6, udp, udp4, udp6, file."
    63                default_value: ""
    64                required: false
    65              - name: days_until_expiration_warning
    66                description: Number of days before the alarm status is warning.
    67                default_value: 30
    68                required: false
    69              - name: days_until_expiration_critical
    70                description: Number of days before the alarm status is critical.
    71                default_value: 15
    72                required: false
    73              - name: check_revocation_status
    74                description: Whether to check the revocation status of the certificate.
    75                default_value: false
    76                required: false
    77              - name: timeout
    78                description: SSL connection timeout.
    79                default_value: 2
    80                required: false
    81              - name: tls_skip_verify
    82                description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
    83                default_value: false
    84                required: false
    85              - name: tls_ca
    86                description: Certification authority that the client uses when verifying the server's certificates.
    87                default_value: ""
    88                required: false
    89              - name: tls_cert
    90                description: Client TLS certificate.
    91                default_value: ""
    92                required: false
    93              - name: tls_key
    94                description: Client TLS key.
    95                default_value: ""
    96                required: false
    97          examples:
    98            folding:
    99              title: Config
   100              enabled: true
   101            list:
   102              - name: Website certificate
   103                description: Website certificate.
   104                config: |
   105                  jobs:
   106                    - name: my_site_cert
   107                      source: https://my_site.org:443
   108              - name: Local file certificate
   109                description: Local file certificate.
   110                config: |
   111                  jobs:
   112                    - name: my_file_cert
   113                      source: file:///home/me/cert.pem
   114              - name: SMTP certificate
   115                description: SMTP certificate.
   116                config: |
   117                  jobs:
   118                    - name: my_smtp_cert
   119                      source: smtp://smtp.my_mail.org:587
   120              - name: Multi-instance
   121                description: |
   122                  > **Note**: When you define more than one job, their names must be unique.
   123                  
   124                  Check the expiration status of the multiple websites' certificates.
   125                config: |
   126                  jobs:
   127                    - name: my_site_cert1
   128                      source: https://my_site1.org:443
   129                  
   130                    - name: my_site_cert2
   131                      source: https://my_site1.org:443
   132                  
   133                    - name: my_site_cert3
   134                      source: https://my_site3.org:443
   135      troubleshooting:
   136        problems:
   137          list: []
   138      alerts:
   139        - name: x509check_days_until_expiration
   140          metric: x509check.time_until_expiration
   141          info: time until x509 certificate expires
   142          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/x509check.conf
   143        - name: x509check_revocation_status
   144          metric: x509check.revocation_status
   145          info: "x509 certificate revocation status (0: revoked, 1: valid)"
   146          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/x509check.conf
   147      metrics:
   148        folding:
   149          title: Metrics
   150          enabled: false
   151        description: ""
   152        availability: []
   153        scopes:
   154          - name: source
   155            description: These metrics refer to the configured source.
   156            labels:
   157              - name: source
   158                description: Configured source.
   159            metrics:
   160              - name: x509check.time_until_expiration
   161                description: Time Until Certificate Expiration
   162                unit: seconds
   163                chart_type: line
   164                dimensions:
   165                  - name: expiry
   166              - name: x509check.revocation_status
   167                description: Revocation Status
   168                unit: boolean
   169                chart_type: line
   170                dimensions:
   171                  - name: revoked