-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feat/add blackbox probes library #43
base: main
Are you sure you want to change the base?
Changes from 9 commits
7f0fddb
976981b
f6dcd4e
786db08
5519d53
c267fcc
b08a263
ce8e4df
eff4d9a
ae10472
c2c11d3
e6b28c7
001fc6a
bdfdd8d
9bcc2a9
6601b60
3fbdb94
be3701e
693ce7d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -83,9 +83,29 @@ juju config blackbox-exporter-k8s \ | |||||
probes_file='@path/to/probes.yml' | ||||||
``` | ||||||
|
||||||
Note that the `relabel_configs` of each scrape job doesn't need to be specified, and will be | ||||||
Note that the `relabel_configs` of each scrape job doesn't need to be specified, and will be | ||||||
overridden by the charm with the needed labels and the correct Blackbox Exporter url. | ||||||
|
||||||
#### Dynamic Configuration | ||||||
|
||||||
The list of probes and the list of modules for probing can also be changed dynamically from other charms. | ||||||
The charm offers a relation to allow charms to dynamically export endpoints to be probed via Blackbox and custom modules for probing. Those are exported over the blackbox-targets relation using the blackbox_probes interface: | ||||||
|
||||||
```shell | ||||||
requires: | ||||||
blackbox-probes: | ||||||
interface: blackbox_probes | ||||||
``` | ||||||
|
||||||
The probes provided dynamically by a charm are merged with the probes defined in a configuration file, same with the modules which are integrated in the blackbox-config file. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
In order for the charm defined probes to be probed via this charm all that is required is to relate the two charms with: | ||||||
|
||||||
```shell | ||||||
juju relate <charm> blackbox | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We may want to be a bit more prescriptive, to avoid ambiguity:
Suggested change
|
||||||
``` | ||||||
|
||||||
Charms that seek to provide probes for Blackbox, must do so using the provided blackbox_probes charm library. This library ensures that probes and modules defined by a charm are forwarded correctly to Prometheus, and the metrics displayed in the associated Grafana Dashboard. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
## OCI Images | ||||||
This charm is published on Charmhub with blackbox exporter images from | ||||||
the official [quay.io/prometheus/blackbox-exporter]. | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we stick to the official product name?