Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/nativescript-community/sentry

A cross-platform application monitoring tool, with a focus on error reporting.
https://github.com/nativescript-community/sentry

Last synced: about 1 year ago
JSON representation

A cross-platform application monitoring tool, with a focus on error reporting.

Awesome Lists containing this project

README 

          
[![npm](https://img.shields.io/npm/v/@nativescript-community/sentry.svg)](https://www.npmjs.com/package/@nativescript-community/sentry)

[![npm](https://img.shields.io/npm/dt/@nativescript-community/sentry.svg?label=npm%20downloads)](https://www.npmjs.com/package/@nativescript-community/sentry)

[![GitHub forks](https://img.shields.io/github/forks/nativescript-community/sentry.svg)](https://github.com/nativescript-community/sentry/network)

[![GitHub stars](https://img.shields.io/github/stars/nativescript-community/sentry.svg)](https://github.com/nativescript-community/sentry/stargazers)



[](#installation)



# Installation



* `tns plugin add @nativescript-community/sentry`



Be sure to run a new build after adding plugins to avoid any issues.



[](#configuration)



# Configuration



[](#webpack-)



## Webpack 



You will need to add something like this to your webpack config so that the source maps gets uploaded. I dont set `auth` or `project` in the options as i use a `.sentryclirc` config file.

* `SOURCEMAP_REL_DIR`: i almost always set it to `../../sourcemaps`

* `SENTRY_PREFIX`: the default is `app:///`

```javascript

if (!!sentry && !!uploadSentry) {

  config.devtool = false;

  config.plugins.push(

      new webpack.SourceMapDevToolPlugin({

          append: `\n//# sourceMappingURL=${process.env.SENTRY_PREFIX}[name].js.map`,

          filename: join(process.env.SOURCEMAP_REL_DIR, '[name].js.map')

      })

  );

  let appVersion;

  let buildNumber;

  if (isAndroid) {

      const gradlePath = `${appResourcesPath}/Android/app.gradle`;

      const gradleData = readFileSync(gradlePath, 'utf8');

      appVersion = gradleData.match(/versionName "((?:[0-9]+\.?)+)"/)[1];

      buildNumber = gradleData.match(/versionCode ([0-9]+)/)[1];

  } else if (isIOS) {

      const plistPath = `${appResourcesPath}/iOS/Info.plist`;

      const plistData = readFileSync(plistPath, 'utf8');

      appVersion = plistData.match(/CFBundleShortVersionString<\/key>[\s\n]*(.*?)<\/string>/)[1];

      buildNumber = plistData.match(/CFBundleVersion<\/key>[\s\n]*([0-9]*)<\/string>/)[1];

  }

  config.plugins.push(

      new SentryCliPlugin({

          release: appVersion,

          urlPrefix: 'app:///',

          rewrite: true,

          release: `${nconfig.id}@${appVersion}+${buildNumber}`,

          dist: `${buildNumber}.${platform}`,

          ignoreFile: '.sentrycliignore',

          include: [join(dist, process.env.SOURCEMAP_REL_DIR)]

      })

  );

}

```



###debug 



For debug mode to work correctly you will need to add this to your webpack (see demo app)



```js

nsWebpack.chainWebpack(config=>{

    config.entry('bundle').prepend('@nativescript-community/sentry/process');

});

```



[](#fastlane)



## Fastlane



If you use fastlane you can use it to create release and upload dsyms

To do that you need to install it:

```sh

fastlane add_plugin sentry

```

Also for now you should install `nativescript-set-version` as it is needed to read app version, build number.

```sh

npm install -D nativescript-set-version

```



Now you can setup your `Fastfile`

* create release 

```

version = ""

versionCode = ""



Dir.chdir("..") do

  version  =  sh("./node_modules/.bin/get-version", platform, "version").gsub(/\n/,'')

  versionCode  =  sh("./node_modules/.bin/get-version", platform, "code").gsub(/\n/,'')

end

sentry_create_release(

  version: version, # release version to create

)

```



* upload dsyms

```

sentry_upload_dsym

```



[](#usage-in-the-app)



# Usage in the app



```typescript

import * as Sentry from '@nativescript-community/sentry';



const buildNumber = await getBuildNumber();

const versionName = await getVersionName();

const buildNumber = await getBuildNumber();

const appId = await getAppId();

Sentry.init({

    dsn: SENTRY_DSN,

    debug: true,

    enableAutoPerformanceTracking: true,

});

```



[](#reporting-nativescript-errors)



## Reporting NativeScript errors



The `onerror` method ensures all unhandled NativeScript errors will be caught by Sentry in production, using a [custom error handler](https://docs.nativescript.org/core-concepts/error-handling).



[](#reporting-handled-errors)



## Reporting handled errors



If you would like to send a handled error to Bugsnag, you can pass any Error object to Sentry notify method:

```typescript

import * as Sentry from '@nativescript-community/sentry';

try {

  // potentially crashy code

} catch (error) {

  Sentry.captureException(error);

}

```



[](#reporting-promise-rejections)



## Reporting promise rejections



To report a promise rejection, use notify() as a part of the catch block:



```typescript

import * as Sentry from '@nativescript-community/sentry';

new Promise(function(resolve, reject) {

  /* potentially failing code */

})

.then(function () { /* if the promise is resolved */ })

.catch(function (error) {

  Sentry.captureException(error);

});

```



[](#sending-diagnostic-data)



## Sending diagnostic data



### Automatically captured diagnostics



Bugsnag will automatically capture and attach the following diagnostic data:



* A full stacktrace

* Battery state

* Device model and OS version

* Thread state for all threads

* Release stage (production, debug, etc)

* App running duration in the foreground and/or background

* A device- and vendor-specific identifier



[](#identifying-users)



## Identifying users



In order to correlate errors with customer reports, or to see a list of users who experienced each error, it is helpful to capture and display user information. Information set on the Bugsnag client is sent with each error report:



```typescript

Sentry.setUser({"email": "john.doe@example.com"});

```



[](#logging-breadcrumbs)



## Logging breadcrumbs



In order to understand what happened in your application before each crash, it can be helpful to leave short log statements that we call breadcrumbs. The last several breadcrumbs are attached to a crash to help diagnose what events lead to the error.



### Automatically captured breadcrumbs



By default, Bugsnag captures common events including:



* Low memory warnings

* Device rotation (if applicable)

* Menu presentation

* Screenshot capture (not the screenshot itself)

* Undo and redo

* Table view selection

*  Window visibility changes

* Non-fatal errors

* Log messages (off by default, see configuration options)



### Attaching custom breadcrumbs



To attach additional breadcrumbs, use the leaveBreadcrumb function:



```typescript

Sentry.addBreadcrumb({

    category: 'ui',

    message: 'load main view',

    level: 'info'

  });

```



[](#demos-and-development)



## Demos and Development



### Repo Setup



The repo uses submodules. If you did not clone with ` --recursive` then you need to call

```

git submodule update --init

```



The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.



To develop and test:

if you use `yarn` then run `yarn`

if you use `pnpm` then run `pnpm i`



**Interactive Menu:**



To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`). This will list all of the commonly used scripts.



### Build



```bash

npm run build.all

```

WARNING: it seems `yarn build.all` wont always work (not finding binaries in `node_modules/.bin`) which is why the doc explicitly uses `npm run`



### Demos



```bash

npm run demo.[ng|react|svelte|vue].[ios|android]



npm run demo.svelte.ios # Example

```



Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in `demo-[ng|react|svelte|vue]`

Instead you work in `demo-snippets/[ng|react|svelte|vue]`

You can start from the `install.ts` of each flavor to see how to register new demos 



[](#contributing)



## Contributing



### Update repo 



You can update the repo files quite easily



First update the submodules



```bash

npm run update

```



Then commit the changes

Then update common files



```bash

npm run sync

```

Then you can run `yarn|pnpm`, commit changed files if any



### Update readme 

```bash

npm run readme

```



### Update doc 

```bash

npm run doc

```



### Publish



The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)

Simply run 

```shell

npm run publish

```



### modifying submodules



The repo uses https:// for submodules which means you won't be able to push directly into the submodules.

One easy solution is t modify `~/.gitconfig` and add

```

[url "ssh://git@github.com/"]

	pushInsteadOf = https://github.com/

```



[](#questions)



## Questions



If you have any questions/issues/comments please feel free to create an issue or start a conversation in the [NativeScript Community Discord](https://nativescript.org/discord).