Release v0.1

Author: sethmlarson

CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 0.1 (2020-03-26)
+
+- Added `StdlibFormatter` for use with the standard library `logging` module
+- Added `StructlogFormatter` for use with the `structlog` package

README.md

@@ -84,22 +84,54 @@ structlog.configure(
 logger = structlog.get_logger("app")
 
 # Add additional context
-logger = logger.bind(**{"log.logger": "app"})
+logger = logger.bind(**{
+    "http": {
+        "version": "2",
+        "request": {
+            "method": "get",
+            "bytes": 1337,
+        },
+    },
+    "url": {
+        "domain": "example.com",
+        "path": "/",
+        "port": 443,
+        "scheme": "https",
+        "registered_domain": "example.com",
+        "top_level_domain": "com",
+        "original": "https://example.com",
+    }
+})
 
 # Emit a log!
 logger.debug("Example message!")
 ```
 ```json
 {
-    "@timestamp": "2020-03-20T18:10:32.972Z",
-    "ecs": {
-        "version": "1.5.0"
+  "@timestamp": "2020-03-26T13:08:11.728Z",
+  "ecs": {
+    "version": "1.5.0"
+  },
+  "http": {
+    "request": {
+      "bytes": 1337,
+      "method": "get"
     },
-    "log": {
-        "level": "debug",
-        "logger": "app"
-    },
-    "message": "Example message!"
+    "version": "2"
+  },
+  "log": {
+    "level": "debug"
+  },
+  "message": "Example message!",
+  "url": {
+    "domain": "example.com",
+    "original": "https://example.com",
+    "path": "/",
+    "port": 443,
+    "registered_domain": "example.com",
+    "scheme": "https",
+    "top_level_domain": "com"
+  }
 }
 ```
 

pyproject.toml

@@ -30,3 +30,10 @@ develop = [
     "mock",
     "structlog",
 ]
+
+[tool.flit.metadata.urls]
+"Source" = "https://github.com/elastic/ecs-logging-python"
+"Download" = "https://github.com/elastic/ecs-logging-python/releases"
+"Documentation" = "https://github.com/elastic/ecs-logging-python"
+"Issue Tracker" = "https://github.com/elastic/ecs-logging-python/issues"
+"Changelog" = "https://github.com/elastic/ecs-logging-python/blob/master/CHANGELOG.md"