Release 0.3

Author: sethmlarson

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.3 (2020-07-27)
+
+- Added collecting `LogRecord.exc_info` into `error.*` fields
+  automatically for `StdlibFormatter` ([#16](https://github.com/elastic/ecs-logging-python/pull/16))
+- Added collecting process and thread info from `LogRecord` into `process.*` fields
+  automatically for `StdlibFormatter` ([#16](https://github.com/elastic/ecs-logging-python/pull/16))
+- Added `exclude_fields` parameter to `StdlibFormatter` to
+  exclude fields from being formatted to JSON ([#16](https://github.com/elastic/ecs-logging-python/pull/16))
+- Added `stack_trace_limit` parameter to `StdlibFormatter`
+  to control the number of stack trace frames being
+  formatted in `error.stack_trace` ([#16](https://github.com/elastic/ecs-logging-python/pull/16))
+
+Thanks to community contributor Jon Moore ([@comcast-jonm](https://github.com/comcast-jonm))
+for their contributions to this release.
+
 ## 0.2 (2020-04-28)
 
 - Added support for using `log(..., extra={...})` on standard library

README.md

@@ -17,7 +17,7 @@ we will be following (ECS.major).(ECS.minor).(package minor) as our versioning s
 ## Installation
 
 ```console
-python -m pip install ecs-logging
+$ python -m pip install ecs-logging
 ```
 
 ## Getting Started
@@ -71,6 +71,46 @@ logger.debug("Example message!", extra={"http.request.method": "get"})
 }
 ```
 
+##### Excluding Fields
+
+You can exclude fields from being collected by using the `exclude_fields` option
+in the `StdlibFormatter` constructor:
+
+```python
+from ecs_logging import StdlibFormatter
+
+formatter = StdlibFormatter(
+    exclude_fields=[
+        # You can specify individual fields to ignore:
+        "log.original",
+        # or you can also use prefixes to ignore
+        # whole categories of fields:
+        "process",
+        "log.origin",
+    ]
+)
+```
+
+##### Limiting Stack Traces
+
+The `StdlibLogger` automatically gathers `exc_info` into ECS `error.*` fields.
+If you'd like to control the number of stack frames that are included
+in `error.stack_trace` you can use the `stack_trace_limit` parameter
+(by default all frames are collected):
+
+```python
+from ecs_logging import StdlibFormatter
+
+formatter = StdlibFormatter(
+    # Only collects 3 stack frames
+    stack_trace_limit=3,
+)
+formatter = StdlibFormatter(
+    # Disable stack trace collection
+    stack_trace_limit=0,
+)
+```
+
 ### Structlog Example
 
 ```python

ecs_logging/__init__.py

@@ -4,7 +4,7 @@
 from ._stdlib import StdlibFormatter
 from ._structlog import StructlogFormatter
 
-__version__ = "0.2"
+__version__ = "0.3"
 __all__ = [
     "ECS_VERSION",
     "StdlibFormatter",

pyproject.toml

@@ -19,6 +19,7 @@ classifiers = [
   "Programming Language :: Python :: 3.6",
   "Programming Language :: Python :: 3.7",
   "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
   "Topic :: System :: Logging",
   "License :: OSI Approved :: Apache Software License"
 ]