{ "info": { "author": "Pier Carlo Chiodi", "author_email": "pierky@pierky.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Intended Audience :: Information Technology", "Intended Audience :: Science/Research", "Intended Audience :: System Administrators", "Intended Audience :: Telecommunications Industry", "Operating System :: POSIX", "Operating System :: Unix", "Programming Language :: Python :: 2.7", "Topic :: Internet :: WWW/HTTP", "Topic :: System :: Monitoring", "Topic :: System :: Networking", "Topic :: System :: Networking :: Monitoring" ], "description": "pmacct-to-elasticsearch\n=======================\n\n**pmacct-to-elasticsearch** is a python script designed to read output from **pmacct** daemons, to process it and to store it into **ElasticSearch**. It works with both *memory* and *print* plugins and, optionally, it can perform **manipulations on data** (such as to add fields on the basis of other values).\n\n.. image:: img/data_flow.png\n :align: center\n\n1. **pmacct daemons** collect IP accounting data and process them with their plugins;\n2. data are stored into **in-memory-tables** (*memory* plugins), **JSON or CSV files** (*print* plugins);\n3. **crontab jobs** (*memory* plugins) or **trigger scripts** (*print* plugins) are invoked to execute pmacct-to-elasticsearch;\n4. pmacct's output records are finally processed by **pmacct-to-elasticsearch**, which reads them from stdin (*memory* plugins) or directly from file.\n\nOptionally, some **data transformations** can be configured, to allow pmacct-to-elasticsearch to **add or remove fields** to/from the output documents that are sent to ElasticSearch for indexing. These additional fields may be useful to enhance graphs and reports legibility, or to add a further level of aggregation or filtering.\n\nInstallation\n------------\n\nInstall the program using pip:\n\n.. code:: bash\n\n pip install pmacct-to-elasticsearch\n \nThen clone the repository and run the ./install script to setup your system:\n\n.. code:: bash\n\n cd /usr/local/src/\n git clone https://github.com/pierky/pmacct-to-elasticsearch.git\n cd pmacct-to-elasticsearch/\n ./install\n \nConfiguration\n-------------\n\nPlease refer to the `CONFIGURATION.md`_ file. The `TRANSFORMATIONS.md`_ file contains details about data transformations configuration.\n\n.. _CONFIGURATION.md: CONFIGURATION.md\n.. _TRANSFORMATIONS.md: TRANSFORMATIONS.md\n\nA simple tutorial on pmacct integration with ElasticSearch/Kibana using pmacct-to-elasticsearch can be found at http://blog.pierky.com/integration-of-pmacct-with-elasticsearch-and-kibana.\n\nFuture work\n-----------\n\n- Add support of more pmacct output formats (Apache Avro, ...).\n\nAuthor\n------\n\nPier Carlo Chiodi - https://pierky.com/\n\nBlog: https://blog.pierky.com/ Twitter: `@pierky `_\n\n\nChangelog\n=========\n\n0.3.2\n-----\n\n- Code linting and fixing import and pip3 errors.\n\n Thanks to `@palisadoes (Peter Harrison) ` for these fixes.\n\n0.3.1\n-----\n\n- Fix: ES 6.2 compatibility.\n\n `Issue #9 `.\n\n0.3.0\n-----\n\n- New: **CSV** output support.\n\n The ``InputFormat`` option in the plugin configuration file can be used to instruct pmacct-to-elasticsearch to parse CSV output from pmacct.\n\n- New: **Multithreading** support.\n\n The ``ReaderThreads`` option in the plugin configuration file sets the number of threads used to process pmacct's output.\n\n- New: More command line arguments.\n\n The command line arguments under the *Configuration options* group can be used to override settings done on the plugin configuration file.\n\n- Fix issue with index creation on ElasticSearch 5.x.\n\n Thanks to Kristoffer Olsson and Daniel Lindberg for reporting this and for their extensive support.\n\n- Improved template for index creation.\n\n- Fix an issue with transformations.\n\n0.2.0\n-----\n\n- New feature: HTTP Authentication support for ES API.\n\n0.1.0\n-----\n\nFirst release.", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/pierky/pmacct-to-elasticsearch", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/pierky/pmacct-to-elasticsearch", "keywords": "pmacct,NetFlow,accounting,BGP", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "pmacct-to-elasticsearch", "package_url": "https://pypi.org/project/pmacct-to-elasticsearch/", "platform": "", "project_url": "https://pypi.org/project/pmacct-to-elasticsearch/", "project_urls": { "Download": "https://github.com/pierky/pmacct-to-elasticsearch", "Homepage": "https://github.com/pierky/pmacct-to-elasticsearch" }, "release_url": "https://pypi.org/project/pmacct-to-elasticsearch/0.3.2/", "requires_dist": null, "requires_python": "", "summary": "A Python script designed to read output from pmacct daemons, to process it and to store it into ElasticSearch.", "version": "0.3.2" }, "last_serial": 5932052, "releases": { "0.3.0": [ { "comment_text": "", "digests": { "md5": "972455d78ce2648cc97640dda1b62824", "sha256": "4fb5dffe0491407e8ac1723e9bd3eed548b80fb3506d563ea32fe1d24c58279b" }, "downloads": -1, "filename": "pmacct-to-elasticsearch-0.3.0.tar.gz", "has_sig": false, "md5_digest": "972455d78ce2648cc97640dda1b62824", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12424, "upload_time": "2017-05-15T16:42:15", "url": "https://files.pythonhosted.org/packages/4b/b7/0ae4c4c83d28f69455b5c5d30a6a168f8b134aa67f5450f6c30f02d6eae8/pmacct-to-elasticsearch-0.3.0.tar.gz" } ], "0.3.0a1": [ { "comment_text": "", "digests": { "md5": "9d1912361dd7eccd7837b8f631561ea1", "sha256": "753c8904448373c33df0fc23aef46d340b46a691a6103188c784764eaa82d379" }, "downloads": -1, "filename": "pmacct-to-elasticsearch-0.3.0a1.tar.gz", "has_sig": false, "md5_digest": "9d1912361dd7eccd7837b8f631561ea1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10258, "upload_time": "2017-01-24T19:47:26", "url": "https://files.pythonhosted.org/packages/b6/e2/b8a7227cd2ab9d6306bce1d24c6edc794604c07cc036fffc0d3075c9e0da/pmacct-to-elasticsearch-0.3.0a1.tar.gz" } ], "0.3.0a2": [ { "comment_text": "", "digests": { "md5": "5e76c3e1ebc5fec8ec72f13f3b480fe5", "sha256": "647de57298ae3ada2a892fb9101dd1421ab07d576f1b3707c83038687d0ee37e" }, "downloads": -1, "filename": "pmacct-to-elasticsearch-0.3.0a2.tar.gz", "has_sig": false, "md5_digest": "5e76c3e1ebc5fec8ec72f13f3b480fe5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10806, "upload_time": "2017-01-24T21:29:23", "url": "https://files.pythonhosted.org/packages/6d/82/eda22b563c25276810898de36efa39b457b2d30bc898793dda5d4f423968/pmacct-to-elasticsearch-0.3.0a2.tar.gz" } ], "0.3.0a3": [ { "comment_text": "", "digests": { "md5": "0e9ec0faaf96be38465065378289e5b1", "sha256": "d5cbd36247bdcbcbc622c6626b3a487cc853b74528b56938666fd62821263687" }, "downloads": -1, "filename": "pmacct-to-elasticsearch-0.3.0a3.tar.gz", "has_sig": false, "md5_digest": "0e9ec0faaf96be38465065378289e5b1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12173, "upload_time": "2017-01-25T20:15:55", "url": "https://files.pythonhosted.org/packages/3e/1f/6ff80482599929609d63eae8ac849ecd44138d44859ff370b0930da1391e/pmacct-to-elasticsearch-0.3.0a3.tar.gz" } ], "0.3.0a4": [ { "comment_text": "", "digests": { "md5": "a1047e6d7acc5b6142ef353253a69872", "sha256": "6e080437e069cc6260128dd61d53e9c0ac09954e17360169dff0221eaed5e827" }, "downloads": -1, "filename": "pmacct-to-elasticsearch-0.3.0a4.tar.gz", "has_sig": false, "md5_digest": "a1047e6d7acc5b6142ef353253a69872", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12114, "upload_time": "2017-02-16T17:30:39", "url": "https://files.pythonhosted.org/packages/bd/d2/d6f6751f797fb554d4f162f139882d4d77775d5fc2679061f5d9a0cee057/pmacct-to-elasticsearch-0.3.0a4.tar.gz" } ], "0.3.0a5": [ { "comment_text": "", "digests": { "md5": "859f4e0f6b0608c6dd4e9ea3ae6d3d73", "sha256": "a658ee07c0d3effc94e2a11cbc1a4a2fc2c6271300ed804cf26309dd0db64f60" }, "downloads": -1, "filename": "pmacct-to-elasticsearch-0.3.0a5.tar.gz", "has_sig": false, "md5_digest": "859f4e0f6b0608c6dd4e9ea3ae6d3d73", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12398, "upload_time": "2017-05-03T16:54:31", "url": "https://files.pythonhosted.org/packages/05/d5/1fbe0fc2e6414fb67fcd056ded8a4d6e47b73c951ab2e54aac887c074858/pmacct-to-elasticsearch-0.3.0a5.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "25ed40effc3bc92f82331b3bb3009a7c", "sha256": "63c93860da4529f41e8ebaca184b08f74b957e084560bab232dff0d67b843257" }, "downloads": -1, "filename": "pmacct-to-elasticsearch-0.3.1.tar.gz", "has_sig": false, "md5_digest": "25ed40effc3bc92f82331b3bb3009a7c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12482, "upload_time": "2018-03-12T17:53:02", "url": "https://files.pythonhosted.org/packages/c9/70/322b028c393379da85329c8834ce3b6509a7f281f3d05eeff69334eb4e32/pmacct-to-elasticsearch-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "96f6330fae483c44f5ac0c22c71c71b9", "sha256": "f24f83a0db1d7398c7262ccd3e124a10ce15f1d04b928bf14739adf0460c37c5" }, "downloads": -1, "filename": "pmacct-to-elasticsearch-0.3.2.tar.gz", "has_sig": false, "md5_digest": "96f6330fae483c44f5ac0c22c71c71b9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12548, "upload_time": "2019-10-01T07:00:52", "url": "https://files.pythonhosted.org/packages/b2/58/0d1621f1896fc8fd4eb5c501763e3e14d1b04a21446e1017f45e7dd31ae9/pmacct-to-elasticsearch-0.3.2.tar.gz" } ], "0.3.3a1": [ { "comment_text": "", "digests": { "md5": "94977871f345919e37a986401c4b99e3", "sha256": "fa1b725c8ad68723b30155289a702aaf2f2437ae85a49348878cd7a7dfdd0e6d" }, "downloads": -1, "filename": "pmacct-to-elasticsearch-0.3.3a1.tar.gz", "has_sig": false, "md5_digest": "94977871f345919e37a986401c4b99e3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12577, "upload_time": "2019-10-05T13:44:47", "url": "https://files.pythonhosted.org/packages/cc/44/5b2f21de621de9a086112b26824bb2f8a64156e7dbd20a2f24e5023f3810/pmacct-to-elasticsearch-0.3.3a1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "96f6330fae483c44f5ac0c22c71c71b9", "sha256": "f24f83a0db1d7398c7262ccd3e124a10ce15f1d04b928bf14739adf0460c37c5" }, "downloads": -1, "filename": "pmacct-to-elasticsearch-0.3.2.tar.gz", "has_sig": false, "md5_digest": "96f6330fae483c44f5ac0c22c71c71b9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12548, "upload_time": "2019-10-01T07:00:52", "url": "https://files.pythonhosted.org/packages/b2/58/0d1621f1896fc8fd4eb5c501763e3e14d1b04a21446e1017f45e7dd31ae9/pmacct-to-elasticsearch-0.3.2.tar.gz" } ] }