mirrors/bird_exporter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Allow regex to extract labels from protocol description (#61)

Browse Source 
Co-authored-by: Roman Klyuev <rklyuev@subspace.com>
This commit is contained in:
sgrade 2022-02-11 07:01:04 +01:00 committed by GitHub
parent ce4adf7c86
commit ab8d64bd15
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 32 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
main.go
View File

@ -30,10 +30,11 @@ var (
enableRPKI = flag.Bool("proto.rpki", true, "Enables metrics for protocol RPKI")
enableBFD = flag.Bool("proto.bfd", true, "Enables metrics for protocol BFD")
// pre bird 2.0
bird6Socket = flag.String("bird.socket6", "/var/run/bird6.ctl", "Socket to communicate with bird6 routing daemon (not compatible with -bird.v2)")
birdEnabled = flag.Bool("bird.ipv4", true, "Get protocols from bird (not compatible with -bird.v2)")
bird6Enabled = flag.Bool("bird.ipv6", true, "Get protocols from bird6 (not compatible with -bird.v2)")
descriptionLabels = flag.Bool("format.description-labels", false, "Add labels from protocol descriptions.")
bird6Socket = flag.String("bird.socket6", "/var/run/bird6.ctl", "Socket to communicate with bird6 routing daemon (not compatible with -bird.v2)")
birdEnabled = flag.Bool("bird.ipv4", true, "Get protocols from bird (not compatible with -bird.v2)")
bird6Enabled = flag.Bool("bird.ipv6", true, "Get protocols from bird6 (not compatible with -bird.v2)")
descriptionLabels = flag.Bool("format.description-labels", false, "Add labels from protocol descriptions.")
descriptionLabelsRegex = flag.String("format.description-labels-regex", "(\\w+)=(\\w+)", "Regex to extract labels from protocol description")
)
func init() {

2
metric_collector.go
View File

@ -61,7 +61,7 @@ func exportersForLegacy(c *client.BirdClient) map[protocol.Proto][]metrics.Metri
}
func exportersForDefault(c *client.BirdClient, descriptionLabels bool) map[protocol.Proto][]metrics.MetricExporter {
l := metrics.NewDefaultLabelStrategy(descriptionLabels)
l := metrics.NewDefaultLabelStrategy(descriptionLabels, *descriptionLabelsRegex)
e := metrics.NewGenericProtocolMetricExporter("bird_protocol", true, l)
return map[protocol.Proto][]metrics.MetricExporter{

48
metrics/default_label_strategy.go
View File

@ -1,19 +1,21 @@
package metrics
import (
"strings"
"regexp"
"github.com/czerwonk/bird_exporter/protocol"
)
// DefaultLabelStrategy defines the labels to add to an metric and its data retrieval method
type DefaultLabelStrategy struct {
descriptionLabels bool
descriptionLabels bool
descriptionLabelsRegex string
}
func NewDefaultLabelStrategy(descriptionLabels bool) *DefaultLabelStrategy {
func NewDefaultLabelStrategy(descriptionLabels bool, descriptionLabelsRegex string) *DefaultLabelStrategy {
return &DefaultLabelStrategy{
descriptionLabels: descriptionLabels,
descriptionLabels: descriptionLabels,
descriptionLabelsRegex: descriptionLabelsRegex,
}
}
@ -21,7 +23,7 @@ func NewDefaultLabelStrategy(descriptionLabels bool) *DefaultLabelStrategy {
func (d *DefaultLabelStrategy) LabelNames(p *protocol.Protocol) []string {
res := []string{"name", "proto", "ip_version", "import_filter", "export_filter"}
if d.descriptionLabels && p.Description != "" {
res = append(res, labelKeysFromDescription(p.Description)...)
res = append(res, labelKeysFromDescription(p.Description, d)...)
}
return res
@ -31,38 +33,40 @@ func (d *DefaultLabelStrategy) LabelNames(p *protocol.Protocol) []string {
func (d *DefaultLabelStrategy) LabelValues(p *protocol.Protocol) []string {
res := []string{p.Name, protoString(p), p.IPVersion, p.ImportFilter, p.ExportFilter}
if d.descriptionLabels && p.Description != "" {
res = append(res, labelValuesFromDescription(p.Description)...)
res = append(res, labelValuesFromDescription(p.Description, d)...)
}
return res
}
func labelKeysFromDescription(desc string) (res []string) {
for _, x := range strings.Split(desc, ",") {
tmp := strings.Split(x, "=")
if len(tmp) != 2 {
continue
}
res = append(res, strings.TrimSpace(tmp[0]))
func labelKeysFromDescription(desc string, d *DefaultLabelStrategy) (res []string) {
reAllStringSubmatch := labelFindAllStringSubmatch(desc, d)
for _, submatch := range reAllStringSubmatch {
res = append(res, submatch[1])
}
return
}
func labelValuesFromDescription(desc string) (res []string) {
for _, x := range strings.Split(desc, ",") {
tmp := strings.Split(x, "=")
if len(tmp) != 2 {
continue
}
res = append(res, strings.TrimSpace(tmp[1]))
func labelValuesFromDescription(desc string, d *DefaultLabelStrategy) (res []string) {
reAllStringSubmatch := labelFindAllStringSubmatch(desc, d)
for _, submatch := range reAllStringSubmatch {
res = append(res, submatch[2])
}
return
}
func labelFindAllStringSubmatch(desc string, d *DefaultLabelStrategy) (result [][]string) {
// Regex pattern captures "key: value" pair from the content.
pattern := regexp.MustCompile(d.descriptionLabelsRegex)
result = pattern.FindAllStringSubmatch(desc, -1)
return
}
func protoString(p *protocol.Protocol) string {
switch p.Proto {
case protocol.BGP: