https://github.com/awcodify/ssl_chain_exporter

https://github.com/awcodify/ssl_chain_exporter

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/awcodify/ssl_chain_exporter
• Owner: awcodify
• Created: 2022-04-06T17:46:04.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-09T10:41:32.000Z (about 2 years ago)
• Last Synced: 2024-10-21T22:57:08.405Z (2 months ago)
• Language: Go
• Size: 42 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# SSL Chain Exporter for Prometheus

![GitHub release](https://img.shields.io/github/release/awcodify/ssl_chain_exporter.svg?style=for-the-badge)

![GitHub Downloads](https://img.shields.io/github/downloads/awcodify/ssl_chain_exporter/total.svg?style=for-the-badge)

Help on flags:


  -domains string

        Which domain will be collected. Comma separated.

  -domains-from-csv string

        Which domain will be collected from csv file. Header required.

  -web.listen-address string

        Address to listen on for web interface. (default ":9102")

  -web.metrics-path string

        Path under which to expose metrics. (default "/metrics")



Build your binary

```

go mod tidy

CGO_ENABLED=0 go build

```

Check your domains by runnning

```

./ssl_chain_exporter --domains=github.com,gist.github.com

./ssl_chain_exporter --domains-from-csv=list-domains.csv

```

## Collectors

SSL Chain metrics:

| Metric                                | Description                                                                       | Type    | Label                 |

|---------------------------------------|-----------------------------------------------------------------------------------|---------|-----------------------|

| ssl_chain_up                          | Is the provided domain can be reached or not.                                     | Gauge   | domain                |

| ssl_chain_expiry                      | The date after which a peer certificate expires. Expressed as a Unix Epoch Time.  | Gauge   | domain, chain, issuer |

| ssl_chain_exporter_scrape_error_total | Number of errors while scraping SSL chain.                                        | Counter | domain                |

Sample:

```

# HELP ssl_chain_collector_build_info A metric with a constant '1' value labeled by version, revision, branch, and goversion from which ssl_chain_collector was built.

# TYPE ssl_chain_collector_build_info gauge

ssl_chain_collector_build_info{branch="",goversion="go1.17.3",revision="",version=""} 1

# HELP ssl_chain_expiry expiration of certification

# TYPE ssl_chain_expiry gauge

ssl_chain_expiry{chain="intermediate",domain="google.co.id",issuer="CN=GTS Root R1,O=Google Trust Services LLC,C=US"} 1.822262442e+09

ssl_chain_expiry{chain="root",domain="google.co.id",issuer="CN=GlobalSign Root CA,OU=Root CA,O=GlobalSign nv-sa,C=BE"} 1.832630442e+09

ssl_chain_expiry{chain="server",domain="google.co.id",issuer="CN=GTS CA 1C3,O=Google Trust Services LLC,C=US"} 1.654776441e+09

# HELP ssl_chain_exporter_scrape_error_total Number of errors while scraping SSL chain.

# TYPE ssl_chain_exporter_scrape_error_total counter

ssl_chain_exporter_scrape_error_total{domain="asdasd.as"} 3

ssl_chain_exporter_scrape_error_total{domain="hasldklaskdlaslda.asa"} 3

# HELP ssl_chain_up Could the server be reached

# TYPE ssl_chain_up gauge

ssl_chain_up{domain="asdasd.as"} 0

ssl_chain_up{domain="google.co.id"} 1

ssl_chain_up{domain="hasldklaskdlaslda.asa"} 0

```

## Debugging

1. if /metrics cannot be access check your domain name list