https://github.com/getsentry/sentry-lynx
Official Sentry SDK for Lynx
https://github.com/getsentry/sentry-lynx
android crash-reporting ios javascript lynx sdk sentry tag-production team-mobile typescript
Last synced: 6 months ago
JSON representation
Official Sentry SDK for Lynx
- Host: GitHub
- URL: https://github.com/getsentry/sentry-lynx
- Owner: getsentry
- License: mit
- Created: 2025-03-27T15:43:04.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-04-11T15:32:41.000Z (6 months ago)
- Last Synced: 2025-04-12T03:59:21.892Z (6 months ago)
- Topics: android, crash-reporting, ios, javascript, lynx, sdk, sentry, tag-production, team-mobile, typescript
- Language: TypeScript
- Homepage: https://sentry.io
- Size: 505 KB
- Stars: 21
- Watchers: 27
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
_Bad software is everywhere, and we're tired of it. Sentry is on a mission to help developers write better software faster, so we can get back to enjoying technology. If you want to join us [**Check out our open positions**](https://sentry.io/careers/)_
# Sentry SDK for Lynx
The Sentry SDK for [Lynx](https://lynxjs.org/) is a crash reporting and error monitoring solution specifically designed for Lynx applications. This SDK is currently under active development and has not been officially released yet. Stay tuned for the official release. In the meantime, you can follow the development progress and contribute to the project on GitHub.
## 🚧 Features (in-development)
- Automatic JS Error Tracking (using [@sentry/browser](https://github.com/getsentry/sentry-javascript))
- Automatic Native Crash Error Tracking (using [sentry-cocoa](https://github.com/getsentry/sentry-cocoa) & [sentry-android](https://github.com/getsentry/sentry-java) under the hood)
- Offline storage of events
- On Device symbolication for JS (in Debug)
## 🚧 Installation and Usage (in-development)
To install the package and setup your project:
```sh
npm install --save @sentry/lynx-react
```
How to use it:
```javascript
import * as Sentry from "@sentry/lynx-react";
Sentry.init({
dsn: "__DSN__",
});
Sentry.setTag("myTag", "tag-value");
Sentry.setContext("myContext", {"key": "value"});
Sentry.addBreadcrumb({ message: "test" });
Sentry.captureMessage("Hello Sentry!");
Sentry.captureException(new Error("Sentry Test Error"));
```
To get readable errors and uploaded source maps add:
```javascript
// lynx.config.ts
import { defineConfig } from '@lynx-js/rspeedy';
import { pluginSentryLynx } from '@sentry/lynx-react/plugin';
export default defineConfig({
plugins: [
// ... other plugins
pluginSentryLynx({
org: 'your-sentry-organization-slug',
project: 'your-sentry-project-slug',
authToken: process.env.SENTRY_AUTH_TOKEN,
}),
],
output: {
sourceMap: {
js: 'source-map',
},
},
});
```
Build Lynx for release with source maps:
```bash
# DEBUG='*' will ensure source maps are generated (and not deleted), so they can be uploaded to Sentry
DEBUG='*' rspeedy build
```
## Resources
- 🚧 [](https://docs.sentry.io/platforms/lynx/)
- [](https://github.com/getsentry/sentry-lynx/discussions)
- [](https://discord.gg/PXa5Apfe7K)
- [](http://stackoverflow.com/questions/tagged/sentry)
- [](https://github.com/getsentry/.github/blob/main/CODE_OF_CONDUCT.md)
- [](https://twitter.com/intent/follow?screen_name=getsentry)