From a68a616fd7df16e01b9ee099ed9d38a56a791ae1 Mon Sep 17 00:00:00 2001 From: Arash Sami Date: Tue, 15 Mar 2022 23:11:17 +0000 Subject: [PATCH] gRPC added to README and Configuration (#894) * added grpc config added grpc config Signed-off-by: rshsm --- CONFIGURATION.md | 13 +++++++++++++ README.md | 4 ++-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/CONFIGURATION.md b/CONFIGURATION.md index 9949ffe..1a0e497 100644 --- a/CONFIGURATION.md +++ b/CONFIGURATION.md @@ -30,6 +30,7 @@ The other placeholders are specified separately. [ tcp: ] [ dns: ] [ icmp: ] + [ grpc: ] ``` @@ -260,6 +261,18 @@ validate_additional_rrs: ``` +### + +```yml + +# The IP protocol of the gRPC probe (ip4, ip6). +[ preferred_ip_protocol: ] + +# Configuration for TLS protocol of gRPC probe. +tls_config: + [ ] +``` + ### ```yml diff --git a/README.md b/README.md index 6658f7e..36008ae 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![Docker Pulls](https://img.shields.io/docker/pulls/prom/blackbox-exporter.svg?maxAge=604800)][hub] The blackbox exporter allows blackbox probing of endpoints over -HTTP, HTTPS, DNS, TCP and ICMP. +HTTP, HTTPS, DNS, TCP, ICMP and gRPC. ## Running this software @@ -69,7 +69,7 @@ To specify which [configuration file](CONFIGURATION.md) to load, use the `--conf Additionally, an [example configuration](example.yml) is also available. -HTTP, HTTPS (via the `http` prober), DNS, TCP socket and ICMP (see permissions section) are currently supported. +HTTP, HTTPS (via the `http` prober), DNS, TCP socket, ICMP and gRPC (see permissions section) are currently supported. Additional modules can be defined to meet your needs. The timeout of each probe is automatically determined from the `scrape_timeout` in the [Prometheus config](https://prometheus.io/docs/operating/configuration/#configuration-file), slightly reduced to allow for network delays. -- 2.25.1