From f0015e3e3c8766a5680f3c21dca219748cb384a6 Mon Sep 17 00:00:00 2001 From: Kirk Rodrigues <2454684+kirkrodrigues@users.noreply.github.com> Date: Wed, 16 Apr 2025 21:42:57 -0400 Subject: [PATCH 1/4] docs: Add warning about ClpKeyValuePairStreamHandler's incompatibility with other handlers. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 9bf2ecf..c12b38c 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,12 @@ dictionaries, where each dictionary entry must abide by the requirements detaile [below](#key-value-pair-requirements). The handler will also automatically include certain [metadata](#automatically-generated-kv-pairs) (e.g., the log event's level) with each log event. +> [!WARNING] +> This handler cannot be used with other logging handlers since it requires that the `msg` argument +> passed to the logging method is a dictionary, whereas other handlers expect the `msg` argument to +> be a format string. In the future, this handler may be moved to another library to avoid +> confusion. + > [!NOTE] > Since this handler accepts structured log events, it doesn't support setting a > [Formatter][py-logging-formatter] (because the log events don't need to be formatted into a From d30dc68d0e775e124ae63fc1afa3caf89217ffe6 Mon Sep 17 00:00:00 2001 From: Kirk Rodrigues <2454684+kirkrodrigues@users.noreply.github.com> Date: Wed, 16 Apr 2025 21:49:10 -0400 Subject: [PATCH 2/4] Minor rephrase. --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index c12b38c..22070d1 100644 --- a/README.md +++ b/README.md @@ -46,8 +46,7 @@ dictionaries, where each dictionary entry must abide by the requirements detaile > [!WARNING] > This handler cannot be used with other logging handlers since it requires that the `msg` argument > passed to the logging method is a dictionary, whereas other handlers expect the `msg` argument to -> be a format string. In the future, this handler may be moved to another library to avoid -> confusion. +> be a format string. In the future, this handler may be moved or reworked to avoid confusion. > [!NOTE] > Since this handler accepts structured log events, it doesn't support setting a From a3caef4cc521cd82e1f656bc18c15a521568125b Mon Sep 17 00:00:00 2001 From: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com> Date: Thu, 17 Apr 2025 15:03:13 -0400 Subject: [PATCH 3/4] Update README.md Co-authored-by: Lin Zhihao <59785146+LinZhihao-723@users.noreply.github.com> --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 22070d1..c9c4ed7 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,9 @@ dictionaries, where each dictionary entry must abide by the requirements detaile [metadata](#automatically-generated-kv-pairs) (e.g., the log event's level) with each log event. > [!WARNING] -> This handler cannot be used with other logging handlers since it requires that the `msg` argument -> passed to the logging method is a dictionary, whereas other handlers expect the `msg` argument to -> be a format string. In the future, this handler may be moved or reworked to avoid confusion. +> This handler cannot be used with other logging handlers since it requires the `msg` argument +> passed to the logging method to be a dictionary. In contrast, standard handlers typically treat +> `msg` as a format string. In the future, this handler may be moved or reworked to avoid confusion. > [!NOTE] > Since this handler accepts structured log events, it doesn't support setting a From 18ad6763cdd7a3312988441593e3a66b07890202 Mon Sep 17 00:00:00 2001 From: Kirk Rodrigues <2454684+kirkrodrigues@users.noreply.github.com> Date: Thu, 17 Apr 2025 15:10:47 -0400 Subject: [PATCH 4/4] Further simplify comment. --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c9c4ed7..ae00139 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,10 @@ dictionaries, where each dictionary entry must abide by the requirements detaile [metadata](#automatically-generated-kv-pairs) (e.g., the log event's level) with each log event. > [!WARNING] -> This handler cannot be used with other logging handlers since it requires the `msg` argument -> passed to the logging method to be a dictionary. In contrast, standard handlers typically treat -> `msg` as a format string. In the future, this handler may be moved or reworked to avoid confusion. +> This handler cannot be used with other logging handlers since it requires `msg` (the first +> argument passed to the logging method) to be a dictionary. In contrast, standard handlers +> typically treat `msg` as a format string. In the future, this handler may be moved or reworked to +> avoid confusion. > [!NOTE] > Since this handler accepts structured log events, it doesn't support setting a