Skip to content

Commit be5675c

Browse files
committed
overview update
1 parent 4e957ce commit be5675c

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,23 @@
55

66
# Overview
77

8-
**Flow-Logs Pipeline** (a.k.a. FLP) is an **observability tool** that consumes raw **network flow-logs** in
9-
their original format
10-
([NetFlow v5,v9](https://en.wikipedia.org/wiki/NetFlow) or [IPFIX](https://en.wikipedia.org/wiki/IP_Flow_Information_Export))
11-
and uses a pipe-line to transform the logs into
12-
time series metrics in **[prometheus](https://prometheus.io/)** format and in parallel
13-
transform and persist the logs also into **[loki](https://grafana.com/oss/loki/)**.
8+
**Flow-Logs Pipeline** (a.k.a. FLP) is an **observability tool** that **[consumes](./pkg/pipeline/ingest/)** logs from various inputs, **[transform](./pkg//pipeline/transform/)** them and **[export](./pkg/pipeline/write/)** logs to **[loki](https://grafana.com/oss/loki/)** and / or time series metrics to **[prometheus](https://prometheus.io/)**.
149

1510
![Animated gif](docs/images/animation.gif)
1611

12+
FLP can consume:
13+
- raw **network flow-logs** in their original format
14+
([NetFlow v5,v9](https://en.wikipedia.org/wiki/NetFlow) or [IPFIX](https://en.wikipedia.org/wiki/IP_Flow_Information_Export))
15+
- [eBPF agent](https://github.com/netobserv/netobserv-ebpf-agent) flows in binary format (protobuf+GRPC)
16+
- Kafka entries in JSON format
17+
- A simple file
18+
1719
FLP decorates the metrics and the transformed logs with **context**,
1820
allowing visualization layers and analytics frameworks to present **network insights** to SRE’s, cloud operators and network experts.
1921

2022
It also allows defining mathematical transformations to generate condense metrics that encapsulate network domain knowledge.
2123

22-
FLP pipe-line module is built on top of [gopipes](https://github.com/netobserv/gopipes) providing customizability and parallelism
24+
FLP pipeline module is built on top of [gopipes](https://github.com/netobserv/gopipes) providing customizability and parallelism
2325

2426
In addition, along with Prometheus and its ecosystem tools such as Thanos, Cortex etc.,
2527
FLP provides an efficient scalable multi-cloud solution for comprehensive network analytics that can rely **solely on metrics data-source**.

0 commit comments

Comments
 (0)