{"id":15583523,"url":"https://github.com/osiegmar/logback-awslogs-json-encoder","last_synced_at":"2025-09-03T17:35:10.034Z","repository":{"id":49021350,"uuid":"161022854","full_name":"osiegmar/logback-awslogs-json-encoder","owner":"osiegmar","description":"Logback encoder for producing JSON formatted log output for Amazon CloudWatch Logs Insights","archived":false,"fork":false,"pushed_at":"2023-12-10T05:43:01.000Z","size":283,"stargazers_count":13,"open_issues_count":0,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-24T03:45:46.598Z","etag":null,"topics":["cloudwatch-logs","logback"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/osiegmar.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-12-09T09:13:25.000Z","updated_at":"2025-02-20T21:52:06.000Z","dependencies_parsed_at":"2023-01-29T00:01:14.263Z","dependency_job_id":"4a6cacd8-0b7c-4cb0-a077-f8bba2286d50","html_url":"https://github.com/osiegmar/logback-awslogs-json-encoder","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osiegmar%2Flogback-awslogs-json-encoder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osiegmar%2Flogback-awslogs-json-encoder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osiegmar%2Flogback-awslogs-json-encoder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osiegmar%2Flogback-awslogs-json-encoder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/osiegmar","download_url":"https://codeload.github.com/osiegmar/logback-awslogs-json-encoder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250559996,"owners_count":21450168,"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":["cloudwatch-logs","logback"],"created_at":"2024-10-02T20:08:51.633Z","updated_at":"2025-04-24T03:45:49.729Z","avatar_url":"https://github.com/osiegmar.png","language":"Java","readme":"# Logback awslogs JSON encoder\n\n[![build](https://github.com/osiegmar/logback-awslogs-json-encoder/actions/workflows/build.yml/badge.svg)](https://github.com/osiegmar/logback-awslogs-json-encoder/actions/workflows/build.yml)\n[![javadoc](https://javadoc.io/badge2/de.siegmar/logback-awslogs-json-encoder/javadoc.svg)](https://javadoc.io/doc/de.siegmar/logback-awslogs-json-encoder)\n[![Maven Central](https://img.shields.io/maven-central/v/de.siegmar/logback-awslogs-json-encoder.svg)](https://central.sonatype.com/artifact/de.siegmar/logback-awslogs-json-encoder)\n\nLogback encoder for producing JSON output that is handled by\nAWS [CloudWatch Logs Insights](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html). This\nlibrary has no external dependencies and thus very light footprint.\n\nSince version 1.3.8, Logback ships with a [JsonEncoder](https://logback.qos.ch/manual/encoders.html#JsonEncoder) itself.\nUnfortunately that JsonEncoder produces log output that is poorly suited for use with CloudWatch Logs (Insights).\n\n## Features\n\n- Forwarding of MDC (Mapped Diagnostic Context)\n- Forwarding of caller data\n- Forwarding of static fields\n- Forwarding of exception root cause\n- No runtime dependencies beside Logback\n\n## Requirements\n\n- Java 11\n- Logback 1.4.11\n\n## Prerequisites\n\nEnsure that the task definition of your ECS task uses the `awslogs` log driver.\n\nA full example (excerpt from a full task definition JSON) could look like this:\n\n```json\n{\n  \"logConfiguration\": {\n    \"logDriver\": \"awslogs\",\n    \"options\": {\n      \"awslogs-group\": \"myloggroup\",\n      \"awslogs-region\": \"eu-central-1\"\n    }\n  }\n}\n```\n\n## Configuration\n\nA basic configuration with defaults would look like this:\n\n```xml\n\u003cconfiguration\u003e\n\n    \u003cappender name=\"STDOUT\" class=\"ch.qos.logback.core.ConsoleAppender\"\u003e\n        \u003cencoder class=\"de.siegmar.logbackawslogsjsonencoder.AwsJsonLogEncoder\"/\u003e\n    \u003c/appender\u003e\n\n    \u003croot level=\"DEBUG\"\u003e\n        \u003cappender-ref ref=\"STDOUT\"/\u003e\n    \u003c/root\u003e\n\n\u003c/configuration\u003e\n```\n\nAn extended version (with all default values set explicitly, custom static fields and mapper) would look like this:\n\n```xml\n\u003cconfiguration\u003e\n\n  \u003cappender name=\"STDOUT\" class=\"ch.qos.logback.core.ConsoleAppender\"\u003e\n    \u003cencoder class=\"de.siegmar.logbackawslogsjsonencoder.AwsJsonLogEncoder\"\u003e\n      \u003cincludeTimestamp\u003etrue\u003c/includeTimestamp\u003e\n      \u003cincludeNanoseconds\u003efalse\u003c/includeNanoseconds\u003e\n      \u003cincludeSequenceNumber\u003efalse\u003c/includeSequenceNumber\u003e\n      \u003cincludeLevelName\u003etrue\u003c/includeLevelName\u003e\n      \u003cincludeThreadName\u003etrue\u003c/includeThreadName\u003e\n      \u003cincludeLoggerName\u003etrue\u003c/includeLoggerName\u003e\n      \u003cincludeFormattedMessage\u003etrue\u003c/includeFormattedMessage\u003e\n      \u003cincludeRawMessage\u003efalse\u003c/includeRawMessage\u003e\n      \u003cincludeStacktrace\u003etrue\u003c/includeStacktrace\u003e\n      \u003cincludeRootCause\u003efalse\u003c/includeRootCause\u003e\n      \u003cincludeMarker\u003etrue\u003c/includeMarker\u003e\n      \u003cincludeMdc\u003etrue\u003c/includeMdc\u003e\n      \u003cincludeKeyValues\u003etrue\u003c/includeKeyValues\u003e\n      \u003cincludeCaller\u003efalse\u003c/includeCaller\u003e\n\n      \u003cstaticField\u003eapp_name:backend\u003c/staticField\u003e\n      \u003cstaticField\u003eos_arch:${os.arch}\u003c/staticField\u003e\n\n      \u003ccustomMapper class=\"your.custom.Mapper\"/\u003e\n    \u003c/encoder\u003e\n  \u003c/appender\u003e\n\n  \u003croot level=\"DEBUG\"\u003e\n    \u003cappender-ref ref=\"STDOUT\"/\u003e\n  \u003c/root\u003e\n\n\u003c/configuration\u003e\n```\n\n## Example output\n\nTypical output:\n\n```json\n{\n  \"timestamp\": 1698595093642,\n  \"level\": \"DEBUG\",\n  \"thread\": \"Test worker\",\n  \"logger\": \"my.app.MyClass\",\n  \"message\": \"Message 1\"\n}\n```\n\nMaximal output:\n\n```json\n{\n  \"timestamp\": 1698595093642,\n  \"nanoseconds\": 642725000,\n  \"sequenceNumber\": 0,\n  \"level\": \"DEBUG\",\n  \"thread\": \"Test worker\",\n  \"logger\": \"my.app.MyClass\",\n  \"message\": \"Message 1\",\n  \"rawMessage\": \"Message {}\",\n  \"markers\": {\n    \"foo\": 1,\n    \"bar\": 1\n  },\n  \"mdc\": {\n    \"foo\": \"bar\",\n    \"baz\": null\n  },\n  \"keyValues\": {\n    \"foo\": \"bar\",\n    \"bar\": null,\n    \"null\": \"bar\"\n  },\n  \"caller\": {\n    \"file\": \"NativeMethodAccessorImpl.java\",\n    \"line\": -2,\n    \"class\": \"jdk.internal.reflect.NativeMethodAccessorImpl\",\n    \"method\": \"invoke0\"\n  },\n  \"stacktrace\": \"java.lang.IllegalStateException: Error processing data\\n\\tat my.app.MyClass.foo(MyClass.java:123)\",\n  \"rootCause\": {\n    \"class\": \"java.lang.IllegalStateException\",\n    \"message\": \"Error processing data\"\n  },\n  \"staticFields\": {\n    \"app_name\": \"backend\",\n    \"os_arch\": \"amd64\"\n  },\n  \"custom\": \"A field added by a custom mapper\"\n}\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosiegmar%2Flogback-awslogs-json-encoder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosiegmar%2Flogback-awslogs-json-encoder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosiegmar%2Flogback-awslogs-json-encoder/lists"}