Slinging packets since 2022!
___ _
/ __\ | _____ ____ _ _ __ ___
/ _\ | |/ _ \ \ /\ / / _` | '__/ _ \
/ / | | (_) \ V V / (_| | | | __/
\/ |_|\___/ \_/\_/ \__, |_| \___|
|___/
For sending fabricated Netflow v9 traffic to a collector for testing
Single is used to send a given number of flows in sequence to a collector for testing.
Usage of flowgre single:
-count int
count of flows to send in sequence. (default 1)
-dst-range string
CIDR range to use for generating destination IPs for flows (default "10.0.0.0/8")
-hexdump
If true, do a hexdump of the packet
-port int
destination port used by the flow collector. (default 9995)
-server string
servername or IP address of flow collector. (default "127.0.0.1")
-src-port int
source port used by the client. If 0, a random port between 10000-15000 is used
-src-range string
CIDR range to use for generating source IPs for flows (default "10.0.0.0/8")flowgre single -server 10.10.10.10 -count 10Barrage is used to send a continuous barrage of flows in different sequences to a collector for testing.
Usage of flowgre barrage:
-config string
Config file to use. Supersedes all given args
-delay int
number of milliseconds between packets sent (default 100)
-dst-range string
CIDR range to use for generating destination IPs for flows (default "10.0.0.0/8")
-port int
destination port used by the flow collector (default 9995)
-server string
servername or IP address of the flow collector (default "127.0.0.1")
-src-range string
CIDR range to use for generating source IPs for flows (default "10.0.0.0/8")
-web
Whether to use the web server or not
-web-ip string
IP address the web server will listen on (default "0.0.0.0")
-web-port int
Port to bind the web server on (default 8080)
-workers int
number of workers to create. Unique sources per worker (default 4)targets:
server1:
ip: 127.0.0.1
port: 9995
workers: 4
delay: 100Record is used to record flows to a file for later replay testing.
Usage of flowgre record:
-db string
Directory to place recorded flows for later replay (default "recorded_flows")
-ip string
IP address record should listen on (default "127.0.0.1")
-port int
listen UDP port (default 9995)
-verbose
Whether to log every packet received. Warning: can be a lot of outputReplay is used to send recorded flows to a target server.
Usage of flowgre replay:
-db string
Directory to read recorded flows from (default "recorded_flows")
-delay int
number of milliseconds between packets sent (default 100)
-loop
Loops the replays forever
-port int
target server UDP port (default 9995)
-server string
target server to replay flows at (default "127.0.0.1")
-verbose
Whether to log every packet received. Warning: can be a lot of output
-workers int
Number of workers to spawn for replay (default 1)Proxy is used to accept flows and relay them to multiple targets.
Usage of flowgre proxy:
-ip string
IP address proxy should listen on (default "127.0.0.1")
-port int
proxy listen UDP port (default 9995)
-target value
Can be passed multiple times in IP:PORT format
-verbose
Whether to log every flow received. Warning: can be a lot of outputFlowgre provides a basic web dashboard that will display the number of workers, how much work they've done and the config used to start Flowgre. The stats shown all come from the stats collector and should match the stdout worker stats.
Licensed to the Flowgre Team under one or more contributor license agreements. The Flowgre Team licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Please see the LICENSE file included in the root directory of the source tree for extended license details.
Please see our Contributing Guidelines for information on how to contribute to Flowgre.
Please see our Code of Conduct for information on maintaining a positive and inclusive community.
flowgre/
├── barrage/ # Barrage mode implementation for continuous traffic generation
├── examples/ # Example configurations and usage scenarios
├── flow/ # Core flow generation logic
├── models/ # Data models used across the application
├── proxy/ # Proxy functionality to relay flows to multiple targets
├── record/ # Record mode implementation for capturing Netflow traffic
├── replay/ # Replay mode implementation for sending recorded traffic
├── scripts/ # Utility scripts for development and testing
├── single/ # Single mode implementation for sequential flow generation
├── utils/ # Helper functions and utilities
├── web/ # Web dashboard for monitoring Flowgre activity
├── .github/ # GitHub Actions workflows and configurations
├── .nfpm/ # NFPM configuration for packaging
├── .openhands/ # OpenHands-specific configurations
├── CODE_OF_CONDUCT.md # Code of Conduct guidelines
├── CONTRIBUTING.md # Contribution guidelines
├── Dockerfile # Docker container definition
├── LICENSE # License information (Apache 2.0)
├── README.md # Project overview and usage instructions
├── flowgre.go # Main entry point for the application
├── go.mod # Go module dependencies
├── go.sum # Go module dependency versions
- Follow Go best practices from Effective Go
- Use
context.Contextfor cancellation propagation
- Write tests in
_test.gofiles - Run tests with race detector:
go test -race ./...
- Keep dependencies minimal
- Prefer standard library packages when possible
Use this template when creating PRs:
## Description
Brief summary of changes made.
## Related Issue
Closes #<issue-number>
## Checklist
- [ ] Code is properly formatted
- [ ] Linting passes
- [ ] Tests added/updated
- [ ] Documentation updated