feat: add a notice class and before_notify hook #203
Conversation
roelbondoc
force-pushed
the
add-before-notify-hook
branch
3 times, most recently
from
74ff496 to
07d1cc2
Compare
roelbondoc
changed the title
roelbondoc
force-pushed
the
add-before-notify-hook
branch
from
07d1cc2 to
f1a0295
Compare
roelbondoc
force-pushed
the
add-before-notify-hook
branch
from
f1a0295 to
289cbf8
Compare
The main goal of this PR was to add a `before_notify` hook as part of the configuration. This allows the library to be configured to intercept, inspect, and alter a error notice before it is sent off to Honeybadger. To make this easier, a new `Notice` class has been added so that there is a single object that gets passed into the hook. The payload is generate upon instantiation and can be later inspected or altered in the hook. This preemptive generation isn't ideal because it's a little cumbersome to work with the notice payload. However, the plugins implement the `generate_payload` method which takes in the formatted notice payload. After this, I'd like to take a stab at making it easier to manipulate a notice without having to dig into the final payload.
roelbondoc
force-pushed
the
add-before-notify-hook
branch
from
289cbf8 to
e6b47ee
Compare
|
I know we are looking for parity with the Ruby client, but what if we switch from side‐effecting halt() to a return‐value API where:
I think it would also simplify things to remove the filtering logic out of the Notice class and into notify() flow, along with the skipping logic of Thoughts? |
I think that makes a lot of sense! Let me refactor and add some tests. |
|
|
||
| logging.getLogger("honeybadger").addHandler(logging.NullHandler()) | ||
| logger = logging.getLogger("honeybadger") |
There was a problem hiding this comment.
I believe removing the null handler will attach the logger to the root.
https://github.com/honeybadger-io/honeybadger-python?tab=readme-ov-file#logging
The main goal of this PR was to add a
before_notifyhook as part of the configuration. This allows the library to be configured to intercept, inspect, and alter a error notice before it is sent off to Honeybadger.To make this easier, a new
Noticeclass has been added so that there is a single object that gets passed into the hook.The payload is generate upon instantiation and can be later inspected or altered in the hook.This preemptive generation isn't ideal because it's a little cumbersome to work with the notice payload. However, the plugins implement thegenerate_payloadmethod which takes in the formatted notice payload. After this, I'd like to take a stab at making it easier to manipulate a notice without having to dig into the final payload.The payload is a cached property allowing the
before_notifyhook to alter the payload before sending.The
before_notifyhook must return the notice in order for the notice to be sent. ANonevalue will halt the sending.Closes: #187 and #185