Welcome to intake_netflow’s documentation!¶

This package enables Intake to read Netflow v9-format files.

Quickstart¶

This guide will show you how to get started using Intake to read IP flow records.

For conda users, the Intake Netflow plugin is installed with the following commands:

conda install -c intake intake-netflow

Attributes:

intake_netflow.v9.PacketStream(source) A read-only representation of serialized packets.

intake_netflow.v9.RecordStream(source) A read-only representation of serialized data records.

class intake_netflow.source.NetflowSource(urlpath, metadata=None)[source]¶

Attributes:	cache_dirs datashape description `hvplot` Returns a hvPlot object to provide a high-level plotting API. `plot` Returns a hvPlot object to provide a high-level plotting API. `plots` List custom associated quick-plots

Methods

`close`()	Close open resources corresponding to this data source.
`discover`()	Open resource and populate the source attributes.
`read`()	Load entire dataset into a container and return it
`read_chunked`()	Return iterator over container fragments of data source
`read_partition`(i)	Return a (offset_tuple, container) corresponding to i-th partition.
`to_dask`()	Return a dask container for this data source
`to_spark`()	Provide an equivalent data object in Apache Spark
`yaml`([with_plugin])	Return YAML representation of this data-source

set_cache_dir

class intake_netflow.v9.PacketStream(source)[source]¶

A read-only representation of serialized packets.

Parameters:

Methods

close
next

class intake_netflow.v9.RecordStream(source)[source]¶

A read-only representation of serialized data records.

Parameters:

Methods

close
next