From baeb9c804ebb83b48c2499ef29c80eab915bbf02 Mon Sep 17 00:00:00 2001 From: Daniel Czerwonk Date: Thu, 30 Nov 2017 22:35:14 +0100 Subject: [PATCH 01/12] refactoring --- .gitignore | 1 + bgp/exporter.go | 26 -------------------------- device/exporter.go | 26 -------------------------- direct/exporter.go | 26 -------------------------- kernel/exporter.go | 26 -------------------------- main.go | 2 +- metric_collector.go | 15 +++++---------- protocol/exporter.go | 30 ++++++++++++++++++++++++++++++ static/exporter.go | 26 -------------------------- 9 files changed, 37 insertions(+), 141 deletions(-) delete mode 100644 bgp/exporter.go delete mode 100644 device/exporter.go delete mode 100644 direct/exporter.go delete mode 100644 kernel/exporter.go create mode 100644 protocol/exporter.go delete mode 100644 static/exporter.go diff --git a/.gitignore b/.gitignore index c38fa4e..5cfd391 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .idea *.iml +bird_exporter diff --git a/bgp/exporter.go b/bgp/exporter.go deleted file mode 100644 index d88a005..0000000 --- a/bgp/exporter.go +++ /dev/null @@ -1,26 +0,0 @@ -package bgp - -import ( - "github.com/czerwonk/bird_exporter/protocol" - "github.com/prometheus/client_golang/prometheus" -) - -var exporter map[int]*protocol.GenericProtocolMetricExporter - -type BgpMetricExporter struct { -} - -func init() { - exporter = make(map[int]*protocol.GenericProtocolMetricExporter) - exporter[4] = protocol.NewGenericProtocolMetricExporter("bgp4_session") - exporter[6] = protocol.NewGenericProtocolMetricExporter("bgp6_session") -} - -func (*BgpMetricExporter) Describe(ch chan<- *prometheus.Desc) { - exporter[4].Describe(ch) - exporter[6].Describe(ch) -} - -func (*BgpMetricExporter) Export(p *protocol.Protocol, ch chan<- prometheus.Metric) { - exporter[p.IpVersion].Export(p, ch) -} diff --git a/device/exporter.go b/device/exporter.go deleted file mode 100644 index 7306e74..0000000 --- a/device/exporter.go +++ /dev/null @@ -1,26 +0,0 @@ -package device - -import ( - "github.com/czerwonk/bird_exporter/protocol" - "github.com/prometheus/client_golang/prometheus" -) - -var exporter map[int]*protocol.GenericProtocolMetricExporter - -type DeviceMetricExporter struct { -} - -func init() { - exporter = make(map[int]*protocol.GenericProtocolMetricExporter) - exporter[4] = protocol.NewGenericProtocolMetricExporter("device4") - exporter[6] = protocol.NewGenericProtocolMetricExporter("device6") -} - -func (m *DeviceMetricExporter) Describe(ch chan<- *prometheus.Desc) { - exporter[4].Describe(ch) - exporter[6].Describe(ch) -} - -func (m *DeviceMetricExporter) Export(p *protocol.Protocol, ch chan<- prometheus.Metric) { - exporter[p.IpVersion].Export(p, ch) -} diff --git a/direct/exporter.go b/direct/exporter.go deleted file mode 100644 index d3051f0..0000000 --- a/direct/exporter.go +++ /dev/null @@ -1,26 +0,0 @@ -package direct - -import ( - "github.com/czerwonk/bird_exporter/protocol" - "github.com/prometheus/client_golang/prometheus" -) - -var exporter map[int]*protocol.GenericProtocolMetricExporter - -type DirectMetricExporter struct { -} - -func init() { - exporter = make(map[int]*protocol.GenericProtocolMetricExporter) - exporter[4] = protocol.NewGenericProtocolMetricExporter("direct4") - exporter[6] = protocol.NewGenericProtocolMetricExporter("direct6") -} - -func (*DirectMetricExporter) Describe(ch chan<- *prometheus.Desc) { - exporter[4].Describe(ch) - exporter[6].Describe(ch) -} - -func (*DirectMetricExporter) Export(p *protocol.Protocol, ch chan<- prometheus.Metric) { - exporter[p.IpVersion].Export(p, ch) -} diff --git a/kernel/exporter.go b/kernel/exporter.go deleted file mode 100644 index f2023d1..0000000 --- a/kernel/exporter.go +++ /dev/null @@ -1,26 +0,0 @@ -package kernel - -import ( - "github.com/czerwonk/bird_exporter/protocol" - "github.com/prometheus/client_golang/prometheus" -) - -var exporter map[int]*protocol.GenericProtocolMetricExporter - -type KernelMetricExporter struct { -} - -func init() { - exporter = make(map[int]*protocol.GenericProtocolMetricExporter) - exporter[4] = protocol.NewGenericProtocolMetricExporter("kernel4") - exporter[6] = protocol.NewGenericProtocolMetricExporter("kernel6") -} - -func (*KernelMetricExporter) Describe(ch chan<- *prometheus.Desc) { - exporter[4].Describe(ch) - exporter[6].Describe(ch) -} - -func (*KernelMetricExporter) Export(p *protocol.Protocol, ch chan<- prometheus.Metric) { - exporter[p.IpVersion].Export(p, ch) -} diff --git a/main.go b/main.go index 405188d..baf576e 100644 --- a/main.go +++ b/main.go @@ -11,7 +11,7 @@ import ( "github.com/prometheus/common/log" ) -const version string = "0.9.0" +const version string = "1.0.0" var ( showVersion = flag.Bool("version", false, "Print version information.") diff --git a/metric_collector.go b/metric_collector.go index 2d7da8d..2ceab19 100644 --- a/metric_collector.go +++ b/metric_collector.go @@ -1,13 +1,8 @@ package main import ( - "github.com/czerwonk/bird_exporter/bgp" - "github.com/czerwonk/bird_exporter/device" - "github.com/czerwonk/bird_exporter/direct" - "github.com/czerwonk/bird_exporter/kernel" "github.com/czerwonk/bird_exporter/ospf" "github.com/czerwonk/bird_exporter/protocol" - "github.com/czerwonk/bird_exporter/static" "github.com/prometheus/client_golang/prometheus" ) @@ -23,12 +18,12 @@ type MetricCollector struct { func NewMetricCollectorForProtocols(protocols []*protocol.Protocol) *MetricCollector { e := map[int]MetricExporter{ - protocol.BGP: &bgp.BgpMetricExporter{}, - protocol.Device: &device.DeviceMetricExporter{}, - protocol.Direct: &direct.DirectMetricExporter{}, - protocol.Kernel: &kernel.KernelMetricExporter{}, + protocol.BGP: protocol.NewMetricExporter("bgp4_session", "bgp6_session"), + protocol.Device: protocol.NewMetricExporter("device4", "device6"), + protocol.Direct: protocol.NewMetricExporter("direct4", "direct6"), + protocol.Kernel: protocol.NewMetricExporter("kernel4", "kernel6"), protocol.OSPF: &ospf.OspfMetricExporter{}, - protocol.Static: &static.StaticMetricExporter{}, + protocol.Static: protocol.NewMetricExporter("static4", "static6"), } return &MetricCollector{protocols: protocols, exporters: e} diff --git a/protocol/exporter.go b/protocol/exporter.go new file mode 100644 index 0000000..213bb6d --- /dev/null +++ b/protocol/exporter.go @@ -0,0 +1,30 @@ +package protocol + +import ( + "github.com/prometheus/client_golang/prometheus" +) + +type ProtocolMetricExporter struct { + ipv4Exporter *GenericProtocolMetricExporter + ipv6Exporter *GenericProtocolMetricExporter +} + +func NewMetricExporter(prefixIpv4, prefixIpv6 string) *ProtocolMetricExporter { + return &ProtocolMetricExporter{ + ipv4Exporter: NewGenericProtocolMetricExporter(prefixIpv4), + ipv6Exporter: NewGenericProtocolMetricExporter(prefixIpv6), + } +} + +func (e *ProtocolMetricExporter) Describe(ch chan<- *prometheus.Desc) { + e.ipv4Exporter.Describe(ch) + e.ipv6Exporter.Describe(ch) +} + +func (e *ProtocolMetricExporter) Export(p *Protocol, ch chan<- prometheus.Metric) { + if p.IpVersion == 4 { + e.ipv4Exporter.Export(p, ch) + } else { + e.ipv6Exporter.Export(p, ch) + } +} diff --git a/static/exporter.go b/static/exporter.go deleted file mode 100644 index 952ff32..0000000 --- a/static/exporter.go +++ /dev/null @@ -1,26 +0,0 @@ -package static - -import ( - "github.com/czerwonk/bird_exporter/protocol" - "github.com/prometheus/client_golang/prometheus" -) - -var exporter map[int]*protocol.GenericProtocolMetricExporter - -type StaticMetricExporter struct { -} - -func init() { - exporter = make(map[int]*protocol.GenericProtocolMetricExporter) - exporter[4] = protocol.NewGenericProtocolMetricExporter("static4") - exporter[6] = protocol.NewGenericProtocolMetricExporter("static6") -} - -func (m *StaticMetricExporter) Describe(ch chan<- *prometheus.Desc) { - exporter[4].Describe(ch) - exporter[6].Describe(ch) -} - -func (m *StaticMetricExporter) Export(p *protocol.Protocol, ch chan<- prometheus.Metric) { - exporter[p.IpVersion].Export(p, ch) -} From c8354f281e7aa19ef630359b65684f7279eb55ac Mon Sep 17 00:00:00 2001 From: Daniel Czerwonk Date: Thu, 30 Nov 2017 23:35:31 +0100 Subject: [PATCH 02/12] new encapsulation with label strategies --- bird_client.go | 3 +- metric_collector.go | 14 +++-- metrics/default_label_strategy.go | 36 ++++++++++++ {protocol => metrics}/exporter.go | 11 ++-- {protocol => metrics}/generic_exporter.go | 69 ++++++++++++----------- metrics/label_strategy.go | 8 +++ metrics/legacy_label_strategy.go | 14 +++++ ospf/exporter.go | 20 +++---- parser.go => parser/parser.go | 5 +- parser_test.go | 23 ++++---- 10 files changed, 136 insertions(+), 67 deletions(-) create mode 100644 metrics/default_label_strategy.go rename {protocol => metrics}/exporter.go (52%) rename {protocol => metrics}/generic_exporter.go (76%) create mode 100644 metrics/label_strategy.go create mode 100644 metrics/legacy_label_strategy.go rename parser.go => parser/parser.go (96%) diff --git a/bird_client.go b/bird_client.go index e3ae22a..540860d 100644 --- a/bird_client.go +++ b/bird_client.go @@ -3,6 +3,7 @@ package main import ( "github.com/czerwonk/bird_exporter/protocol" "github.com/czerwonk/bird_socket" + "github.com/czerwonk/bird_exporter/parser" ) func getProtocols() ([]*protocol.Protocol, error) { @@ -33,5 +34,5 @@ func getProtocolsFromBird(socketPath string, ipVersion int) ([]*protocol.Protoco return nil, err } - return parseOutput(b, ipVersion), nil + return parser.Parse(b, ipVersion), nil } diff --git a/metric_collector.go b/metric_collector.go index 2ceab19..43e8770 100644 --- a/metric_collector.go +++ b/metric_collector.go @@ -1,6 +1,7 @@ package main import ( + "github.com/czerwonk/bird_exporter/metrics" "github.com/czerwonk/bird_exporter/ospf" "github.com/czerwonk/bird_exporter/protocol" "github.com/prometheus/client_golang/prometheus" @@ -17,13 +18,14 @@ type MetricCollector struct { } func NewMetricCollectorForProtocols(protocols []*protocol.Protocol) *MetricCollector { + l := &metrics.LegacyLabelStrategy{} e := map[int]MetricExporter{ - protocol.BGP: protocol.NewMetricExporter("bgp4_session", "bgp6_session"), - protocol.Device: protocol.NewMetricExporter("device4", "device6"), - protocol.Direct: protocol.NewMetricExporter("direct4", "direct6"), - protocol.Kernel: protocol.NewMetricExporter("kernel4", "kernel6"), - protocol.OSPF: &ospf.OspfMetricExporter{}, - protocol.Static: protocol.NewMetricExporter("static4", "static6"), + protocol.BGP: metrics.NewMetricExporter("bgp4_session", "bgp6_session", l), + protocol.Device: metrics.NewMetricExporter("device4", "device6", l), + protocol.Direct: metrics.NewMetricExporter("direct4", "direct6", l), + protocol.Kernel: metrics.NewMetricExporter("kernel4", "kernel6", l), + protocol.OSPF: ospf.NewExporter(l), + protocol.Static: metrics.NewMetricExporter("static4", "static6", l), } return &MetricCollector{protocols: protocols, exporters: e} diff --git a/metrics/default_label_strategy.go b/metrics/default_label_strategy.go new file mode 100644 index 0000000..f57047b --- /dev/null +++ b/metrics/default_label_strategy.go @@ -0,0 +1,36 @@ +package metrics + +import "github.com/czerwonk/bird_exporter/protocol" + +type DefaultLabelStrategy struct { +} + +func (*DefaultLabelStrategy) labelNames() []string { + return []string{"name", "proto", "ip_version"} +} + +func (*DefaultLabelStrategy) labelValues(p *protocol.Protocol) []string { + return []string{p.Name, protoString(p), string(p.IpVersion)} +} +func protoString(p *protocol.Protocol) string { + switch p.Proto { + case protocol.BGP: + return "BGP" + case protocol.OSPF: + if p.IpVersion == 4 { + return "OSPF" + } else { + return "OSPFv3" + } + case protocol.Static: + return "Static" + case protocol.Kernel: + return "Kernel" + case protocol.Device: + return "Device" + case protocol.Direct: + return "Direct" + } + + return "" +} diff --git a/protocol/exporter.go b/metrics/exporter.go similarity index 52% rename from protocol/exporter.go rename to metrics/exporter.go index 213bb6d..8ea3017 100644 --- a/protocol/exporter.go +++ b/metrics/exporter.go @@ -1,7 +1,8 @@ -package protocol +package metrics import ( "github.com/prometheus/client_golang/prometheus" + "github.com/czerwonk/bird_exporter/protocol" ) type ProtocolMetricExporter struct { @@ -9,10 +10,10 @@ type ProtocolMetricExporter struct { ipv6Exporter *GenericProtocolMetricExporter } -func NewMetricExporter(prefixIpv4, prefixIpv6 string) *ProtocolMetricExporter { +func NewMetricExporter(prefixIpv4, prefixIpv6 string, labelStrategy LabelStrategy) *ProtocolMetricExporter { return &ProtocolMetricExporter{ - ipv4Exporter: NewGenericProtocolMetricExporter(prefixIpv4), - ipv6Exporter: NewGenericProtocolMetricExporter(prefixIpv6), + ipv4Exporter: NewGenericProtocolMetricExporter(prefixIpv4, labelStrategy), + ipv6Exporter: NewGenericProtocolMetricExporter(prefixIpv6, labelStrategy), } } @@ -21,7 +22,7 @@ func (e *ProtocolMetricExporter) Describe(ch chan<- *prometheus.Desc) { e.ipv6Exporter.Describe(ch) } -func (e *ProtocolMetricExporter) Export(p *Protocol, ch chan<- prometheus.Metric) { +func (e *ProtocolMetricExporter) Export(p *protocol.Protocol, ch chan<- prometheus.Metric) { if p.IpVersion == 4 { e.ipv4Exporter.Export(p, ch) } else { diff --git a/protocol/generic_exporter.go b/metrics/generic_exporter.go similarity index 76% rename from protocol/generic_exporter.go rename to metrics/generic_exporter.go index 4aa652b..0019bdf 100644 --- a/protocol/generic_exporter.go +++ b/metrics/generic_exporter.go @@ -1,8 +1,12 @@ -package protocol +package metrics -import "github.com/prometheus/client_golang/prometheus" +import ( + "github.com/czerwonk/bird_exporter/protocol" + "github.com/prometheus/client_golang/prometheus" +) type GenericProtocolMetricExporter struct { + labelStrategy LabelStrategy upDesc *prometheus.Desc importCountDesc *prometheus.Desc exportCountDesc *prometheus.Desc @@ -31,15 +35,15 @@ type GenericProtocolMetricExporter struct { withdrawsExportAcceptCountDesc *prometheus.Desc } -func NewGenericProtocolMetricExporter(prefix string) *GenericProtocolMetricExporter { - m := &GenericProtocolMetricExporter{} +func NewGenericProtocolMetricExporter(prefix string, labelStrategy LabelStrategy) *GenericProtocolMetricExporter { + m := &GenericProtocolMetricExporter{labelStrategy: labelStrategy} m.initDesc(prefix) return m } func (m *GenericProtocolMetricExporter) initDesc(prefix string) { - labels := []string{"name"} + labels := m.labelStrategy.labelNames() m.upDesc = prometheus.NewDesc(prefix+"_up", "Protocol is up", labels, nil) m.importCountDesc = prometheus.NewDesc(prefix+"_prefix_count_import", "Number of imported routes", labels, nil) m.exportCountDesc = prometheus.NewDesc(prefix+"_prefix_count_export", "Number of exported routes", labels, nil) @@ -97,31 +101,32 @@ func (m *GenericProtocolMetricExporter) Describe(ch chan<- *prometheus.Desc) { ch <- m.withdrawsExportReceiveCountDesc } -func (m *GenericProtocolMetricExporter) Export(protocol *Protocol, ch chan<- prometheus.Metric) { - ch <- prometheus.MustNewConstMetric(m.upDesc, prometheus.GaugeValue, float64(protocol.Up), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.importCountDesc, prometheus.GaugeValue, float64(protocol.Imported), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.exportCountDesc, prometheus.GaugeValue, float64(protocol.Exported), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.filterCountDesc, prometheus.GaugeValue, float64(protocol.Filtered), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.preferredCountDesc, prometheus.GaugeValue, float64(protocol.Preferred), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.uptimeDesc, prometheus.GaugeValue, float64(protocol.Uptime), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.updatesImportReceiveCountDesc, prometheus.GaugeValue, float64(protocol.ImportUpdates.Received), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.updatesImportRejectCountDesc, prometheus.GaugeValue, float64(protocol.ImportUpdates.Rejected), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.updatesImportFilterCountDesc, prometheus.GaugeValue, float64(protocol.ImportUpdates.Filtered), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.updatesImportAcceptCountDesc, prometheus.GaugeValue, float64(protocol.ImportUpdates.Accepted), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.updatesImportIgnoreCountDesc, prometheus.GaugeValue, float64(protocol.ImportUpdates.Ignored), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.updatesExportReceiveCountDesc, prometheus.GaugeValue, float64(protocol.ExportUpdates.Received), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.updatesExportRejectCountDesc, prometheus.GaugeValue, float64(protocol.ExportUpdates.Rejected), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.updatesExportFilterCountDesc, prometheus.GaugeValue, float64(protocol.ExportUpdates.Filtered), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.updatesExportAcceptCountDesc, prometheus.GaugeValue, float64(protocol.ExportUpdates.Accepted), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.updatesExportIgnoreCountDesc, prometheus.GaugeValue, float64(protocol.ExportUpdates.Ignored), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.withdrawsImportReceiveCountDesc, prometheus.GaugeValue, float64(protocol.ImportWithdraws.Received), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.withdrawsImportRejectCountDesc, prometheus.GaugeValue, float64(protocol.ImportWithdraws.Rejected), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.withdrawsImportFilterCountDesc, prometheus.GaugeValue, float64(protocol.ImportWithdraws.Filtered), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.withdrawsImportAcceptCountDesc, prometheus.GaugeValue, float64(protocol.ImportWithdraws.Accepted), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.withdrawsImportIgnoreCountDesc, prometheus.GaugeValue, float64(protocol.ImportWithdraws.Ignored), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.withdrawsExportReceiveCountDesc, prometheus.GaugeValue, float64(protocol.ExportWithdraws.Received), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.withdrawsExportRejectCountDesc, prometheus.GaugeValue, float64(protocol.ExportWithdraws.Rejected), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.withdrawsExportFilterCountDesc, prometheus.GaugeValue, float64(protocol.ExportWithdraws.Filtered), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.withdrawsExportAcceptCountDesc, prometheus.GaugeValue, float64(protocol.ExportWithdraws.Accepted), protocol.Name) - ch <- prometheus.MustNewConstMetric(m.withdrawsExportIgnoreCountDesc, prometheus.GaugeValue, float64(protocol.ExportWithdraws.Ignored), protocol.Name) +func (m *GenericProtocolMetricExporter) Export(p *protocol.Protocol, ch chan<- prometheus.Metric) { + l := m.labelStrategy.labelValues(p) + ch <- prometheus.MustNewConstMetric(m.upDesc, prometheus.GaugeValue, float64(p.Up), l...) + ch <- prometheus.MustNewConstMetric(m.importCountDesc, prometheus.GaugeValue, float64(p.Imported), l...) + ch <- prometheus.MustNewConstMetric(m.exportCountDesc, prometheus.GaugeValue, float64(p.Exported), l...) + ch <- prometheus.MustNewConstMetric(m.filterCountDesc, prometheus.GaugeValue, float64(p.Filtered), l...) + ch <- prometheus.MustNewConstMetric(m.preferredCountDesc, prometheus.GaugeValue, float64(p.Preferred), l...) + ch <- prometheus.MustNewConstMetric(m.uptimeDesc, prometheus.GaugeValue, float64(p.Uptime), l...) + ch <- prometheus.MustNewConstMetric(m.updatesImportReceiveCountDesc, prometheus.GaugeValue, float64(p.ImportUpdates.Received), l...) + ch <- prometheus.MustNewConstMetric(m.updatesImportRejectCountDesc, prometheus.GaugeValue, float64(p.ImportUpdates.Rejected), l...) + ch <- prometheus.MustNewConstMetric(m.updatesImportFilterCountDesc, prometheus.GaugeValue, float64(p.ImportUpdates.Filtered), l...) + ch <- prometheus.MustNewConstMetric(m.updatesImportAcceptCountDesc, prometheus.GaugeValue, float64(p.ImportUpdates.Accepted), l...) + ch <- prometheus.MustNewConstMetric(m.updatesImportIgnoreCountDesc, prometheus.GaugeValue, float64(p.ImportUpdates.Ignored), l...) + ch <- prometheus.MustNewConstMetric(m.updatesExportReceiveCountDesc, prometheus.GaugeValue, float64(p.ExportUpdates.Received), l...) + ch <- prometheus.MustNewConstMetric(m.updatesExportRejectCountDesc, prometheus.GaugeValue, float64(p.ExportUpdates.Rejected), l...) + ch <- prometheus.MustNewConstMetric(m.updatesExportFilterCountDesc, prometheus.GaugeValue, float64(p.ExportUpdates.Filtered), l...) + ch <- prometheus.MustNewConstMetric(m.updatesExportAcceptCountDesc, prometheus.GaugeValue, float64(p.ExportUpdates.Accepted), l...) + ch <- prometheus.MustNewConstMetric(m.updatesExportIgnoreCountDesc, prometheus.GaugeValue, float64(p.ExportUpdates.Ignored), l...) + ch <- prometheus.MustNewConstMetric(m.withdrawsImportReceiveCountDesc, prometheus.GaugeValue, float64(p.ImportWithdraws.Received), l...) + ch <- prometheus.MustNewConstMetric(m.withdrawsImportRejectCountDesc, prometheus.GaugeValue, float64(p.ImportWithdraws.Rejected), l...) + ch <- prometheus.MustNewConstMetric(m.withdrawsImportFilterCountDesc, prometheus.GaugeValue, float64(p.ImportWithdraws.Filtered), l...) + ch <- prometheus.MustNewConstMetric(m.withdrawsImportAcceptCountDesc, prometheus.GaugeValue, float64(p.ImportWithdraws.Accepted), l...) + ch <- prometheus.MustNewConstMetric(m.withdrawsImportIgnoreCountDesc, prometheus.GaugeValue, float64(p.ImportWithdraws.Ignored), l...) + ch <- prometheus.MustNewConstMetric(m.withdrawsExportReceiveCountDesc, prometheus.GaugeValue, float64(p.ExportWithdraws.Received), l...) + ch <- prometheus.MustNewConstMetric(m.withdrawsExportRejectCountDesc, prometheus.GaugeValue, float64(p.ExportWithdraws.Rejected), l...) + ch <- prometheus.MustNewConstMetric(m.withdrawsExportFilterCountDesc, prometheus.GaugeValue, float64(p.ExportWithdraws.Filtered), l...) + ch <- prometheus.MustNewConstMetric(m.withdrawsExportAcceptCountDesc, prometheus.GaugeValue, float64(p.ExportWithdraws.Accepted), l...) + ch <- prometheus.MustNewConstMetric(m.withdrawsExportIgnoreCountDesc, prometheus.GaugeValue, float64(p.ExportWithdraws.Ignored), l...) } diff --git a/metrics/label_strategy.go b/metrics/label_strategy.go new file mode 100644 index 0000000..5187244 --- /dev/null +++ b/metrics/label_strategy.go @@ -0,0 +1,8 @@ +package metrics + +import "github.com/czerwonk/bird_exporter/protocol" + +type LabelStrategy interface { + labelNames() []string + labelValues(p *protocol.Protocol) []string +} diff --git a/metrics/legacy_label_strategy.go b/metrics/legacy_label_strategy.go new file mode 100644 index 0000000..1fe4af5 --- /dev/null +++ b/metrics/legacy_label_strategy.go @@ -0,0 +1,14 @@ +package metrics + +import "github.com/czerwonk/bird_exporter/protocol" + +type LegacyLabelStrategy struct { +} + +func (*LegacyLabelStrategy) labelNames() []string { + return []string{"name"} +} + +func (*LegacyLabelStrategy) labelValues(p *protocol.Protocol) []string { + return []string{p.Name} +} diff --git a/ospf/exporter.go b/ospf/exporter.go index 000972b..63029db 100644 --- a/ospf/exporter.go +++ b/ospf/exporter.go @@ -1,30 +1,31 @@ package ospf import ( + "github.com/czerwonk/bird_exporter/metrics" "github.com/czerwonk/bird_exporter/protocol" "github.com/prometheus/client_golang/prometheus" ) var descriptions map[int]*desc -var exporter map[int]*protocol.GenericProtocolMetricExporter type desc struct { runningDesc *prometheus.Desc } type OspfMetricExporter struct { + genericExporter *metrics.ProtocolMetricExporter } func init() { - exporter = make(map[int]*protocol.GenericProtocolMetricExporter) - exporter[4] = protocol.NewGenericProtocolMetricExporter("ospf") - exporter[6] = protocol.NewGenericProtocolMetricExporter("ospfv3") - descriptions = make(map[int]*desc) descriptions[4] = getDesc("ospf") descriptions[6] = getDesc("ospfv3") } +func NewExporter(labelStrategy metrics.LabelStrategy) *OspfMetricExporter { + return &OspfMetricExporter{genericExporter: metrics.NewMetricExporter("ospf", "ospfv3", labelStrategy)} +} + func getDesc(prefix string) *desc { labels := []string{"name"} @@ -34,14 +35,13 @@ func getDesc(prefix string) *desc { return d } -func (*OspfMetricExporter) Describe(ch chan<- *prometheus.Desc) { - exporter[4].Describe(ch) - exporter[6].Describe(ch) +func (m *OspfMetricExporter) Describe(ch chan<- *prometheus.Desc) { + m.genericExporter.Describe(ch) ch <- descriptions[4].runningDesc ch <- descriptions[6].runningDesc } -func (*OspfMetricExporter) Export(p *protocol.Protocol, ch chan<- prometheus.Metric) { - exporter[p.IpVersion].Export(p, ch) +func (m *OspfMetricExporter) Export(p *protocol.Protocol, ch chan<- prometheus.Metric) { + m.genericExporter.Export(p, ch) ch <- prometheus.MustNewConstMetric(descriptions[p.IpVersion].runningDesc, prometheus.GaugeValue, p.Attributes["running"], p.Name) } diff --git a/parser.go b/parser/parser.go similarity index 96% rename from parser.go rename to parser/parser.go index 59d4987..3aa550d 100644 --- a/parser.go +++ b/parser/parser.go @@ -1,4 +1,4 @@ -package main +package parser import ( "bufio" @@ -27,7 +27,8 @@ func init() { routeChangeRegex = regexp.MustCompile("(Import|Export) (updates|withdraws):\\s+(\\d+|---)\\s+(\\d+|---)\\s+(\\d+|---)\\s+(\\d+|---)\\s+(\\d+|---)\\s*") } -func parseOutput(data []byte, ipVersion int) []*protocol.Protocol { +// Parser parses bird output and returns protocol.Protocol structs +func Parse(data []byte, ipVersion int) []*protocol.Protocol { protocols := make([]*protocol.Protocol, 0) reader := bytes.NewReader(data) diff --git a/parser_test.go b/parser_test.go index 44e344a..9704872 100644 --- a/parser_test.go +++ b/parser_test.go @@ -5,11 +5,12 @@ import ( "github.com/czerwonk/bird_exporter/protocol" "github.com/czerwonk/testutils/assert" + "github.com/czerwonk/bird_exporter/parser" ) func TestEstablishedBgpOldTimeFormat(t *testing.T) { data := "foo BGP master up 1481973060 Established\ntest\nbar\n Routes: 12 imported, 1 filtered, 34 exported, 100 preferred\nxxx" - p := parseOutput([]byte(data), 4) + p := parser.Parse([]byte(data), 4) assert.IntEqual("protocols", 1, len(p), t) x := p[0] @@ -25,7 +26,7 @@ func TestEstablishedBgpOldTimeFormat(t *testing.T) { func TestEstablishedBgpCurrentTimeFormat(t *testing.T) { data := "foo BGP master up 00:01:00 Established\ntest\nbar\n Routes: 12 imported, 1 filtered, 34 exported, 100 preferred\nxxx" - p := parseOutput([]byte(data), 4) + p := parser.Parse([]byte(data), 4) assert.IntEqual("protocols", 1, len(p), t) x := p[0] @@ -42,7 +43,7 @@ func TestEstablishedBgpCurrentTimeFormat(t *testing.T) { func TestIpv6Bgp(t *testing.T) { data := "foo BGP master up 00:01:00 Established\ntest\nbar\n Routes: 12 imported, 1 filtered, 34 exported, 100 preferred\nxxx" - p := parseOutput([]byte(data), 6) + p := parser.Parse([]byte(data), 6) assert.IntEqual("protocols", 1, len(p), t) x := p[0] @@ -51,7 +52,7 @@ func TestIpv6Bgp(t *testing.T) { func TestActiveBgp(t *testing.T) { data := "bar BGP master start 2016-01-01 Active\ntest\nbar" - p := parseOutput([]byte(data), 4) + p := parser.Parse([]byte(data), 4) assert.IntEqual("protocols", 1, len(p), t) x := p[0] @@ -66,7 +67,7 @@ func TestActiveBgp(t *testing.T) { func Test2BgpSessions(t *testing.T) { data := "foo BGP master up 00:01:00 Established\ntest\n Routes: 12 imported, 1 filtered, 34 exported, 100 preferred\nbar BGP master start 2016-01-01 Active\nxxx" - p := parseOutput([]byte(data), 4) + p := parser.Parse([]byte(data), 4) assert.IntEqual("protocols", 2, len(p), t) } @@ -78,7 +79,7 @@ func TestUpdateAndWithdrawCounts(t *testing.T) { " Import withdraws: 6 7 8 9 10\n" + " Export updates: 11 12 13 14 15\n" + " Export withdraws: 16 17 18 19 ---" - p := parseOutput([]byte(data), 4) + p := parser.Parse([]byte(data), 4) x := p[0] assert.Int64Equal("import updates received", 1, x.ImportUpdates.Received, t) @@ -105,7 +106,7 @@ func TestUpdateAndWithdrawCounts(t *testing.T) { func TestOspfOldTimeFormat(t *testing.T) { data := "ospf1 OSPF master up 1481973060 Running\ntest\nbar\n Routes: 12 imported, 34 exported, 100 preferred\nxxx" - p := parseOutput([]byte(data), 4) + p := parser.Parse([]byte(data), 4) assert.IntEqual("protocols", 1, len(p), t) x := p[0] @@ -120,7 +121,7 @@ func TestOspfOldTimeFormat(t *testing.T) { func TestOspfCurrentTimeFormat(t *testing.T) { data := "ospf1 OSPF master up 00:01:00 Running\ntest\nbar\n Routes: 12 imported, 34 exported, 100 preferred\nxxx" - p := parseOutput([]byte(data), 4) + p := parser.Parse([]byte(data), 4) assert.IntEqual("protocols", 1, len(p), t) x := p[0] @@ -136,7 +137,7 @@ func TestOspfCurrentTimeFormat(t *testing.T) { func TestOspfProtocolDown(t *testing.T) { data := "o_hrz OSPF t_hrz down 1494926415 \n Preference: 150\n Input filter: ACCEPT\n Output filter: REJECT\nxxx" - p := parseOutput([]byte(data), 6) + p := parser.Parse([]byte(data), 6) assert.IntEqual("protocols", 1, len(p), t) x := p[0] @@ -150,7 +151,7 @@ func TestOspfProtocolDown(t *testing.T) { func TestOspfRunning(t *testing.T) { data := "ospf1 OSPF master up 00:01:00 Running\ntest\nbar\n Routes: 12 imported, 34 exported, 100 preferred\nxxx" - p := parseOutput([]byte(data), 4) + p := parser.Parse([]byte(data), 4) assert.IntEqual("protocols", 1, len(p), t) x := p[0] @@ -159,7 +160,7 @@ func TestOspfRunning(t *testing.T) { func TestOspfAlone(t *testing.T) { data := "ospf1 OSPF master up 00:01:00 Alone\ntest\nbar\n Routes: 12 imported, 34 exported, 100 preferred\nxxx" - p := parseOutput([]byte(data), 4) + p := parser.Parse([]byte(data), 4) assert.IntEqual("protocols", 1, len(p), t) x := p[0] From 5c10493514f246779241b6b69955768b72096ba6 Mon Sep 17 00:00:00 2001 From: Daniel Czerwonk Date: Fri, 1 Dec 2017 00:37:12 +0100 Subject: [PATCH 03/12] generic protocol export (new format) --- main.go | 3 +- metric_collector.go | 62 ++++++++++++++++++++++--------- metrics/default_label_strategy.go | 7 +++- metrics/metrics_exporter.go | 11 ++++++ ospf/exporter.go | 32 +++++++--------- 5 files changed, 75 insertions(+), 40 deletions(-) create mode 100644 metrics/metrics_exporter.go diff --git a/main.go b/main.go index baf576e..ed79955 100644 --- a/main.go +++ b/main.go @@ -21,6 +21,7 @@ var ( bird6Socket = flag.String("bird.socket6", "/var/run/bird6.ctl", "Socket to communicate with bird6 routing daemon") birdEnabled = flag.Bool("bird.ipv4", true, "Get protocols from bird") bird6Enabled = flag.Bool("bird.ipv6", true, "Get protocols from bird6") + newFormat = flag.Bool("use-new-format", false, "New metric format (more convinient / generic)") ) func init() { @@ -87,7 +88,7 @@ func handleMetricsRequest(w http.ResponseWriter, r *http.Request) error { if len(protocols) > 0 { reg := prometheus.NewRegistry() - c := NewMetricCollectorForProtocols(protocols) + c := NewMetricCollectorForProtocols(protocols, *newFormat) reg.MustRegister(c) promhttp.HandlerFor(reg, promhttp.HandlerOpts{ diff --git a/metric_collector.go b/metric_collector.go index 43e8770..8712afb 100644 --- a/metric_collector.go +++ b/metric_collector.go @@ -7,40 +7,66 @@ import ( "github.com/prometheus/client_golang/prometheus" ) -type MetricExporter interface { - Describe(ch chan<- *prometheus.Desc) - Export(p *protocol.Protocol, ch chan<- prometheus.Metric) -} - type MetricCollector struct { protocols []*protocol.Protocol - exporters map[int]MetricExporter + exporters map[int][]metrics.MetricExporter } -func NewMetricCollectorForProtocols(protocols []*protocol.Protocol) *MetricCollector { - l := &metrics.LegacyLabelStrategy{} - e := map[int]MetricExporter{ - protocol.BGP: metrics.NewMetricExporter("bgp4_session", "bgp6_session", l), - protocol.Device: metrics.NewMetricExporter("device4", "device6", l), - protocol.Direct: metrics.NewMetricExporter("direct4", "direct6", l), - protocol.Kernel: metrics.NewMetricExporter("kernel4", "kernel6", l), - protocol.OSPF: ospf.NewExporter(l), - protocol.Static: metrics.NewMetricExporter("static4", "static6", l), +func NewMetricCollectorForProtocols(protocols []*protocol.Protocol, newFormat bool) *MetricCollector { + var e map[int][]metrics.MetricExporter + + if newFormat { + e = exportersForDefault() + } else { + e = exportersForLegacy() } return &MetricCollector{protocols: protocols, exporters: e} } +func exportersForLegacy() map[int][]metrics.MetricExporter { + l := &metrics.LegacyLabelStrategy{} + + return map[int][]metrics.MetricExporter{ + protocol.BGP: []metrics.MetricExporter{metrics.NewMetricExporter("bgp4_session", "bgp6_session", l)}, + protocol.Device: []metrics.MetricExporter{metrics.NewMetricExporter("device4", "device6", l)}, + protocol.Direct: []metrics.MetricExporter{metrics.NewMetricExporter("direct4", "direct6", l)}, + protocol.Kernel: []metrics.MetricExporter{metrics.NewMetricExporter("kernel4", "kernel6", l)}, + protocol.OSPF: []metrics.MetricExporter{metrics.NewMetricExporter("ospf", "ospfv3", l), ospf.NewExporter("")}, + protocol.Static: []metrics.MetricExporter{metrics.NewMetricExporter("static4", "static6", l)}, + } +} + +func exportersForDefault() map[int][]metrics.MetricExporter { + l := &metrics.DefaultLabelStrategy{} + e := metrics.NewGenericProtocolMetricExporter("bird_protocol", l) + + return map[int][]metrics.MetricExporter{ + protocol.BGP: []metrics.MetricExporter{e}, + protocol.Device: []metrics.MetricExporter{e}, + protocol.Direct: []metrics.MetricExporter{e}, + protocol.Kernel: []metrics.MetricExporter{e}, + protocol.OSPF: []metrics.MetricExporter{e, ospf.NewExporter("bird_")}, + protocol.Static: []metrics.MetricExporter{e}, + } +} + func (m *MetricCollector) Describe(ch chan<- *prometheus.Desc) { for _, v := range m.exporters { - v.Describe(ch) + for _, e := range v { + e.Describe(ch) + } } } func (m *MetricCollector) Collect(ch chan<- prometheus.Metric) { for _, p := range m.protocols { - if p.Proto != protocol.PROTO_UNKNOWN { - m.exporters[p.Proto].Export(p, ch) + if p.Proto == protocol.PROTO_UNKNOWN { + continue + } + + for _, e := range m.exporters[p.Proto] { + e.Export(p, ch) } } } diff --git a/metrics/default_label_strategy.go b/metrics/default_label_strategy.go index f57047b..a2a4a78 100644 --- a/metrics/default_label_strategy.go +++ b/metrics/default_label_strategy.go @@ -1,6 +1,9 @@ package metrics -import "github.com/czerwonk/bird_exporter/protocol" +import ( + "github.com/czerwonk/bird_exporter/protocol" + "strconv" +) type DefaultLabelStrategy struct { } @@ -10,7 +13,7 @@ func (*DefaultLabelStrategy) labelNames() []string { } func (*DefaultLabelStrategy) labelValues(p *protocol.Protocol) []string { - return []string{p.Name, protoString(p), string(p.IpVersion)} + return []string{p.Name, protoString(p), strconv.Itoa(p.IpVersion)} } func protoString(p *protocol.Protocol) string { switch p.Proto { diff --git a/metrics/metrics_exporter.go b/metrics/metrics_exporter.go new file mode 100644 index 0000000..9979faa --- /dev/null +++ b/metrics/metrics_exporter.go @@ -0,0 +1,11 @@ +package metrics + +import ( + "github.com/czerwonk/bird_exporter/protocol" + "github.com/prometheus/client_golang/prometheus" +) + +type MetricExporter interface { + Describe(ch chan<- *prometheus.Desc) + Export(p *protocol.Protocol, ch chan<- prometheus.Metric) +} diff --git a/ospf/exporter.go b/ospf/exporter.go index 63029db..a172a89 100644 --- a/ospf/exporter.go +++ b/ospf/exporter.go @@ -1,29 +1,25 @@ package ospf import ( - "github.com/czerwonk/bird_exporter/metrics" "github.com/czerwonk/bird_exporter/protocol" "github.com/prometheus/client_golang/prometheus" + "github.com/czerwonk/bird_exporter/metrics" ) -var descriptions map[int]*desc - type desc struct { runningDesc *prometheus.Desc } -type OspfMetricExporter struct { - genericExporter *metrics.ProtocolMetricExporter +type ospfMetricExporter struct { + descriptions map[int]*desc } -func init() { - descriptions = make(map[int]*desc) - descriptions[4] = getDesc("ospf") - descriptions[6] = getDesc("ospfv3") -} +func NewExporter(prefix string) metrics.MetricExporter { + d := make(map[int]*desc) + d[4] = getDesc(prefix+"ospf") + d[6] = getDesc(prefix+"ospfv3") -func NewExporter(labelStrategy metrics.LabelStrategy) *OspfMetricExporter { - return &OspfMetricExporter{genericExporter: metrics.NewMetricExporter("ospf", "ospfv3", labelStrategy)} + return &ospfMetricExporter{descriptions: d} } func getDesc(prefix string) *desc { @@ -35,13 +31,11 @@ func getDesc(prefix string) *desc { return d } -func (m *OspfMetricExporter) Describe(ch chan<- *prometheus.Desc) { - m.genericExporter.Describe(ch) - ch <- descriptions[4].runningDesc - ch <- descriptions[6].runningDesc +func (m *ospfMetricExporter) Describe(ch chan<- *prometheus.Desc) { + ch <- m.descriptions[4].runningDesc + ch <- m.descriptions[6].runningDesc } -func (m *OspfMetricExporter) Export(p *protocol.Protocol, ch chan<- prometheus.Metric) { - m.genericExporter.Export(p, ch) - ch <- prometheus.MustNewConstMetric(descriptions[p.IpVersion].runningDesc, prometheus.GaugeValue, p.Attributes["running"], p.Name) +func (m *ospfMetricExporter) Export(p *protocol.Protocol, ch chan<- prometheus.Metric) { + ch <- prometheus.MustNewConstMetric(m.descriptions[p.IpVersion].runningDesc, prometheus.GaugeValue, p.Attributes["running"], p.Name) } From bd27c80b5d714e5f0bc0acff5d4d860efd02a0d1 Mon Sep 17 00:00:00 2001 From: Daniel Czerwonk Date: Fri, 1 Dec 2017 07:42:29 +0100 Subject: [PATCH 04/12] added flags to disable protocols --- main.go | 34 +++++++++++++++++++++++++++++++++- metric_collector.go | 11 ++++++----- protocol/protocol.go | 8 ++++---- 3 files changed, 43 insertions(+), 10 deletions(-) diff --git a/main.go b/main.go index ed79955..bed2a7b 100644 --- a/main.go +++ b/main.go @@ -9,6 +9,7 @@ import ( "github.com/prometheus/client_golang/prometheus" "github.com/prometheus/client_golang/prometheus/promhttp" "github.com/prometheus/common/log" + "github.com/czerwonk/bird_exporter/protocol" ) const version string = "1.0.0" @@ -22,6 +23,12 @@ var ( birdEnabled = flag.Bool("bird.ipv4", true, "Get protocols from bird") bird6Enabled = flag.Bool("bird.ipv6", true, "Get protocols from bird6") newFormat = flag.Bool("use-new-format", false, "New metric format (more convinient / generic)") + enableBgp = flag.Bool("enable-bgp", true, "Enables metrics for protocol BGP") + enableOspf = flag.Bool("enable-ospf", true, "Enables metrics for protocol OSPF") + enableKernel = flag.Bool("enable-kernel", true, "Enables metrics for protocol kernel") + enableStatic = flag.Bool("enable-static", true, "Enables metrics for protocol static") + enableDevice = flag.Bool("enable-device", true, "Enables metrics for protocol static") + enableDirect = flag.Bool("enable-direct", true, "Enables metrics for protocol direct") ) func init() { @@ -88,7 +95,8 @@ func handleMetricsRequest(w http.ResponseWriter, r *http.Request) error { if len(protocols) > 0 { reg := prometheus.NewRegistry() - c := NewMetricCollectorForProtocols(protocols, *newFormat) + p := enabledProtocols() + c := NewMetricCollectorForProtocols(protocols, *newFormat, p) reg.MustRegister(c) promhttp.HandlerFor(reg, promhttp.HandlerOpts{ @@ -98,3 +106,27 @@ func handleMetricsRequest(w http.ResponseWriter, r *http.Request) error { return nil } +func enabledProtocols() int { + res := 0 + + if *enableBgp { + res |= protocol.BGP + } + if *enableOspf { + res |= protocol.OSPF + } + if *enableKernel { + res |= protocol.Kernel + } + if *enableStatic { + res |= protocol.Static + } + if *enableDevice { + res |= protocol.Device + } + if *enableDirect { + res |= protocol.Direct + } + + return res +} diff --git a/metric_collector.go b/metric_collector.go index 8712afb..159c053 100644 --- a/metric_collector.go +++ b/metric_collector.go @@ -8,11 +8,12 @@ import ( ) type MetricCollector struct { - protocols []*protocol.Protocol - exporters map[int][]metrics.MetricExporter + protocols []*protocol.Protocol + exporters map[int][]metrics.MetricExporter + enabledProtocols int } -func NewMetricCollectorForProtocols(protocols []*protocol.Protocol, newFormat bool) *MetricCollector { +func NewMetricCollectorForProtocols(protocols []*protocol.Protocol, newFormat bool, enabledProtocols int) *MetricCollector { var e map[int][]metrics.MetricExporter if newFormat { @@ -21,7 +22,7 @@ func NewMetricCollectorForProtocols(protocols []*protocol.Protocol, newFormat bo e = exportersForLegacy() } - return &MetricCollector{protocols: protocols, exporters: e} + return &MetricCollector{protocols: protocols, exporters: e, enabledProtocols: enabledProtocols} } func exportersForLegacy() map[int][]metrics.MetricExporter { @@ -61,7 +62,7 @@ func (m *MetricCollector) Describe(ch chan<- *prometheus.Desc) { func (m *MetricCollector) Collect(ch chan<- prometheus.Metric) { for _, p := range m.protocols { - if p.Proto == protocol.PROTO_UNKNOWN { + if p.Proto == protocol.PROTO_UNKNOWN || (m.enabledProtocols & p.Proto != p.Proto) { continue } diff --git a/protocol/protocol.go b/protocol/protocol.go index a84e28f..2e309a4 100644 --- a/protocol/protocol.go +++ b/protocol/protocol.go @@ -4,10 +4,10 @@ const ( PROTO_UNKNOWN = 0 BGP = 1 OSPF = 2 - Kernel = 3 - Static = 4 - Direct = 5 - Device = 6 + Kernel = 4 + Static = 8 + Direct = 16 + Device = 32 ) type Protocol struct { From cf021eb59d855db149f0687d17ed04b51ff48276 Mon Sep 17 00:00:00 2001 From: Daniel Czerwonk Date: Fri, 1 Dec 2017 07:59:49 +0100 Subject: [PATCH 05/12] documented format changes --- README.md | 26 ++++++++++++++++++++++++++ main.go | 14 +++++++------- 2 files changed, 33 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2715890..49f700f 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,27 @@ To get meaningful uptime information bird has to be configured this way: timeformat protocol "%s"; ``` +## Metric formats +In version 1.0 a new metric format was added. +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. + +This is a short example of the different formats: + +### old format +``` +bgp4_session_prefix_count_import{name="bgp1"} 600000 +bgp6_session_prefix_count_import{name="bgp1"} 50000 +ospfv3_running{name="ospf1"} 1 +``` + +### new format +``` +bird_protocol_prefix_count_import{name="bgp1",proto="BGP",ip_version="4"} 600000 +bird_protocol_prefix_count_import{name="bgp1",proto="BGP",ip_version="6"} 50000 +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) @@ -24,6 +45,11 @@ In version 0.8 communication to bird changed to sockets. The default socket path go get -u github.com/czerwonk/bird_exporter ``` +## Usage +``` +bird_exporter -format.new=true +``` + ## Features * BGP session state * imported / exported / filtered prefix counts / route state changes (BGP, OSPF, Kernel, Static, Device, Direct) diff --git a/main.go b/main.go index bed2a7b..8d949b5 100644 --- a/main.go +++ b/main.go @@ -22,13 +22,13 @@ var ( bird6Socket = flag.String("bird.socket6", "/var/run/bird6.ctl", "Socket to communicate with bird6 routing daemon") birdEnabled = flag.Bool("bird.ipv4", true, "Get protocols from bird") bird6Enabled = flag.Bool("bird.ipv6", true, "Get protocols from bird6") - newFormat = flag.Bool("use-new-format", false, "New metric format (more convinient / generic)") - enableBgp = flag.Bool("enable-bgp", true, "Enables metrics for protocol BGP") - enableOspf = flag.Bool("enable-ospf", true, "Enables metrics for protocol OSPF") - enableKernel = flag.Bool("enable-kernel", true, "Enables metrics for protocol kernel") - enableStatic = flag.Bool("enable-static", true, "Enables metrics for protocol static") - enableDevice = flag.Bool("enable-device", true, "Enables metrics for protocol static") - enableDirect = flag.Bool("enable-direct", true, "Enables metrics for protocol direct") + newFormat = flag.Bool("format.new", false, "New metric format (more convinient / generic)") + enableBgp = flag.Bool("proto.bgp", true, "Enables metrics for protocol BGP") + enableOspf = flag.Bool("proto.ospf", true, "Enables metrics for protocol OSPF") + enableKernel = flag.Bool("proto.kernel", true, "Enables metrics for protocol kernel") + enableStatic = flag.Bool("proto.static", true, "Enables metrics for protocol static") + enableDevice = flag.Bool("proto.device", true, "Enables metrics for protocol static") + enableDirect = flag.Bool("proto.direct", true, "Enables metrics for protocol direct") ) func init() { From 5bb47717178a1f1611858ff8067008bb979f7e03 Mon Sep 17 00:00:00 2001 From: Daniel Czerwonk Date: Fri, 1 Dec 2017 08:00:29 +0100 Subject: [PATCH 06/12] goimports --- main.go | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/main.go b/main.go index 8d949b5..d081afd 100644 --- a/main.go +++ b/main.go @@ -6,10 +6,10 @@ import ( "net/http" "os" + "github.com/czerwonk/bird_exporter/protocol" "github.com/prometheus/client_golang/prometheus" "github.com/prometheus/client_golang/prometheus/promhttp" "github.com/prometheus/common/log" - "github.com/czerwonk/bird_exporter/protocol" ) const version string = "1.0.0" @@ -23,12 +23,12 @@ var ( birdEnabled = flag.Bool("bird.ipv4", true, "Get protocols from bird") bird6Enabled = flag.Bool("bird.ipv6", true, "Get protocols from bird6") newFormat = flag.Bool("format.new", false, "New metric format (more convinient / generic)") - enableBgp = flag.Bool("proto.bgp", true, "Enables metrics for protocol BGP") - enableOspf = flag.Bool("proto.ospf", true, "Enables metrics for protocol OSPF") - enableKernel = flag.Bool("proto.kernel", true, "Enables metrics for protocol kernel") - enableStatic = flag.Bool("proto.static", true, "Enables metrics for protocol static") - enableDevice = flag.Bool("proto.device", true, "Enables metrics for protocol static") - enableDirect = flag.Bool("proto.direct", true, "Enables metrics for protocol direct") + enableBgp = flag.Bool("proto.bgp", true, "Enables metrics for protocol BGP") + enableOspf = flag.Bool("proto.ospf", true, "Enables metrics for protocol OSPF") + enableKernel = flag.Bool("proto.kernel", true, "Enables metrics for protocol kernel") + enableStatic = flag.Bool("proto.static", true, "Enables metrics for protocol static") + enableDevice = flag.Bool("proto.device", true, "Enables metrics for protocol static") + enableDirect = flag.Bool("proto.direct", true, "Enables metrics for protocol direct") ) func init() { From ef017bf42463e12af4689008ca5390e42e74ffe8 Mon Sep 17 00:00:00 2001 From: Daniel Czerwonk Date: Fri, 1 Dec 2017 08:04:40 +0100 Subject: [PATCH 07/12] more description --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 49f700f..133f023 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,8 @@ timeformat protocol "%s"; ## Metric formats In version 1.0 a new metric format was added. 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. +The new format handles protocols more generic and allows a better query structure. +In both formats protocol specific metrics are prefixed with the protocol name (e.g. OSPF running metric). This is a short example of the different formats: From b9e7bbd5feab2f3de1bfb6ff08df905ebb293f8b Mon Sep 17 00:00:00 2001 From: Daniel Czerwonk Date: Fri, 1 Dec 2017 08:34:57 +0100 Subject: [PATCH 08/12] fixed naming inconsistency --- README.md | 4 ++-- metric_collector.go | 2 +- metrics/exporter.go | 4 ++-- metrics/generic_exporter.go | 23 ++++++++++++++++------- 4 files changed, 21 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 133f023..e399287 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,8 @@ ospfv3_running{name="ospf1"} 1 ### new format ``` -bird_protocol_prefix_count_import{name="bgp1",proto="BGP",ip_version="4"} 600000 -bird_protocol_prefix_count_import{name="bgp1",proto="BGP",ip_version="6"} 50000 +bird_protocol_prefix_import_count{name="bgp1",proto="BGP",ip_version="4"} 600000 +bird_protocol_prefix_import_count{name="bgp1",proto="BGP",ip_version="6"} 50000 bird_ospfv3_running{name="ospf1"} 1 ``` diff --git a/metric_collector.go b/metric_collector.go index 159c053..59bdd82 100644 --- a/metric_collector.go +++ b/metric_collector.go @@ -40,7 +40,7 @@ func exportersForLegacy() map[int][]metrics.MetricExporter { func exportersForDefault() map[int][]metrics.MetricExporter { l := &metrics.DefaultLabelStrategy{} - e := metrics.NewGenericProtocolMetricExporter("bird_protocol", l) + e := metrics.NewGenericProtocolMetricExporter("bird_protocol", true, l) return map[int][]metrics.MetricExporter{ protocol.BGP: []metrics.MetricExporter{e}, diff --git a/metrics/exporter.go b/metrics/exporter.go index 8ea3017..6274406 100644 --- a/metrics/exporter.go +++ b/metrics/exporter.go @@ -12,8 +12,8 @@ type ProtocolMetricExporter struct { func NewMetricExporter(prefixIpv4, prefixIpv6 string, labelStrategy LabelStrategy) *ProtocolMetricExporter { return &ProtocolMetricExporter{ - ipv4Exporter: NewGenericProtocolMetricExporter(prefixIpv4, labelStrategy), - ipv6Exporter: NewGenericProtocolMetricExporter(prefixIpv6, labelStrategy), + ipv4Exporter: NewGenericProtocolMetricExporter(prefixIpv4, false, labelStrategy), + ipv6Exporter: NewGenericProtocolMetricExporter(prefixIpv6, false, labelStrategy), } } diff --git a/metrics/generic_exporter.go b/metrics/generic_exporter.go index 0019bdf..75ff5e5 100644 --- a/metrics/generic_exporter.go +++ b/metrics/generic_exporter.go @@ -35,20 +35,29 @@ type GenericProtocolMetricExporter struct { withdrawsExportAcceptCountDesc *prometheus.Desc } -func NewGenericProtocolMetricExporter(prefix string, labelStrategy LabelStrategy) *GenericProtocolMetricExporter { +func NewGenericProtocolMetricExporter(prefix string, newNaming bool, labelStrategy LabelStrategy) *GenericProtocolMetricExporter { m := &GenericProtocolMetricExporter{labelStrategy: labelStrategy} - m.initDesc(prefix) + m.initDesc(prefix, newNaming) return m } -func (m *GenericProtocolMetricExporter) initDesc(prefix string) { +func (m *GenericProtocolMetricExporter) initDesc(prefix string, newNaming bool) { labels := m.labelStrategy.labelNames() m.upDesc = prometheus.NewDesc(prefix+"_up", "Protocol is up", labels, nil) - m.importCountDesc = prometheus.NewDesc(prefix+"_prefix_count_import", "Number of imported routes", labels, nil) - m.exportCountDesc = prometheus.NewDesc(prefix+"_prefix_count_export", "Number of exported routes", labels, nil) - m.filterCountDesc = prometheus.NewDesc(prefix+"_prefix_count_filter", "Number of filtered routes", labels, nil) - m.preferredCountDesc = prometheus.NewDesc(prefix+"_prefix_count_preferred", "Number of preferred routes", labels, nil) + + if newNaming { + m.importCountDesc = prometheus.NewDesc(prefix+"_prefix_import_count", "Number of imported routes", labels, nil) + m.exportCountDesc = prometheus.NewDesc(prefix+"_prefix_export_count", "Number of exported routes", labels, nil) + m.filterCountDesc = prometheus.NewDesc(prefix+"_prefix_filter_count", "Number of filtered routes", labels, nil) + m.preferredCountDesc = prometheus.NewDesc(prefix+"_prefix_preferred_count", "Number of preferred routes", labels, nil) + } else { + m.importCountDesc = prometheus.NewDesc(prefix+"_prefix_count_import", "Number of imported routes", labels, nil) + m.exportCountDesc = prometheus.NewDesc(prefix+"_prefix_count_export", "Number of exported routes", labels, nil) + m.filterCountDesc = prometheus.NewDesc(prefix+"_prefix_count_filter", "Number of filtered routes", labels, nil) + m.preferredCountDesc = prometheus.NewDesc(prefix+"_prefix_count_preferred", "Number of preferred routes", labels, nil) + } + m.uptimeDesc = prometheus.NewDesc(prefix+"_uptime", "Uptime of the protocol in seconds", labels, nil) m.updatesImportIgnoreCountDesc = prometheus.NewDesc(prefix+"_changes_update_import_ignore_count", "Number of incoming updates beeing ignored", labels, nil) m.updatesImportAcceptCountDesc = prometheus.NewDesc(prefix+"_changes_update_import_accept_count", "Number of incoming updates beeing accepted", labels, nil) From 9c58e96ba0f5aef4be4f57fa4419866a4d2b1263 Mon Sep 17 00:00:00 2001 From: Daniel Czerwonk Date: Fri, 1 Dec 2017 10:04:50 +0100 Subject: [PATCH 09/12] added info text when using the old format --- main.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/main.go b/main.go index d081afd..b118fd8 100644 --- a/main.go +++ b/main.go @@ -59,6 +59,11 @@ func printVersion() { func startServer() { log.Infof("Starting bird exporter (Version: %s)\n", version) + + if !*newFormat { + log.Info("INFO: You are using the old metric format. Please consider using the new (more convinient one) by setting -format.new=true.") + } + http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { w.Write([]byte(` Bird Routing Daemon Exporter (Version ` + version + `) From eabc3de14935735f7e577baf8f9a8eef42b7c3b7 Mon Sep 17 00:00:00 2001 From: Daniel Czerwonk Date: Fri, 1 Dec 2017 14:27:02 +0100 Subject: [PATCH 10/12] Update main.go fixed copy paste --- main.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/main.go b/main.go index b118fd8..56ec6b2 100644 --- a/main.go +++ b/main.go @@ -25,10 +25,10 @@ var ( newFormat = flag.Bool("format.new", false, "New metric format (more convinient / generic)") enableBgp = flag.Bool("proto.bgp", true, "Enables metrics for protocol BGP") enableOspf = flag.Bool("proto.ospf", true, "Enables metrics for protocol OSPF") - enableKernel = flag.Bool("proto.kernel", true, "Enables metrics for protocol kernel") - enableStatic = flag.Bool("proto.static", true, "Enables metrics for protocol static") - enableDevice = flag.Bool("proto.device", true, "Enables metrics for protocol static") - enableDirect = flag.Bool("proto.direct", true, "Enables metrics for protocol direct") + enableKernel = flag.Bool("proto.kernel", true, "Enables metrics for protocol Kernel") + enableStatic = flag.Bool("proto.static", true, "Enables metrics for protocol Static") + enableDevice = flag.Bool("proto.device", true, "Enables metrics for protocol Device") + enableDirect = flag.Bool("proto.direct", true, "Enables metrics for protocol Direct") ) func init() { From b9045077ae6ea88094400988c6333d78978352b7 Mon Sep 17 00:00:00 2001 From: Daniel Czerwonk Date: Fri, 1 Dec 2017 14:33:22 +0100 Subject: [PATCH 11/12] renamed legacy exporter --- metric_collector.go | 12 ++++++------ metrics/exporter.go | 10 +++++----- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/metric_collector.go b/metric_collector.go index 59bdd82..be19c02 100644 --- a/metric_collector.go +++ b/metric_collector.go @@ -29,12 +29,12 @@ func exportersForLegacy() map[int][]metrics.MetricExporter { l := &metrics.LegacyLabelStrategy{} return map[int][]metrics.MetricExporter{ - protocol.BGP: []metrics.MetricExporter{metrics.NewMetricExporter("bgp4_session", "bgp6_session", l)}, - protocol.Device: []metrics.MetricExporter{metrics.NewMetricExporter("device4", "device6", l)}, - protocol.Direct: []metrics.MetricExporter{metrics.NewMetricExporter("direct4", "direct6", l)}, - protocol.Kernel: []metrics.MetricExporter{metrics.NewMetricExporter("kernel4", "kernel6", l)}, - protocol.OSPF: []metrics.MetricExporter{metrics.NewMetricExporter("ospf", "ospfv3", l), ospf.NewExporter("")}, - protocol.Static: []metrics.MetricExporter{metrics.NewMetricExporter("static4", "static6", l)}, + protocol.BGP: []metrics.MetricExporter{metrics.NewLegacyMetricExporter("bgp4_session", "bgp6_session", l)}, + protocol.Device: []metrics.MetricExporter{metrics.NewLegacyMetricExporter("device4", "device6", l)}, + protocol.Direct: []metrics.MetricExporter{metrics.NewLegacyMetricExporter("direct4", "direct6", l)}, + protocol.Kernel: []metrics.MetricExporter{metrics.NewLegacyMetricExporter("kernel4", "kernel6", l)}, + protocol.OSPF: []metrics.MetricExporter{metrics.NewLegacyMetricExporter("ospf", "ospfv3", l), ospf.NewExporter("")}, + protocol.Static: []metrics.MetricExporter{metrics.NewLegacyMetricExporter("static4", "static6", l)}, } } diff --git a/metrics/exporter.go b/metrics/exporter.go index 6274406..6d4a5cc 100644 --- a/metrics/exporter.go +++ b/metrics/exporter.go @@ -5,24 +5,24 @@ import ( "github.com/czerwonk/bird_exporter/protocol" ) -type ProtocolMetricExporter struct { +type LegacyMetricExporter struct { ipv4Exporter *GenericProtocolMetricExporter ipv6Exporter *GenericProtocolMetricExporter } -func NewMetricExporter(prefixIpv4, prefixIpv6 string, labelStrategy LabelStrategy) *ProtocolMetricExporter { - return &ProtocolMetricExporter{ +func NewLegacyMetricExporter(prefixIpv4, prefixIpv6 string, labelStrategy LabelStrategy) MetricExporter { + return &LegacyMetricExporter { ipv4Exporter: NewGenericProtocolMetricExporter(prefixIpv4, false, labelStrategy), ipv6Exporter: NewGenericProtocolMetricExporter(prefixIpv6, false, labelStrategy), } } -func (e *ProtocolMetricExporter) Describe(ch chan<- *prometheus.Desc) { +func (e *LegacyMetricExporter) Describe(ch chan<- *prometheus.Desc) { e.ipv4Exporter.Describe(ch) e.ipv6Exporter.Describe(ch) } -func (e *ProtocolMetricExporter) Export(p *protocol.Protocol, ch chan<- prometheus.Metric) { +func (e *LegacyMetricExporter) Export(p *protocol.Protocol, ch chan<- prometheus.Metric) { if p.IpVersion == 4 { e.ipv4Exporter.Export(p, ch) } else { From 05e7f4878769bd437920c829d913cf1847fb9995 Mon Sep 17 00:00:00 2001 From: Daniel Czerwonk Date: Fri, 1 Dec 2017 14:35:25 +0100 Subject: [PATCH 12/12] renamed legacy exporter (file) --- metrics/{exporter.go => legacy_exporter.go} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename metrics/{exporter.go => legacy_exporter.go} (100%) diff --git a/metrics/exporter.go b/metrics/legacy_exporter.go similarity index 100% rename from metrics/exporter.go rename to metrics/legacy_exporter.go