{
"info": {
"author": "Jerry Pussinen",
"author_email": "jerry.pussinen@gmail.com",
"bugtrack_url": null,
"classifiers": [
"License :: OSI Approved :: MIT License",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7"
],
"description": "# LogPlot\n\n[](https://travis-ci.org/jerry-git/logplot)\n[](https://pypi.python.org/pypi/logplot/)\n[](https://pypi.python.org/pypi/logplot/)\n[](https://codecov.io/gh/jerry-git/logplot)\n[](https://github.com/jerry-git/logplot/blob/master/LICENSE)\n[](http://makeapullrequest.com)\n\n\n
\n \n
\n\n\n## Installation\n $ pip3 install logplot\n \n## Usage\n\n### Configuration\nIn order to plot interesting graphs from custom logs, `logplot` needs to know what log entries are considered interesting. \nThis can be done by defining `entries` and `special_entries` sections in the config file. \nThe main purpose of `entries` is to plot trends, i.e. connected points. This is useful e.g. for plotting state machine states. \n`special_entries` is for plotting single, unconnected points, such as errors.\n\nEach entry in `entries` and `special_entries` should have the following:\n* `identifier`: string to be searched from log entries\n* `value`: y-axis value in the plot\n\nIdeally, one entry in `entries` should have `initial_state: true`. This is used for separating plotted series from each other.\n\nYou can define specific marker style for each entry in `special_entries`, refer to [`matplotlib` docs](https://matplotlib.org/api/markers_api.html) for available options.\n\n\nIn addition to the `entries` and `special-entries` sections, user can override default settings (see src/logplot/default_conf.yaml) in `general` section. \nFor example, it's the place where you can define the command to be used for opening the log in your favorite editor. \n \nSee doc/example/user_conf.yaml and corresponding log file (doc/example/log.txt) for full example.\n\n### Plotting logs\n\n $ logplot path/to/log -c path/to/conf/file\n \nFor example, this:\n\n $ logplot doc/examples/log.txt -c doc/examples/user_conf.yaml\n\nyields this:\n\n
\n \n
\n\nClicking a data point in the plot opens the log file in the correct line number in the editor defined in the configuration file.\nIf the `log_open_cmd` is not configured, the log will be opened with a default program defined by the OS. \nNote that `log_open_cmd` has to configured to be able to open the log in the correct line number.\n\n`logplot` will automatically identify different trends in the plotted entries. \nYou can toggle the visibility of these trends by clicking items in the legend.\n\nHere's an example of a bit bigger log which contains 100k entries, 13 different states, and 15 different trends.\n\n\t$ logplot doc/examples/log_huge.txt -c doc/examples/user_conf_huge.yaml\n\n
\n \n
\n\nAnd the same with three most occuring trends filtered out.\n\n
![\"example](\"https://github.com/jerry-git/logplot/blob/master/doc/examples/example.gif\")
\n![\"example](\"https://github.com/jerry-git/logplot/blob/master/doc/examples/plot.png\")
\n![\"example](\"https://github.com/jerry-git/logplot/blob/master/doc/examples/plot_huge.png\")
\n![\"example](\"https://github.com/jerry-git/logplot/blob/master/doc/examples/plot_huge_filtered.png\")
\n