Log Message API

Adding Alerts #

As we’ve discussed in the Session Reporting section, Embrace uploads its sessions on the next app launch. This delay may seem like it hurts the immediacy of the data you are seeing, but the reality is that at scale this still means you are finding out about issues very quickly.

However, some situations might require instant feedback, such as hunting an especially difficult bug, troubleshooting on behalf of high-value users, or monitoring a new version rollout.

You can leverage the log message API for this.

Using the Log Message API #

You can log a message immediately by calling the logMessage function.

import {logMessage, ERROR} from 'react-native-embrace';

logMessage(
	'Loading not finished in time.',
	ERROR,
	{propertyA: 'valueA', propertyB: 'valueB'},
	false,
);

Here’s a breakdown of the arguments being passed to the logMessage function.

  1. The message. The string of the log message. Make this short yet informative.
  2. Severity. Other options include WARNING and INFO.
  3. Properties. A map of key-value pairs you can use to categorize and filter log messages with.
  4. Screenshot capture enables. Boolean value indicating whether you’d like a screenshot captured or not.

Limits on Log Messages

  • The maximum length for a log message is 128 characters. Messages are truncated if they exceed the limit.
  • Properties are limited to 10 per log.
  • Property keys have a limit of 128 characters.
  • Property values have a limit of 4096 characters.

Being Alerted on Logs #

Once you start using our alerting feature you can also configure how these are handled on the backend. Using the Embrace Dashboard, you can configure email alerts to be sent to your team when certain thresholds are met with log events. For example, let’s say you have a steady rate of 1% for a given log event. You could set that as a threshold and receive an email if the rate rises beyond that in a sustained way.

Best Practices #

Logging a message using the Log Message API makes a network request immediately. Sending too many logs can easily impact application performance or battery life.

For more tips on making the most of the Log Message API, checkout the Best Practices.

Congratulations! By this point, you should have a solid integration. Continue to the Next Steps page to wrap up your integration.

Next Steps