{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/538", "result": {"data":{"issuesJson":{"id":"9415485e-c1c9-5176-8ccc-de8bdc6b3952","title":"ribbybibby/ssl_exporter: SSL 证书指标的 Prometheus Exporter","number":538,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Reposribbybibby/ssl_exporter
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

SSL Certificate Exporter

\n

Exports metrics for certificates collected from various sources:

\n\n

The metrics are labelled with fields from the certificate, which allows for
\ninformational dashboards and flexible alert routing.

\n

Building

\n
make\n./ssl_exporter <flags>\n
\n

Similarly to the blackbox_exporter, visiting
\nhttp://localhost:9219/probe?target=example.com:443
\nwill return certificate metrics for example.com. The ssl_probe_success
\nmetric indicates if the probe has been successful.

\n

Docker

\n
docker run -p 9219:9219 ribbybibby/ssl-exporter:latest <flags>\n
\n

Release process

\n\n

Usage

\n
usage: ssl_exporter [<flags>]\n\nFlags:\n  -h, --help                     Show context-sensitive help (also try --help-long and\n                                 --help-man).\n      --web.listen-address=\":9219\"\n                                 Address to listen on for web interface and telemetry.\n      --web.metrics-path=\"/metrics\"\n                                 Path under which to expose metrics\n      --web.probe-path=\"/probe\"  Path under which to expose the probe endpoint\n      --config.file=\"\"           SSL exporter configuration file\n      --log.level=\"info\"         Only log messages with the given severity or above. Valid\n                                 levels: [debug, info, warn, error, fatal]\n      --log.format=\"logger:stderr\"\n                                 Set the log target and format. Example:\n                                 \"logger:syslog?appname=bob&local=7\" or\n                                 \"logger:stdout?json=true\"\n      --version                  Show application version.\n
\n

Metrics

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MetricMeaningLabelsProbers
ssl_cert_not_afterThe date after which a peer certificate expires. Expressed as a Unix Epoch Time.serial_no, issuer_cn, cn, dnsnames, ips, emails, outcp, https
ssl_cert_not_beforeThe date before which a peer certificate is not valid. Expressed as a Unix Epoch Time.serial_no, issuer_cn, cn, dnsnames, ips, emails, outcp, https
ssl_file_cert_not_afterThe date after which a certificate found by the file prober expires. Expressed as a Unix Epoch Time.file, serial_no, issuer_cn, cn, dnsnames, ips, emails, oufile
ssl_file_cert_not_beforeThe date before which a certificate found by the file prober is not valid. Expressed as a Unix Epoch Time.file, serial_no, issuer_cn, cn, dnsnames, ips, emails, oufile
ssl_kubernetes_cert_not_afterThe date after which a certificate found by the kubernetes prober expires. Expressed as a Unix Epoch Time.namespace, secret, key, serial_no, issuer_cn, cn, dnsnames, ips, emails, oukubernetes
ssl_kubernetes_cert_not_beforeThe date before which a certificate found by the kubernetes prober is not valid. Expressed as a Unix Epoch Time.namespace, secret, key, serial_no, issuer_cn, cn, dnsnames, ips, emails, oukubernetes
ssl_kubeconfig_cert_not_afterThe date after which a certificate found by the kubeconfig prober expires. Expressed as a Unix Epoch Time.kubeconfig, name, type, serial_no, issuer_cn, cn, dnsnames, ips, emails, oukubeconfig
ssl_kubeconfig_cert_not_beforeThe date before which a certificate found by the kubeconfig prober is not valid. Expressed as a Unix Epoch Time.kubeconfig, name, type, serial_no, issuer_cn, cn, dnsnames, ips, emails, oukubeconfig
ssl_ocsp_response_next_updateThe nextUpdate value in the OCSP response. Expressed as a Unix Epoch Timetcp, https
ssl_ocsp_response_produced_atThe producedAt value in the OCSP response. Expressed as a Unix Epoch Timetcp, https
ssl_ocsp_response_revoked_atThe revocationTime value in the OCSP response. Expressed as a Unix Epoch Timetcp, https
ssl_ocsp_response_statusThe status in the OCSP response. 0=Good 1=Revoked 2=Unknowntcp, https
ssl_ocsp_response_stapledDoes the connection state contain a stapled OCSP response? Boolean.tcp, https
ssl_ocsp_response_this_updateThe thisUpdate value in the OCSP response. Expressed as a Unix Epoch Timetcp, https
ssl_probe_successWas the probe successful? Boolean.all
ssl_proberThe prober used by the exporter to connect to the target. Boolean.proberall
ssl_tls_version_infoThe TLS version used. Always 1.versiontcp, https
ssl_verified_cert_not_afterThe date after which a certificate in the verified chain expires. Expressed as a Unix Epoch Time.chain_no, serial_no, issuer_cn, cn, dnsnames, ips, emails, outcp, https
ssl_verified_cert_not_beforeThe date before which a certificate in the verified chain is not valid. Expressed as a Unix Epoch Time.chain_no, serial_no, issuer_cn, cn, dnsnames, ips, emails, outcp, https
\n

Configuration

\n

TCP

\n

Just like with the blackbox_exporter, you should pass the targets to a single
\ninstance of the exporter in a scrape config with a clever bit of relabelling.
\nThis allows you to leverage service discovery and keeps configuration
\ncentralised to your Prometheus config.

\n
scrape_configs:\n  - job_name: \"ssl\"\n    metrics_path: /probe\n    static_configs:\n      - targets:\n          - example.com:443\n          - prometheus.io:443\n    relabel_configs:\n      - source_labels: [__address__]\n        target_label: __param_target\n      - source_labels: [__param_target]\n        target_label: instance\n      - target_label: __address__\n        replacement: 127.0.0.1:9219 # SSL exporter.
\n

HTTPS

\n

By default the exporter will make a TCP connection to the target. This will be
\nsuitable for most cases but if you want to take advantage of http proxying you
\ncan use a HTTPS client by setting the https module parameter:

\n
scrape_configs:\n  - job_name: \"ssl\"\n    metrics_path: /probe\n    params:\n      module: [\"https\"] # <-----\n    static_configs:\n      - targets:\n          - example.com:443\n          - prometheus.io:443\n    relabel_configs:\n      - source_labels: [__address__]\n        target_label: __param_target\n      - source_labels: [__param_target]\n        target_label: instance\n      - target_label: __address__\n        replacement: 127.0.0.1:9219
\n

This will use proxy servers discovered by the environment variables HTTP_PROXY,
\nHTTPS_PROXY and ALL_PROXY. Or, you can set the https.proxy_url option in the module
\nconfiguration.

\n

The latter takes precedence.

\n

File

\n

The file prober exports ssl_file_cert_not_after and
\nssl_file_cert_not_before for PEM encoded certificates found in local files.

\n

Files local to the exporter can be scraped by providing them as the target
\nparameter:

\n
curl \"localhost:9219/probe?module=file&target=/etc/ssl/cert.pem\"\n
\n

The target parameter supports globbing (as provided by the
\ndoublestar package),
\nwhich allows you to capture multiple files at once:

\n
curl \"localhost:9219/probe?module=file&target=/etc/ssl/**/*.pem\"\n
\n

One specific usage of this prober could be to run the exporter as a DaemonSet in
\nKubernetes and then scrape each instance to check the expiry of certificates on
\neach node:

\n
scrape_configs:\n  - job_name: \"ssl-kubernetes-file\"\n    metrics_path: /probe\n    params:\n      module: [\"file\"]\n      target: [\"/etc/kubernetes/**/*.crt\"]\n    kubernetes_sd_configs:\n      - role: node\n    relabel_configs:\n      - source_labels: [__address__]\n        regex: ^(.*):(.*)$\n        target_label: __address__\n        replacement: ${1}:9219
\n

HTTP File

\n

The http_file prober exports ssl_cert_not_after and
\nssl_cert_not_before for PEM encoded certificates found at the
\nspecified URL.

\n
curl \"localhost:9219/probe?module=http_file&target=https://www.paypalobjects.com/marketing/web/logos/paypal_com.pem\"\n
\n

Here's a sample Prometheus configuration:

\n
scrape_configs:\n  - job_name: 'ssl-http-files'\n    metrics_path: /probe\n    params:\n      module: [\"http_file\"]\n    static_configs:\n      - targets:\n        - 'https://www.paypalobjects.com/marketing/web/logos/paypal_com.pem'\n        - 'https://d3frv9g52qce38.cloudfront.net/amazondefault/amazon_web_services_inc_2024.pem'\n    relabel_configs:\n      - source_labels: [__address__]\n        target_label: __param_target\n      - source_labels: [__param_target]\n        target_label: instance\n      - target_label: __address__\n        replacement: 127.0.0.1:9219
\n

For proxying to the target resource, this prober will use proxy servers
\ndiscovered in the environment variables HTTP_PROXY, HTTPS_PROXY and
\nALL_PROXY. Or, you can set the http_file.proxy_url option in the module
\nconfiguration.

\n

The latter takes precedence.

\n

Kubernetes

\n

The kubernetes prober exports ssl_kubernetes_cert_not_after and
\nssl_kubernetes_cert_not_before for PEM encoded certificates found in secrets
\nof type kubernetes.io/tls.

\n

Provide the namespace and name of the secret in the form <namespace>/<name> as
\nthe target:

\n
curl \"localhost:9219/probe?module=kubernetes&target=kube-system/secret-name\"\n
\n

Both the namespace and name portions of the target support glob matching (as provided by the
\ndoublestar package):

\n
curl \"localhost:9219/probe?module=kubernetes&target=kube-system/*\"\n\n
\n
curl \"localhost:9219/probe?module=kubernetes&target=*/*\"\n\n
\n

The exporter retrieves credentials and context configuration from the following
\nsources in the following order:

\n\n
- job_name: \"ssl-kubernetes\"\n  metrics_path: /probe\n  params:\n    module: [\"kubernetes\"]\n  static_configs:\n   - targets:\n      - \"test-namespace/nginx-cert\"\n  relabel_configs:\n   - source_labels: [ __address__ ]\n     target_label: __param_target\n   - source_labels: [ __param_target ]\n     target_label: instance\n   - target_label: __address__\n     replacement: 127.0.0.1:9219
\n

Kubeconfig

\n

The kubeconfig prober exports ssl_kubeconfig_cert_not_after and
\nssl_kubeconfig_cert_not_before for PEM encoded certificates found in the specified kubeconfig file.

\n

Kubeconfigs local to the exporter can be scraped by providing them as the target
\nparameter:

\n
curl \"localhost:9219/probe?module=kubeconfig&target=/etc/kubernetes/admin.conf\"\n
\n

One specific usage of this prober could be to run the exporter as a DaemonSet in
\nKubernetes and then scrape each instance to check the expiry of certificates on
\neach node:

\n
scrape_configs:\n  - job_name: \"ssl-kubernetes-kubeconfig\"\n    metrics_path: /probe\n    params:\n      module: [\"kubeconfig\"]\n      target: [\"/etc/kubernetes/admin.conf\"]\n    kubernetes_sd_configs:\n      - role: node\n    relabel_configs:\n      - source_labels: [__address__]\n        regex: ^(.*):(.*)$\n        target_label: __address__\n        replacement: ${1}:9219
\n

Configuration file

\n

You can provide further module configuration by providing the path to a
\nconfiguration file with --config.file. The file is written in yaml format,
\ndefined by the schema below.

\n
# The default module to use. If omitted, then the module must be provided by the\n# 'module' query parameter\ndefault_module: <string>\n\n# Module configuration\nmodules: [<module>]\n
\n

<module>

\n
# The type of probe (https, tcp, file, kubernetes, kubeconfig)\nprober: <prober_string>\n\n# The probe target. If set, then the 'target' query parameter is ignored.\n# If omitted, then the 'target' query parameter is required.\ntarget: <string>\n\n# How long the probe will wait before giving up.\n[ timeout: <duration> ]\n\n# Configuration for TLS\n[ tls_config: <tls_config> ]\n\n# The specific probe configuration\n[ https: <https_probe> ]\n[ tcp: <tcp_probe> ]\n[ kubernetes: <kubernetes_probe> ]\n[ http_file: <http_file_probe> ]\n
\n

<tls_config>

\n
# Disable target certificate validation.\n[ insecure_skip_verify: <boolean> | default = false ]\n\n# Configure TLS renegotiation support.\n# Valid options: never, once, freely\n[ renegotiation: <string> | default = never ]\n\n# The CA cert to use for the targets.\n[ ca_file: <filename> ]\n\n# The client cert file for the targets.\n[ cert_file: <filename> ]\n\n# The client key file for the targets.\n[ key_file: <filename> ]\n\n# Used to verify the hostname for the targets.\n[ server_name: <string> ]\n
\n

<https_probe>

\n
# HTTP proxy server to use to connect to the targets.\n[ proxy_url: <string> ]\n
\n

<tcp_probe>

\n
# Use the STARTTLS command before starting TLS for those protocols that support it (smtp, ftp, imap, pop3, postgres)\n[ starttls: <string> ]\n
\n

<kubernetes_probe>

\n
# The path of a kubeconfig file to configure the probe\n[ kubeconfig: <string> ]\n
\n

<http_file_probe>

\n
# HTTP proxy server to use to connect to the targets.\n[ proxy_url: <string> ]\n
\n

Example Queries

\n

Certificates that expire within 7 days:

\n
ssl_cert_not_after - time() < 86400 * 7\n
\n

Wildcard certificates that are expiring:

\n
ssl_cert_not_after{cn=~\"\\*.*\"} - time() < 86400 * 7\n
\n

Certificates that expire within 7 days in the verified chain that expires
\nlatest:

\n
ssl_verified_cert_not_after{chain_no=\"0\"} - time() < 86400 * 7\n
\n

Number of certificates presented by the server:

\n
count(ssl_cert_not_after) by (instance)\n
\n

Identify failed probes:

\n
ssl_probe_success == 0\n
\n

Peer Certificates vs Verified Chain Certificates

\n

Metrics are exported for the NotAfter and NotBefore fields for peer
\ncertificates as well as for the verified chain that is
\nconstructed by the client.

\n

The former only includes the certificates that are served explicitly by the
\ntarget, while the latter can contain multiple chains of trust that are
\nconstructed from root certificates held by the client to the target's server
\ncertificate.

\n

This has important implications when monitoring certificate expiry.

\n

For instance, it may be the case that ssl_cert_not_after reports that the root
\ncertificate served by the target is expiring soon even though clients can form
\nanother, much longer lived, chain of trust using another valid root certificate
\nheld locally. In this case, you may want to use ssl_verified_cert_not_after to
\nalert on expiry instead, as this will contain the chain that the client actually
\nconstructs:

\n
ssl_verified_cert_not_after{chain_no=\"0\"} - time() < 86400 * 7\n
\n

Each chain is numbered by the exporter in reverse order of expiry, so that
\nchain_no=\"0\" is the chain that will expire the latest. Therefore the query
\nabove will only alert when the chain of trust between the exporter and the
\ntarget is truly nearing expiry.

\n

It's very important to note that a query of this kind only represents the chain
\nof trust between the exporter and the target. Genuine clients may hold different
\nroot certs than the exporter and therefore have different verified chains of
\ntrust.

\n

Grafana

\n

You can find a simple dashboard here that tracks
\ncertificate expiration dates and target connection errors.

","updatedAt":"2025-05-22T01:49:27Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"Prometheus-Exporter","color":"367acb"}},{"node":{"name":"ribbybibby","color":"d189f2"}}]},"comments":{"edges":[]}}},"pageContext":{"number":538,"previous":{"title":"yinheli/sshw: 一款实现了类似 jumpserver 登陆界面的终端 SSH 工具","number":537},"next":{"title":"StackStorm/st2: StackStorm (俗称\"运维领域的 IFTTT\") 是一个事件驱动的自动化工具，用于自动修复、应对突发事件、故障排查、软件部署等多种运维任务，特别适用于 DevOps 和 SREs。","number":539}}}, "staticQueryHashes": ["151096407","2861350382"]}