Breadcrumb Logs

Add a Breadcrumb #

Adding Context to Sessions #

Embrace can collect basic session data and crashes as you’ve already seen in the Crash Reporting and Session Reporting sections. Embrace can also collect your logging data and include it as context within your sessions. Here’s how you add a Breadcrumb to the session.

import {logBreadcrumb} from 'react-native-embrace';

logBreadcrumb("component updated -- 'show' prop changed from true to false");

In the above example, a Breadcrumb is being logged when a prop named “show” changed and triggered a component update. This event is not otherwise shown in the session and can be important depending on what the user does next.

For how to best use Breadcrumbs, check out the Best Practices page.

We generally use the Breadcrumb method for our logging and not the Log Message API to add context to sessions. Breadcrumbs are a lightweight way to add logging to your session. They add no CPU or memory overhead, and trigger no networking calls. The Log Message API is a much heavier mechanism. We will learn about it in the Alerting section of the documentation. For now, just know that using Breadcrumbs is the right thing to do most of the time.

Learn About the Log Message API