Add breadcrumbs functionality #141
Conversation
src/Contracts/Reporter.php
Outdated
| * | ||
| * @param string $message A brief description of the event represented by this breadcrumb, for example "Email Sent". | ||
| * @param array $metadata A map of contextual data about the event. This must be a simple key-value array at one level (no nesting allowed). | ||
| * @param string $category A key for grouping related events. You can use anything here, but we recommend following the list at https://docs.honeybadger.io/lib/ruby/getting-started/breadcrumbs.html#categories. |
There was a problem hiding this comment.
We can change this to a PHP docs link once we add a similar breadcrumbs guide for PHP.
There was a problem hiding this comment.
How about you copy this guide:
to this location:
We could leave out the automatic Laravel breadcrumbs section for now so that we can release this PR first.
There was a problem hiding this comment.
Changed the link; adding the content 👍
|
Success!
|
|
One question: @joshuap : should the breadcrumbs limit (40) really be user-configurable? Or is 40 the maximum allowed? |
Sorry, missed this. It's configurable in honeybadger.js, but it's fixed in the Ruby gem. Maybe we should just make it the max and skip the option to configure for now? |
|
Yeah, I think that'll be good. |
Status
READY
Description
Implementation of #140
Went with config keys of
breadcrumbs.enabledandbreadcrumbs.keep.Also auto-add breadcrumb for
noticeevents, in line with other libraries.Related PRs