Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Made categorization based on FLOW_END_REASON #232

Closed
wants to merge 1 commit into from
Closed

Made categorization based on FLOW_END_REASON #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions flow_age_stats/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
# Flow Age Stats module - README

## Description
This module is used for making statistics about the age of incoming flow data. The statistics produced are minimal, maximal and average values of the differences between the time a flow was received and its TIME_FIRST and TIME_LAST timestamps.
This module is used for making statistics about the age of incoming flow data. The statistics produced are minimal, maximal and average values for both first time the flow is encountered and the last time the flow is encountered.

Additionally, the module can output histograms of flow age distribution. These are written as two text files (time_first.txt, time_last.txt) that each have a table of three columns. First is the max age of the flow (the end of bin range). Second is the percentage of flows that are in that age group. Third is the flow count. By default, the bins are 0-1s, 1s-10s, 10s-20s, ... 590s-600s, >600s.
Additionally the module can output two text files (time_first.txt, time_last.txt) that each have a table of three columns. First is the max age of the flow. Second is the percentage of flows that are in that age group. Third is the flow count.

Second function, if -e is specified, is the same as the default behaviour except the flows incoming are further categorized based on FLOW_END_REASON.

## Interfaces
- Input: One UniRec interface
- Template MUST contain fields TIME_FIRST and TIME_LAST
- Output: None

## Parameters
- '-t' If specified, the module writes a file where the tables will be outputted. (Caution - the module will overwrite files labeled time_first.txt, time_last.txt)
- '-t' If specified the module creates or opens a file where the tables will be outputed. (Caution - the module will overwrite files labeled time_first.txt, time_last.txt)
- '-e' 'If specified the module creates statistics categorized based on FLOW_END_REASON.'

## Graphs
This module also comes with a script that makes use of GNUplot to make graphs from the data that is outputted into files. You can see how the graph looks like below.
This module also comes with a script (graphs.sh) that makes use of GNUplot to make graphs from the data that is outputed into files. You can see how the graph looks like below.

![ExampleGraph](example.png)

Loading
Loading