Skip to content

Latest commit

 

History

History
90 lines (55 loc) · 3.42 KB

README.md

File metadata and controls

90 lines (55 loc) · 3.42 KB
Raw

FCParser

Parser for data streams composed of variate (structured and unstructured) sources.

Contact persons: José Camacho Páez (josecamacho@ugr.es) José Manuel García Jiménez (jgarciag@ugr.es)

Last modification of this document: 10/Jul/18

Presentation

The FaaC parser library allows a comfortable, general and highly configurable parsing of network data originating from different sources. It has been designed to transform large amounts of heterogeneus network data into a single time-resolved stream of data features suitable for the analysis with multivariate techniques and other machine learning tools, hopefully without losing relevant information in the process.

The parsing process performs mainly 3 actions over the data:

  1. CONVERT variables into observatios of features to facilitate the further analysis. In this case, features work as a counter (FaaC, feature as a couter).
  2. AGGREGATE observations according to specific criteria.
  3. FUSE observations from different datasources.

To reach these goals, the analyst must provide expert knowledge on the data she wants to analyze. The analyst must decide which datasources include, which information is relevant, which criteria use for the aggregation and define the output features. To this end, FaaC parser library is highly configurable. All this setup is easily configurable through configuration files in YAML format. These files can be found in the 'config' folder. The format of the config files is explained in the beggining of each file.

Getting Started

Parsing

1.- Configuration. First step is generate configuration.yaml according to datasources and split setting. See /config/configuration.yaml for more info. There are example configuration files in Example directory.

2.- Split data (otpional). Usually, sampling the input data is required. The sampling configuration and datasources are defined in configuration.yaml. If split parameters are not determined, the data won't be sampled.

3.- Parse data. Extract observations from data.

In the example, data is sampled every 60s. Example usage:

$ python fcparser/fcparser.py Example/config/configuration.yaml

Deparsing

1.- Configuration. The deparsing program use the same configuration file used in parsing process, see /config/configuration.yaml for more info.

2.- Deparsing. Extract the logs related to anomalies. It takes as input features and timestamps. See Example to see format of the file.

$ python deparser/deparser.py Example/config/configuration.yaml Example/deparsing_input

Installation

Dependencies

The faaclib library requires some extra python libraries to work properly. They are:

  • IPy - Python module for handling IPv4 and IPv6 addresses and networks
  • PyYAML - YAML analyzer for Python

How to install

Running the following command installs both, the corresponding FCParser modules and the previous mentioned dependencies.

$ python setup.py install

Summary

The present repository is organized as follows:

  • fcparser/ Python Module with all of the lib classes and main script to parser process.
  • deparser/ Python script for deparsing process.
  • config/ Empty configuration files.
  • Example/ Data and configuration for an example example.
    • Examples_data Structured and unstructured data to test the tool.
    • config Configuration files adapted to the provided data.