diff --git a/README.md b/README.md index 1ad8c795..5315ffb9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Akvorado: flow collector, augmenter and exporter. +# Akvorado: flow collector, hydrater and exporter. -This program receives flows (currently Netflow), augments them with +This program receives flows (currently Netflow), hydrates them with interface names (using SNMP), geo information (using MaxMind), and exports them to Kafka. diff --git a/cmd/serve.go b/cmd/serve.go index a3b20b57..dcc55210 100644 --- a/cmd/serve.go +++ b/cmd/serve.go @@ -59,7 +59,7 @@ var ServeOptions serveOptions var serveCmd = &cobra.Command{ Use: "serve", Short: "Start akvorado", - Long: `Akvorado is a Netflow collector. It augments flows with information from SNMP and GeoIP + Long: `Akvorado is a Netflow collector. It hydrates flows with information from SNMP and GeoIP and exports them to Kafka.`, Args: cobra.ExactArgs(0), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/core/augment.go b/core/hydrate.go similarity index 94% rename from core/augment.go rename to core/hydrate.go index 1c4693d6..984aa074 100644 --- a/core/augment.go +++ b/core/hydrate.go @@ -10,8 +10,8 @@ import ( "akvorado/snmp" ) -// AugmentFlow adds more data to a flow. -func (c *Component) AugmentFlow(sampler string, flow *flow.FlowMessage) (skip bool) { +// HydrateFlow adds more data to a flow. +func (c *Component) HydrateFlow(sampler string, flow *flow.FlowMessage) (skip bool) { errLimiter := rate.NewLimiter(rate.Every(time.Minute), 10) if flow.InIf != 0 { samplerName, iface, err := c.d.Snmp.Lookup(sampler, uint(flow.InIf)) diff --git a/core/root.go b/core/root.go index 91bd57d7..3c02cb2c 100644 --- a/core/root.go +++ b/core/root.go @@ -98,7 +98,8 @@ func (c *Component) runWorker(workerID int) error { sampler := net.IP(flow.SamplerAddress).String() c.metrics.flowsReceived.WithLabelValues(sampler).Inc() - if skip := c.AugmentFlow(sampler, flow); skip { + // Hydratation + if skip := c.HydrateFlow(sampler, flow); skip { continue } diff --git a/docs/index.md b/docs/index.md index f9c4e03d..4b0cf7c5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,7 +8,7 @@ hide: ![](assets/akvorado.svg){ .akvorado-logo } -*Akvorado* is a flow collector, augmenter and exporter. It receives +*Akvorado* is a flow collector, hydrater and exporter. It receives flows, adds some data like interface names and geo information, and exports them to Kafka. [Akvorado][] means "water wheel" in Esperanto.