Skip to content

Commit 8e1ee4e

Browse files
committed
Update docs.
1 parent 7975dfb commit 8e1ee4e

File tree

4 files changed

+7
-23
lines changed

4 files changed

+7
-23
lines changed

docs/api.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,6 @@ nav_order: 4
77

88
# APIs Documentation
99

10-
<img src="{{ site.baseurl }}/resources/architecture_nfstream.png" alt="drawing" width="730"/>
11-
12-
The flow-based aggregation consists of aggregating packets into flows based on a shared set of characteristics
13-
(flow key, e.g., source IP address, destination IP address, transport protocol, source port, destination port,
14-
VLAN identifier, tunnel Identifier). A flow cache maintains each flow entry until its termination (e.g., active timeout, inactive timeout).
15-
While the entry is present in the flow cache, basic counters, and several metrics are updated.
16-
If two pairs generate flows on both directions, the flow cache uses a bidirectional flow definition, adding counters
17-
and metrics for both directions.
18-
19-
In the above schema, NFStream overall architecture is depicted and could be summarized as follows:
20-
* NFStreamer: the driver process, it is responsible of setting the overall workflow which is mainly an orchestration of
21-
parallel metering processes.
22-
* Meters: are the core parts of NFStream framework. Raw packets are processed (e.g. timestamped, decoded, truncated)
23-
and dispatched across meters. Each meter is able to aggregate packet information into flow and compute required features
24-
until flow expiration is triggered (active timeout, inactive timeout).
25-
2610
## Table of contents
2711
{: .no_toc .text-delta }
2812

docs/design.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,10 @@ each time a new NFPacket is mapped to the flow entry. Finally, on_expire is perf
9191
expired. Consequently, extending NFStream is simple. Adding new flow features or ML model outcomes can be achieved
9292
in just a few lines.
9393

94-
## Socket state collector
95-
Socket state collector probes the Operating System kernel logs to construct a view of the active connections table.
96-
It is only activated when system visibility mode is set for end-host ground truth generation.
97-
The collector detects creation and closing of connections and send these state updates to the streamer.
94+
## Socket collector
95+
Socket collector probes the Operating System logs to construct a view of the active connections table.
96+
It is only activated when system visibility mode is set for end-host ground truth generation. The collector detects
97+
creation and closing of connections and send these state updates to the streamer.
9898

9999
> **Performance considerations**: Please read current design [**details**][net_connection] before considering enabling
100100
> this component at scale.

index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@
99
<meta name="image" property="og:image" content="https://www.nfstream.org/resources/preview.png">
1010
<div class="lp-center">
1111
<h1 style="font-weight: bold">NFStream: Flexible Network Data Analysis Framework</h1>
12-
<h2 style="padding-bottom: 30px">NFStream is a multiplatform Python framework providing fast, flexible, and expressive data structures designed to make
13-
working with online or offline network data easy and intuitive.</h2>
12+
<h2 style="padding-bottom: 30px">a multiplatform Python framework providing fast, flexible, and expressive data structures designed to make working with online or offline network data easy and intuitive.</h2>
1413
<a href="https://mybinder.org/v2/gh/aouinizied/nfstream-tutorials/master?filepath=demo_notebook.ipynb" class="btn btn-blue fs-5 mb-3 mb-md-5 mr-5">Live Notebook</a>
1514
<a href="{{ site.baseurl }}/docs/" class="btn btn-blue fs-5 mb-3 mb-md-5">Get Started</a>
1615
</div>
@@ -52,7 +51,7 @@ <h2>Network Flow aggregation and statistical features extraction</h2>
5251

5352
df = offline_streamer.to_pandas(columns_to_anonymize=())
5453
total_flows = offline_streamer.to_csv(flows_per_file=10000,
55-
columns_to_anonymize=("src_ip"))
54+
columns_to_anonymize=())
5655

5756
{% endhighlight %}
5857
</div>
@@ -121,6 +120,7 @@ <h2>Multiplatform support</h2>
121120
<h3>Documentation</h3>
122121
<ul>
123122
<li><a href="{{ site.baseurl }}/docs/#installation-guide" class="lp-footer-item">Installation Guide</a></li>
123+
<li><a href="{{ site.baseurl }}/docs/design" class="lp-footer-item">Design Overview</a></li>
124124
<li><a href="{{ site.baseurl }}/docs/api" class="lp-footer-item">API Documentation</a></li>
125125
<li><a href="{{ site.baseurl }}/docs/releases" class="lp-footer-item">Releases</a></li>
126126
<li><a href="{{ site.baseurl }}/docs/license" class="lp-footer-item">License</a></li>

resources/architecture_nfstream.png

-2.12 KB
Loading

0 commit comments

Comments
 (0)