Skip to content

Commit 39f0f5d

Browse files
committed
Update observer README
1 parent 13a33ce commit 39f0f5d

1 file changed

Lines changed: 36 additions & 1 deletion

File tree

cmd/boulder-observer/README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ Prometheus.
3131
* [TLS](#tls)
3232
* [Schema](#schema-6)
3333
* [Example](#example-6)
34+
* [CCADB](#ccadb)
35+
* [Schema](#schema-7)
36+
* [Example](#example-7)
3437
* [Metrics](#metrics)
3538
* [Global Metrics](#global-metrics)
3639
* [obs_monitors](#obs_monitors)
@@ -255,6 +258,38 @@ monitors:
255258
response: valid
256259
```
257260

261+
#### CCADB
262+
263+
##### Schema
264+
265+
`allCertificatesCSVURL`: URL of the "V4 All Certificate Information (root and
266+
intermediate) in CCADB (CSV)" report from https://www.ccadb.org/resources.
267+
Default value works.
268+
269+
`certificatePEMsURL`: Base URL of the "All Certificate PEMs" report from
270+
https://www.ccadb.org/resources (i.e. without the "NotBeforeDecade"
271+
parameter). Default value works.
272+
273+
`caOwner`: The value of the "CA Owner" field to filter on in the "All
274+
Certificate Information" report. Default value works for ISRG.
275+
276+
`crlAgeLimit`: Error when a CRL is older than this.
277+
278+
`crlRegexp`: A regexp that matches our CRL URLs. Prevents fetching arbitrary
279+
URLs. At a minimum this should have strict matching on the origin part of the
280+
URL. Default value works.
281+
282+
##### Example
283+
284+
```yaml
285+
monitors:
286+
-
287+
period: 1h
288+
kind: CCADB
289+
settings:
290+
crlAgeLimit: 2h
291+
```
292+
258293
## Metrics
259294

260295
Observer provides the following metrics.
@@ -442,4 +477,4 @@ prometheus --config.file=boulder/test/prometheus/prometheus.yml
442477
### Viewing metrics locally
443478

444479
When developing with a local Prometheus instance you can use this link
445-
to view metrics: [link](http://0.0.0.0:9090)
480+
to view metrics: [link](http://0.0.0.0:9090)

0 commit comments

Comments
 (0)