Analayze HAProxy log files
Project description
This Python package is a HAProxy log parser. It analyzes HAProxy log files in multiple ways (see commands section below).
Tests and coverage
No project is trustworthy if does not have tests and a decent coverage!
Documentation
See the documentation and API at ReadTheDocs.
Command-line interface
The current --help looks like this:
usage: haproxy_log_analysis [-h] [-l LOG] [-s START] [-d DELTA] [-c COMMAND] [-f FILTER] [-n] [--list-commands] [--list-filters] [--json] Analyze HAProxy log files and outputs statistics about it optional arguments: -h, --help show this help message and exit -l LOG, --log LOG HAProxy log file to analyze -s START, --start START Process log entries starting at this time, in HAProxy date format (e.g. 11/Dec/2013 or 11/Dec/2013:19:31:41). At least provide the day/month/year. Values not specified will use their base value (e.g. 00 for hour). Use in conjunction with -d to limit the number of entries to process. -d DELTA, --delta DELTA Limit the number of entries to process. Express the time delta as a number and a time unit, e.g.: 1s, 10m, 3h or 4d (for 1 second, 10 minutes, 3 hours or 4 days). Use in conjunction with -s to only analyze certain time delta. If no start time is given, the time on the first line will be used instead. -c COMMAND, --command COMMAND List of commands, comma separated, to run on the log file. See --list-commands to get a full list of them. -f FILTER, --filter FILTER List of filters to apply on the log file. Passed as comma separated and parameters within square brackets, e.g ip[192.168.1.1],ssl,path[/some/path]. See --list- filters to get a full list of them. -n, --negate-filter Make filters passed with -f work the other way around, i.e. if the ``ssl`` filter is passed instead of showing only ssl requests it will show non-ssl traffic. If the ``ip`` filter is used, then all but that ip passed to the filter will be used. --list-commands Lists all commands available. --list-filters Lists all filters available. --json Output results in json. --invalid Print the lines that could not be parsed. Be aware that mixing it with the print command will mix their output.
Commands
Commands are small purpose specific programs in themselves that report specific statistics about the log file being analyzed. See them all with --list-commands or online at https://haproxy-log-analyzer.readthedocs.io/modules.html#module-haproxy.commands.
average_response_time
average_waiting_time
connection_type
counter
http_methods
ip_counter
print
queue_peaks
request_path_counter
requests_per_hour
requests_per_minute
server_load
slow_requests
slow_requests_counter
status_codes_counter
top_ips
top_request_paths
Filters
Filters, contrary to commands, are a way to reduce the amount of log lines to be processed.
See them all with --list-filters or online at https://haproxy-log-analyzer.readthedocs.io/modules.html#module-haproxy.filters.
backend
frontend
http_method
ip
ip_range
path
response_size
server
slow_requests
ssl
status_code
status_code_family
wait_on_queues
Installation
After installation you will have a console script haproxy_log_analysis:
$ pip install haproxy_log_analysis
TODO
add more commands: (help appreciated)
reports on servers connection time
reports on termination state
reports around connections (active, frontend, backend, server)
your ideas here
think of a way to show the commands output in a meaningful way
be able to specify an output format. For any command that makes sense (slow requests for example) output the given fields for each log line (i.e. acceptance date, path, downstream server, load at that time…)
your ideas
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for haproxy_log_analysis-6.0.0a3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1c25c92f84d17f71d1f501be59f07236173c6d73da1507d887b684155bdd612 |
|
MD5 | ba4e7694fde8fc7d1f23f3b832ef7108 |
|
BLAKE2b-256 | fb1fb6436362dc8969c57bd623e6bd2e44d69d57bb17cff7f96a65644f3875b5 |
Hashes for haproxy_log_analysis-6.0.0a3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c186325d41e49b2af258f9ff20601d1048ecf5feb57fc161431fa7f4df83d6dd |
|
MD5 | 1c6235cc816e6413e224d34051353cf0 |
|
BLAKE2b-256 | 2772332161ae09fd8f71739c5b04af341a85cb4abd927660b9c16e05bcc1b188 |