Add breadcrumbs to docs #780
Conversation
| Breadcrumbs are browser and application lifecycle events that are helpful in understanding the state of the application | ||
| leading up to a crash. | ||
|
|
||
| By default, Raven.js instruments the DOM to automatically collect a few useful breadcrumbs for you: |
There was a problem hiding this comment.
How about:
By default, Raven.js instruments browser built-ins and DOM events to automatically collect a few useful breadcrumbs
| By default, Raven.js instruments browser built-ins and DOM events to automatically collect a few useful breadcrumbs | ||
| for you: | ||
|
|
||
| * XMLHttpRequests |
There was a problem hiding this comment.
We list 5 thing here but 4 options on the config page, missing a config option corresponding to previous errors. Is this configurable? Should it be? Do we report prior errors as breadcrumbs when autobreadcrumbs are otherwise disabled?
There was a problem hiding this comment.
Yeah, right now you can't disable "error" breadcrumbs.
This is part oversight and part "people wanted to disable automatic breadcrumb collection because they didn't like overriding some built-ins" (particularly console). The error breadcrumbs don't require instrumentation.
I suppose I'll add it at some point. I added an issue: #782
|
|
||
| .. code-block:: javascript | ||
|
|
||
| Raven.config('your-dsn', { |
There was a problem hiding this comment.
___PUBLIC_DSN___ instead of your-dsn
|
|
||
| .. code-block:: javascript | ||
|
|
||
| Raven.captureBreadcrumb({ |
There was a problem hiding this comment.
Is there anything other than message and data someone might want to include here? Maybe link to https://docs.sentry.io/clientdev/interfaces/breadcrumbs/ for info about level, category, etc
There was a problem hiding this comment.
Added category, and linked to the spec.
* Add breadcrumbs to docs * Fix section heading, tweak "instrumenting" sentence * Address @LewisJEllis' comments
Should have done this ages ago ...
cc @LewisJEllis @MaxBittker