{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/614", "result": {"data":{"issuesJson":{"id":"ea0652ee-f7a1-531f-8db5-00e0fdd17946","title":"enix/x509-certificate-exporter: Prometheus 导出器用于监控 Kubernetes 集群或独立系统中的 x509 证书过期情况","number":614,"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
Reposenix/x509-certificate-exporter
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

🔏 X.509 Certificate Exporter

\n

\"Build
\n\"Code
\n\"Go
\n\"License
\n\"Brought

\n

A Prometheus exporter for certificates focusing on expiration monitoring, written in Go. Designed to monitor Kubernetes clusters from inside, it can also be used as a standalone exporter.

\n

Get notified before they expire:

\n\n

\"Grafana

\n

Installation

\n

🏃 TL; DR

\n

The Helm chart is the most straightforward way to get a fully-featured exporter running on your cluster.
\nThe chart is also highly-customizable if you wish to. See the chart documentation to learn more.

\n

The provided Grafana Dashboard can also be used to display the exporter's metrics on your Grafana instance.

\n

Using Docker

\n

A docker image is available at enix/x509-certificate-exporter.

\n

Using the pre-built binaries

\n

Every release comes with pre-built binaries for many supported platforms.

\n

Using the source

\n

The project's entry point is ./cmd/x509-certificate-exporter.
\nYou can run & build it as any other Go program:

\n
go build ./cmd/x509-certificate-exporter
\n

Usage

\n

The following metrics are available:

\n\n

Prometheus Alerts

\n

When installation is not performed with Helm, the following Prometheus alerting
\nrules may be deployed manually:

\n
rules:\n    - alert: X509ExporterReadErrors\n        annotations:\n            description: Over the last 15 minutes, this x509-certificate-exporter instance\n                has experienced errors reading certificate files or querying the Kubernetes\n                API. This could be caused by a misconfiguration if triggered when the exporter\n                starts.\n            summary: Increasing read errors for x509-certificate-exporter\n        expr: delta(x509_read_errors[15m]) > 0\n        for: 5m\n        labels:\n            severity: warning\n    - alert: CertificateRenewal\n        annotations:\n            description: Certificate for \"{{ $labels.subject_CN }}\" should be renewed\n                {{if $labels.secret_name }}in Kubernetes secret \"{{ $labels.secret_namespace\n                }}/{{ $labels.secret_name }}\"{{else}}at location \"{{ $labels.filepath }}\"{{end}}\n            summary: Certificate should be renewed\n        expr: ((x509_cert_not_after - time()) / 86400) < 28\n        for: 15m\n        labels:\n            severity: warning\n    - alert: CertificateExpiration\n        annotations:\n            description: Certificate for \"{{ $labels.subject_CN }}\" is about to expire\n                {{if $labels.secret_name }}in Kubernetes secret \"{{ $labels.secret_namespace\n                }}/{{ $labels.secret_name }}\"{{else}}at location \"{{ $labels.filepath }}\"{{end}}\n            summary: Certificate is about to expire\n        expr: ((x509_cert_not_after - time()) / 86400) < 14\n        for: 15m\n        labels:\n            severity: critical\n
\n

Advanced usage

\n

For advanced configuration, see the program's --help:

\n
Usage: x509-certificate-exporter [-hv] [-b value] [--debug] [-d value] [--exclude-label value] [--exclude-namespace value] [--expose-per-cert-error-metrics] [--expose-relative-metrics] [-f value] [--include-label value] [--include-namespace value] [--kubeconfig path] [-k value] [-l value] [--max-cache-duration value] [--profile] [-s value] [--trim-path-components value] [--watch-kube-secrets] [--web.config.file value] [--web.systemd-socket] [parameters ...]\n -b, --listen-address=value\n                address on which to bind and expose metrics [:9793]\n     --debug    enable debug mode\n -d, --watch-dir=value\n                watch one or more directory which contains x509 certificate\n                files (not recursive)\n     --exclude-label=value\n                removes the kube secrets with the given label (or label\n                value if specified) from the watch list (applied after\n                --include-label)\n     --exclude-namespace=value\n                removes the given kube namespace from the watch list\n                (applied after --include-namespace)\n     --expose-per-cert-error-metrics\n                expose additionnal error metric for each certificate\n                indicating wether it has failure(s)\n     --expose-relative-metrics\n                expose additionnal metrics with relative durations instead\n                of absolute timestamps\n -f, --watch-file=value\n                watch one or more x509 certificate file\n -h, --help     show this help message and exit\n     --include-label=value\n                add the kube secrets with the given label (or label value if\n                specified) to the watch list (when used, all secrets are\n                excluded by default)\n     --include-namespace=value\n                add the given kube namespace to the watch list (when used,\n                all namespaces are excluded by default)\n     --kubeconfig=path\n                Path to the kubeconfig file to use for requests. Takes\n                precedence over the KUBECONFIG environment variable, and\n                default path (~/.kube/config).\n -k, --watch-kubeconf=value\n                watch one or more Kubernetes client configuration (kind\n                Config) which contains embedded x509 certificates or PEM\n                file paths\n -l, --expose-labels=value\n     --max-cache-duration=value\n                maximum cache duration for kube secrets. cache is per\n                namespace and randomized to avoid massive requests.\n     --profile  optionally enable a pprof server to monitor cpu and memory\n                usage at runtime\n -s, --secret-type=value\n                one or more kubernetes secret type & key to watch (e.g.\n                \"kubernetes.io/tls:tls.crt\"\n     --trim-path-components=value\n                remove <n> leading component(s) from path(s) in label(s)\n -v, --version  show version info and exit\n     --watch-kube-secrets\n                scrape kubernetes secrets and monitor them\n     --web.config.file=value\n                [EXPERIMENTAL] path to configuration file that can enable\n                TLS or authentication\n     --web.systemd-socket\n                use systemd socket activation listeners instead of port\n                listeners (Linux only)\n
\n

Development

\n

Some snippets to get started with development and testing:

\n
# Run server, watch test input files, only listen on localhost to\n# avoid firewall popup dialogs\ngo run ./cmd/x509-certificate-exporter --debug -b localhost:9793 -d test/\n\n# Once the server is running, you can check the exported metrics\ncurl -Ss localhost:9793/metrics | grep \"^x509_cert_not_after\"\n\n# Automated tests do not need a Kubernetes cluster, since we use a fake clientset that simulate a cluster (k8s.io/client-go/kubernetes/fake)\ngo test -v ./internal\nkind delete cluster\n\n# Docker build (does not run tests)\ndocker buildx build .
\n

FAQ

\n

Why are you using the not after timestamp rather than a remaining number of seconds?

\n

For two reasons.

\n

First, Prometheus tends to do better storage consumption when a value stays identical over checks.

\n

Then, it is better to compute the remaining time through a prometheus query as some latency (seconds) can exist
\nbetween this exporter check and your alert or query being run.

\n

Here is an example:

\n
x509_cert_not_after - time()\n
\n

When collecting metrics from tools like Datadog that does not have timestamp functions,
\nthe exporter can be run with the --expose-relative-metrics flag in order to add the following optional metrics:

\n\n

How to ensure it keeps working over time?

\n

Changes in paths or deleted files may silently break the ability to watch critical certificates.

\n

Because it's never convenient to alert on disapearing metrics, the exporter will publish on x509_read_errors how many
\npaths could not be read. It will also count Kubernetes API responses failures, but won't count deleted secrets.

\n

A basic alert would be:

\n
x509_read_errors > 0\n
","updatedAt":"2025-05-22T01:53:34Z","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":"enix","color":"1a51ba"}}]},"comments":{"edges":[]}}},"pageContext":{"number":614,"previous":{"title":"chubin/wttr.in: 执行 curl wttr.in 在终端中显示天气预报","number":613},"next":{"title":"duolatech/xapimanager: 专业实用的开源接口管理平台，为程序开发者提供一个灵活，方便，快捷的 API 管理工具，让 API 管理变的更加清晰、明朗。","number":615}}}, "staticQueryHashes": ["151096407","2861350382"]}