|
| 1 | +# SSLLabs exporter |
| 2 | +[](https://github.com/anas-aso/ssllabs_exporter/releases/latest) |
| 3 | +[](https://github.com/anas-aso/ssllabs_exporter/actions) |
| 4 | +[](https://goreportcard.com/report/github.com/anas-aso/ssllabs_exporter) |
| 5 | + |
| 6 | +Getting deep analysis of the configuration of any SSL web server on the public Internet à la blackbox_exporter style. |
| 7 | + |
| 8 | +This exporter relays the target server hostname to [SSLLabs API](https://www.ssllabs.com/ssltest), parses the result and export it as Prometheus metrics. It covers retries in case of failures and simplifies the assessment result. |
| 9 | + |
| 10 | +## SSLLabs |
| 11 | +> SSL Labs is a non-commercial research effort, run by [Qualys](https://www.qualys.com/), to better understand how SSL, TLS, and PKI technologies are used in practice. |
| 12 | +
|
| 13 | +source: https://www.ssllabs.com/about/assessment.html |
| 14 | + |
| 15 | +This exporter implements SSLLabs API client that would get you the same results as if you use the [web interface](https://www.ssllabs.com/ssltest/). |
| 16 | + |
| 17 | +## Configuration |
| 18 | +ssllabs_exporter doesn't require any configuration file and the available flags can be found as below : |
| 19 | +```bash |
| 20 | +$ ssllabs_exporter --help |
| 21 | +usage: ssllabs_exporter [<flags>] |
| 22 | + |
| 23 | +Flags: |
| 24 | + --help Show context-sensitive help (also try --help-long and --help-man). |
| 25 | + --listen-address=":19115" The address to listen on for HTTP requests. |
| 26 | + --timeout=300 Assessment timeout in seconds (including retries). |
| 27 | + --log-level=debug Printed logs level. |
| 28 | + --version Show application version. |
| 29 | +``` |
| 30 | + |
| 31 | +## Docker |
| 32 | +The Prometheus exporter is available as a [docker image](https://hub.docker.com/repository/docker/anasaso/ssllabs_exporter) : |
| 33 | +``` |
| 34 | +docker run --rm -it anasaso/ssllabs_exporter:latest --help |
| 35 | +``` |
| 36 | + |
| 37 | +## How To Use it |
| 38 | +Deploy the exporter to your infrastructure. Kubernetes deployment and service Yaml file are provided [here](examples/kubernetes) as an example. |
| 39 | + |
| 40 | +Then adjust Prometheus config to add a new scrape configuration. Examples of how this look like can be found [here](examples/prometheus) (it includes both static config and Kubernetes service discovery to auto check all the cluster ingresses). |
| 41 | + |
| 42 | +Once deployed, Prometheus Targets view page should look like this : |
| 43 | + |
| 44 | + |
| 45 | +The Grafana dashboard below is available [here](examples/grafana_dashboard.json). |
| 46 | + |
0 commit comments