{"id":15501624,"url":"https://github.com/rcourivaud/MagicLogger","last_synced_at":"2025-10-12T06:31:44.355Z","repository":{"id":62576785,"uuid":"111118407","full_name":"rcourivaud/MagicLogger","owner":"rcourivaud","description":"✨ Simple magic Python API to handle logging easily ✨","archived":false,"fork":false,"pushed_at":"2018-11-19T16:32:54.000Z","size":94,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-22T16:50:07.363Z","etag":null,"topics":["elasticsearch","logger","logging","logstash","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rcourivaud.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-17T15:23:06.000Z","updated_at":"2018-11-19T16:32:56.000Z","dependencies_parsed_at":"2022-11-03T20:45:40.401Z","dependency_job_id":null,"html_url":"https://github.com/rcourivaud/MagicLogger","commit_stats":null,"previous_names":["rcourivaud/logstash_logger"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rcourivaud/MagicLogger","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rcourivaud%2FMagicLogger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rcourivaud%2FMagicLogger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rcourivaud%2FMagicLogger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rcourivaud%2FMagicLogger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rcourivaud","download_url":"https://codeload.github.com/rcourivaud/MagicLogger/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rcourivaud%2FMagicLogger/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279010507,"owners_count":26084757,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-12T02:00:06.719Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elasticsearch","logger","logging","logstash","python"],"created_at":"2024-10-02T09:05:04.697Z","updated_at":"2025-10-12T06:31:43.615Z","avatar_url":"https://github.com/rcourivaud.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"===============\nMagicLogger\n===============\n\n\n.. image:: https://img.shields.io/pypi/v/logstash_logger.svg\n        :target: https://pypi.python.org/pypi/logstash_logger\n\n.. image:: https://img.shields.io/travis/rcourivaud/logstash_logger.svg\n        :target: https://travis-ci.org/rcourivaud/logstash_logger\n\n.. image:: https://readthedocs.org/projects/logstash-logger/badge/?version=latest\n        :target: https://logstash-logger.readthedocs.io/en/latest/?badge=latest\n        :alt: Documentation Status\n\n.. image:: https://pyup.io/repos/github/rcourivaud/logstash_logger/shield.svg\n     :target: https://pyup.io/repos/github/rcourivaud/logstash_logger/\n     :alt: Updates\n\n\nLog handler to log better and send logs to Logstash\n\n* Free software: MIT license\n* Documentation: https://logstash-logger.readthedocs.io.\n\n\nFeatures\n--------\n\n.. code-block:: bash\n\n    pip install magic_logger\n\nCredits\n---------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\nRequirements\n------------\n\nEnable your Logstash pipeline to listen to incoming JSON streams on port 5000\n\n.. code-block:: conf\n\n    input {\n        tcp {\n            port =\u003e 5000\n            codec =\u003e json\n        }\n    }\n    output {\n        elasticsearch {\n            hosts =\u003e [\"elasticsearch:9200\"]\n            index =\u003e \"logstash_index\"\n            document_type =\u003e \"logtype\"\n        }\n    stdout { codec =\u003e rubydebug }\n    }\n\nHow to use\n----------\n\n1. Import module\n\n.. code-block:: python\n\n    from magic_logger import MagicLogger\n\n2. Instantiate MagicLogger with a name. Logstash host is changed with `host` parameter.\n   Define your own host in a constant file.\n\n.. code-block:: python\n\n    logger = MagicLogger('Name', host='localhost')\n\n3. Decorate a function in order to log it into Logstash and into the console\n\n.. code-block:: python\n\n    @logger.decorate('This is a message.')\n    def a(*args, **kwargs):\n        return 'This is a return'\n    \n    a('arg_1', 'arg_2', kwarg_1='hello', kwarg_2='world') \n\nTerminal output:\n\n.. code-block:: bash\n\n    2018-05-25 23:09:35,514 - Name - INFO - Connection to logstash successful.\n    2018-05-25 23:09:35,518 - Name - DEBUG - This is a message.\n\nLogstash output:\n\n.. code-block:: bash\n\n    logstash_1       | {\n    logstash_1       |          \"stack_info\" =\u003e nil,\n    logstash_1       |            \"@version\" =\u003e \"1\",\n    logstash_1       |                \"type\" =\u003e \"logstash\",\n    logstash_1       |             \"message\" =\u003e \"This is a message.\",\n    logstash_1       |     \"function_kwargs\" =\u003e {\n    logstash_1       |         \"kwarg_2\" =\u003e \"world\",\n    logstash_1       |         \"kwarg_1\" =\u003e \"hello\"\n    logstash_1       |     },\n    logstash_1       |                \"host\" =\u003e \"Nicolass-MacBook-Pro.local\",\n    logstash_1       |       \"function_name\" =\u003e \"a\",\n    logstash_1       |                \"path\" =\u003e \"/Users/nico/corners/MagicLogger/magic_logger/magic_logger.py\",\n    logstash_1       |               \"class\" =\u003e nil,\n    logstash_1       |                \"port\" =\u003e 51772,\n    logstash_1       |               \"level\" =\u003e \"DEBUG\",\n    logstash_1       |                \"tags\" =\u003e [],\n    logstash_1       |        \"function_res\" =\u003e \"This is a return\",\n    logstash_1       |          \"@timestamp\" =\u003e 2018-05-25T21:09:35.518Z,\n    logstash_1       |      \"execution_time\" =\u003e 5.0e-06,\n    logstash_1       |         \"logger_name\" =\u003e \"Name\",\n    logstash_1       |      \"function_class\" =\u003e nil\n    logstash_1       | }\n\n4. Add an extra to the decorator within the decorated function with the `update_extra` method\n\n.. code-block:: python\n\n    @logger.decorate('This is a message')\n    def a():\n        logger.update_extra(post_extra='This is a new extra')\n        return 'This is a return'\n\n    a()\n\n5. Write a regular log\n\n.. code-block:: python\n\n    test_list = [1, 2, 3]\n    test_string = \"This is a string\"\n    logger.info('This is a message', extra = {\"a_list\": test_list, \"a_string\": test_string})\n\nTerminal output:\n\n.. code-block:: bash\n\n    2018-05-25 17:08:15,654 - Name - INFO - This is a message\n\nLogstash output:\n\n.. code-block:: bash\n\n    logstash_1       | {\n    logstash_1       |      \"@timestamp\" =\u003e 2018-05-25T15:08:15.654Z,\n    logstash_1       |         \"message\" =\u003e \"This is a message\",\n    logstash_1       |            \"type\" =\u003e \"logstash\",\n    logstash_1       |      \"stack_info\" =\u003e nil,\n    logstash_1       |     \"logger_name\" =\u003e \"Name\",\n    logstash_1       |            \"path\" =\u003e \"test.py\",\n    logstash_1       |            \"port\" =\u003e 33542,\n    logstash_1       |        \"@version\" =\u003e \"1\",\n    logstash_1       |          \"a_list\" =\u003e [\n    logstash_1       |         [0] 1,\n    logstash_1       |         [1] 2,\n    logstash_1       |         [2] 3\n    logstash_1       |     ],\n    logstash_1       |        \"a_string\" =\u003e \"This is a string\",\n    logstash_1       |            \"tags\" =\u003e [],\n    logstash_1       |            \"host\" =\u003e \"MBP-C02WC1F4HV2Q.local\",\n    logstash_1       |           \"level\" =\u003e \"INFO\"\n    logstash_1       | }\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frcourivaud%2FMagicLogger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frcourivaud%2FMagicLogger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frcourivaud%2FMagicLogger/lists"}