# README
Flog
flog is a fake log generator for common log formats such as apache-common, apache error and RFC3164 syslog.
It is useful for testing some tasks which require log data like amazon kinesis log stream test.
Thanks to gofakeit 😘
Installation
Using go get
go get -u github.com/mingrammer/flog
It is recommended to also run dep ensure
to make sure that the dependencies are in the correct versions.
Using homebrew
brew tap mingrammer/flog
brew install flog
Using .tar.gz archive
Download gzip file from Github Releases according to your OS. Then, copy the unzipped executable to under system path.
Using docker
docker run -it --rm mingrammer/flog
Usage
There are useful options. (flog --help
)
Options:
-f, --format string log format. available formats:
- apache_common (default)
- apache_combined
- apache_error
- rfc3164
- rfc5424
- json
-o, --output string output filename. Path-like is allowed. (default "generated.log")
-t, --type string log output type. available types:
- stdout (default)
- log
- gz
-n, --number integer number of lines to generate.
-b, --bytes integer size of logs to generate (in bytes).
"bytes" will be ignored when "number" is set.
-s, --sleep duration fix creation time interval for each log (default unit "seconds"). It does not actually sleep.
examples: 10, 20ms, 5s, 1m
-d, --delay duration delay log generation speed (default unit "seconds").
examples: 10, 20ms, 5s, 1m
-p, --split-by integer set the maximum number of lines or maximum size in bytes of a log file.
with "number" option, the logs will be split whenever the maximum number of lines is reached.
with "byte" option, the logs will be split whenever the maximum size in bytes is reached.
-w, --overwrite overwrite the existing log files.
-l, --loop loop output forever until killed.
# Generate 1000 lines of logs to stdout
$ flog
# Generate 200 lines of logs with a time interval of 10s for each log. It doesn't actually sleep while generating
$ flog -s 10s -n 200
# Generate a single log file with 1000 lines of logs, then overwrite existing log file
$ flog -t log -w
# Generate a single log gzip file with 3000 lines of logs every 300ms. It actually sleep (delay) while generating
$ flog -t gz -o log.gz -n 3000 -d 10s
# Generate logs up to 10MB and split log files every 1MB in "web/log/*.log" path with "apache combined" format
$ flog -t log -f apache_combined -o web/log/apache.log -b 10485760 -p 1048576
# Generate logs in rfc3164 format infinitely until killed
$ flog -f rfc3164 -l
Supported Formats
- Apache common
- Apache combined
- Apache error
- RFC3164
- RFC5424
- Common log fomat
- JSON
Supported Outputs
- Stdout
- File
- Gzip
License
# Functions
Generate generates the logs with given options.
NewApacheCombinedLog creates a log string with apache combined log format.
NewApacheCommonLog creates a log string with apache common log format.
NewApacheErrorLog creates a log string with apache error log format.
NewCommonLogFormat creates a log string with common log format.
NewJSONLogFormat creates a log string with json log format.
NewLog creates a log for given format.
NewRFC3164Log creates a log string with syslog (RFC3164) format.
NewRFC5424Log creates a log string with syslog (RFC5424) format.
NewSplitFileName creates a new file path with split count.
NewWriter returns a closeable writer corresponding to given log type.
ParseBytes validates the given bytes.
ParseDelay validates the given sleep.
ParseFormat validates the given format.
ParseNumber validates the given number.
ParseOptions parses given parameters from command line.
ParseSleep validates the given sleep.
ParseSplitBy validates the given split-by.
ParseType validates the given type.
RandAuthUserID generates a random auth user id.
RandHTTPVersion returns a random http version.
RandResourceURI generates a random resource URI.
Run checks overwrite flag and generates logs with given options.
# Constants
Custom predefined layouts.
ApacheCombinedLog : {host} {user-identifier} {auth-user-id} [{datetime}] "{method} {request} {protocol}" {response-code} {bytes} "{referrer}" "{agent}".
ApacheCommonLog : {host} {user-identifier} {auth-user-id} [{datetime}] "{method} {request} {protocol}" {response-code} {bytes}.
Custom predefined layouts.
ApacheErrorLog : [{timestamp}] [{module}:{severity}] [pid {pid}:tid {thread-id}] [client %{client}:{port}] %{message}.
Custom predefined layouts.
CommonLogFormat : {host} {user-identifier} {auth-user-id} [{datetime}] "{method} {request} {protocol}" {response-code} {bytes}.
JSONLogFormat : {"host": "{host}", "user-identifier": "{user-identifier}", "datetime": "{datetime}", "method": "{method}", "request": "{request}", "protocol": "{protocol}", "status", {status}, "bytes": {bytes}, "referer": "{referer}"}.
Custom predefined layouts.
RFC3164Log : <priority>{timestamp} {hostname} {application}[{pid}]: {message}.
Custom predefined layouts.
RFC5424Log : <priority>{version} {iso-timestamp} {hostname} {application} {pid} {message-id} {structured-data} {message}.