From 301f514d9884d60f17fd85a83199a118e4236f3f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Birger=20J=2E=20Nord=C3=B8lum?= Date: Tue, 22 Nov 2022 16:57:39 +0100 Subject: [PATCH] docs(readme): grammer & whitespace (#78) Just some minor cleaning. --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 481f00c..9c31951 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# bird_exporter +# bird_exporter [![Go Report Card](https://goreportcard.com/badge/github.com/czerwonk/bird_exporter)](https://goreportcard.com/report/github.com/czerwonk/bird_exporter) -Metric exporter for bird routing daemon to use with Prometheus +Metric exporter for bird routing daemon to use with Prometheus. ## Remarks -Since bird_exporter uses the bird unix sockets, bird has to be installed on the same maschine as bird_exporter. Also the user executing bird_exporter must have permission to access the bird socket files. +Since bird_exporter uses the bird unix sockets, bird has to be installed on the same machine as bird_exporter. Also the user executing bird_exporter must have permission to access the bird socket files. ### Bird configuration To get meaningful uptime information bird has to be configured this way: @@ -13,14 +13,14 @@ timeformat protocol iso long; ``` ## Important information for users of bird 2.0+ -Version 2.0 of bird routing daemon does support IPv4 and IPv6 in one single daemon now. -For further information see [here](https://gitlab.labs.nic.cz/labs/bird/wikis/transition-notes-to-bird-2). -Since version 1.1 bird_exporter can be used with bird 2.0+ using the `-bird.v2` parameter. -When using this parameter bird_exporter queries the same bird socket for IPv4 and IPv6. +Version 2.0 of bird routing daemon does support IPv4 and IPv6 in one single daemon now. +For further information see [here](https://gitlab.labs.nic.cz/labs/bird/wikis/transition-notes-to-bird-2). +Since version 1.1 bird_exporter can be used with bird 2.0+ using the `-bird.v2` parameter. +When using this parameter bird_exporter queries the same bird socket for IPv4 and IPv6. In this mode the IP protocol is determined by the channel information and parameters `-bird.ipv4`, `-bird.ipv6` and `-bird.socket6` are ignored. ## Metric formats -In version 1.0 a new metric format was introduced. +In version 1.0 a new metric format was introduced. To prevent a breaking change the new format is optional and can be enabled by using the ```-format.new``` flag. The new format handles protocols more generic and allows a better query structure. Also it adheres more to the metric naming best practices. @@ -45,7 +45,7 @@ bird_ospfv3_running{name="ospf1"} 1 ``` ### Default Port -In version 0.7.1 the default port changed to 9324 since port 9200 is the default port of elasticsearch. The new port is now registered in the default port allocation list (https://github.com/prometheus/prometheus/wiki/Default-port-allocations) +In version 0.7.1 the default port changed to 9324 since port 9200 is the default port of Elasticsearch. The new port is now registered in the default port allocation list (https://github.com/prometheus/prometheus/wiki/Default-port-allocations) ### Sockets In version 0.8 communication to bird changed to sockets. The default socket path is ```/var/run/bird.ctl``` (for bird) and ```/var/run/bird6.ctl``` (for bird6). In case you are using different paths in your installation, the socket path can be specified by usind the ```-bird.socket``` (for bird) and ```-bird.socket6``` (for bird6) flag.