ShipBook gives you the power to remotely gather, search and analyze your user logs and exceptions in the cloud, on a per-user & session basis.
React Native version 0.63.0 and up.
ShipBookSDK is available through: NPM
To initialize, add the following:
To have a log on each class you need to create a logger:
The usage of the log:
If your logs weren't uploaded to Shipbook, or you're experiencing some other issue with Shipbook, you can enable Shipbook debug logging to track down the problem.
The SDK allows the option to associate each session with specific user information.
The best practice is to set registerUser before ShipBook.start. It will also work after this point however, it will require an additional api request.
The only required parameter is
To logout the user, add the following code to your app’s logout function.
To log the user’s screen information, add the following code
The best practice is to add this code to viewWillAppear in the view controller.
Flush all logs on the device and send them now to the server.
The SDK creates it's own UUID. So to get the UUID call te following code.
You may use a static function in place of getLogger. This is not recommended and the caveats are listed below. When a static function activates the logger, the tag will become the filename. The usage of the logs:
As mentioned, working with this static logger isn't ideal:
- Performance is slower, especially in cases where the log is closed
- The log’s information is less detailed. Ideally, you should create a logger for each class.
- The Log name can have a name collision with a local Log class.