{"id":27253437,"url":"https://github.com/marselester/json-log-formatter","last_synced_at":"2025-05-15T14:03:16.866Z","repository":{"id":45327041,"uuid":"41723726","full_name":"marselester/json-log-formatter","owner":"marselester","description":"Python JSON log formatter","archived":false,"fork":false,"pushed_at":"2025-02-27T23:13:53.000Z","size":53,"stargazers_count":115,"open_issues_count":1,"forks_count":31,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-28T07:21:43.843Z","etag":null,"topics":["json-logging","python"],"latest_commit_sha":null,"homepage":null,"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/marselester.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-09-01T07:27:49.000Z","updated_at":"2025-02-27T23:13:33.000Z","dependencies_parsed_at":"2024-03-10T01:31:09.211Z","dependency_job_id":"5264a3a4-c84b-4122-afa3-50d1c678c623","html_url":"https://github.com/marselester/json-log-formatter","commit_stats":{"total_commits":36,"total_committers":7,"mean_commits":5.142857142857143,"dds":0.5,"last_synced_commit":"6d054cb68f0765b328c4a2be66dc218a64b6f947"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marselester%2Fjson-log-formatter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marselester%2Fjson-log-formatter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marselester%2Fjson-log-formatter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marselester%2Fjson-log-formatter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marselester","download_url":"https://codeload.github.com/marselester/json-log-formatter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248324231,"owners_count":21084669,"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","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":["json-logging","python"],"created_at":"2025-04-11T01:27:36.639Z","updated_at":"2025-04-11T01:27:38.843Z","avatar_url":"https://github.com/marselester.png","language":"Python","readme":"=====================\nJSON log formatter 🪵\n=====================\n\nThe library helps you to store logs in JSON format. Why is it important?\nWell, it facilitates integration with **Logstash**.\n\nUsage example:\n\n.. code-block:: python\n\n    import logging\n\n    import json_log_formatter\n\n    formatter = json_log_formatter.JSONFormatter()\n\n    json_handler = logging.FileHandler(filename='/var/log/my-log.json')\n    json_handler.setFormatter(formatter)\n\n    logger = logging.getLogger('my_json')\n    logger.addHandler(json_handler)\n    logger.setLevel(logging.INFO)\n\n    logger.info('Sign up', extra={'referral_code': '52d6ce'})\n\n    try:\n        raise ValueError('something wrong')\n    except ValueError:\n        logger.error('Request failed', exc_info=True)\n\nThe log file will contain the following log record (inline).\n\n.. code-block:: json\n\n    {\n        \"message\": \"Sign up\",\n        \"time\": \"2015-09-01T06:06:26.524448\",\n        \"referral_code\": \"52d6ce\"\n    }\n    {\n        \"message\": \"Request failed\",\n        \"time\": \"2015-09-01T06:06:26.524449\",\n        \"exc_info\": \"Traceback (most recent call last): ...\"\n    }\n\nIf you use a log collection and analysis system,\nyou might need to include the built-in\n`log record attributes \u003chttps://docs.python.org/3/library/logging.html#logrecord-attributes\u003e`_\nwith ``VerboseJSONFormatter``.\n\n.. code-block:: python\n\n    json_handler.setFormatter(json_log_formatter.VerboseJSONFormatter())\n    logger.error('An error has occured')\n\n.. code-block:: json\n\n    {\n        \"filename\": \"tests.py\",\n        \"funcName\": \"test_file_name_is_testspy\",\n        \"levelname\": \"ERROR\",\n        \"lineno\": 276,\n        \"module\": \"tests\",\n        \"name\": \"my_json\",\n        \"pathname\": \"/Users/bob/json-log-formatter/tests.py\",\n        \"process\": 3081,\n        \"processName\": \"MainProcess\",\n        \"stack_info\": null,\n        \"thread\": 4664270272,\n        \"threadName\": \"MainThread\",\n        \"message\": \"An error has occured\",\n        \"time\": \"2021-07-04T21:05:42.767726\"\n    }\n\nIf you need to flatten complex objects as strings, use ``FlatJSONFormatter``.\n\n.. code-block:: python\n\n    json_handler.setFormatter(json_log_formatter.FlatJSONFormatter())\n    logger.error('An error has occured')\n\n    logger.info('Sign up', extra={'request': WSGIRequest({\n        'PATH_INFO': 'bogus',\n        'REQUEST_METHOD': 'bogus',\n        'CONTENT_TYPE': 'text/html; charset=utf8',\n        'wsgi.input': BytesIO(b''),\n    })})\n\n.. code-block:: json\n\n    {\n        \"message\": \"Sign up\",\n        \"time\": \"2024-10-01T00:59:29.332888+00:00\",\n        \"request\": \"\u003cWSGIRequest: BOGUS '/bogus'\u003e\"\n    }\n\nJSON libraries\n--------------\n\nYou can use **ujson** or **simplejson** instead of built-in **json** library.\n\n.. code-block:: python\n\n    import json_log_formatter\n    import ujson\n\n    formatter = json_log_formatter.JSONFormatter()\n    formatter.json_lib = ujson\n\nNote, **ujson** doesn't support ``dumps(default=f)`` argument:\nif it can't serialize an attribute, it might fail with ``TypeError`` or skip an attribute.\n\nDjango integration\n------------------\n\nHere is an example of how the JSON formatter can be used with Django.\n\n.. code-block:: python\n\n    LOGGING['formatters']['json'] = {\n        '()': 'json_log_formatter.JSONFormatter',\n    }\n    LOGGING['handlers']['json_file'] = {\n        'level': 'INFO',\n        'class': 'logging.FileHandler',\n        'filename': '/var/log/my-log.json',\n        'formatter': 'json',\n    }\n    LOGGING['loggers']['my_json'] = {\n        'handlers': ['json_file'],\n        'level': 'INFO',\n    }\n\nLet's try to log something.\n\n.. code-block:: python\n\n    import logging\n\n    logger = logging.getLogger('my_json')\n\n    logger.info('Sign up', extra={'referral_code': '52d6ce'})\n\nCustom formatter\n----------------\n\nYou will likely need a custom log formatter. For instance, you want to log\na user ID, an IP address and ``time`` as ``django.utils.timezone.now()``.\nTo do so you should override ``JSONFormatter.json_record()``.\n\n.. code-block:: python\n\n    class CustomisedJSONFormatter(json_log_formatter.JSONFormatter):\n        def json_record(self, message: str, extra: dict, record: logging.LogRecord) -\u003e dict:\n            extra['message'] = message\n            extra['user_id'] = current_user_id()\n            extra['ip'] = current_ip()\n\n            # Include builtins\n            extra['level'] = record.levelname\n            extra['name'] = record.name\n\n            if 'time' not in extra:\n                extra['time'] = django.utils.timezone.now()\n\n            if record.exc_info:\n                extra['exc_info'] = self.formatException(record.exc_info)\n\n            return extra\n\nLet's say you want ``datetime`` to be serialized as timestamp.\nYou can use **ujson** (which does it by default) and disable\nISO8601 date mutation.\n\n.. code-block:: python\n\n    class CustomisedJSONFormatter(json_log_formatter.JSONFormatter):\n        json_lib = ujson\n\n        def mutate_json_record(self, json_record):\n            return json_record\n\nTests\n-----\n\n.. code-block:: console\n\n    $ pip install -r requirements.txt\n    $ tox\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarselester%2Fjson-log-formatter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarselester%2Fjson-log-formatter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarselester%2Fjson-log-formatter/lists"}