Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/appsignal/appsignal-javascript

🟨 AppSignal for JavaScript
https://github.com/appsignal/appsignal-javascript

angular appsignal ember error-reporting javascript preact react stimulusjs typescript vuejs webpack

Last synced: 22 days ago
JSON representation

🟨 AppSignal for JavaScript

Awesome Lists containing this project

README 

        
# AppSignal for JavaScript



- [AppSignal.com website][appsignal]

- [Documentation][docs]

- [Changelog][changelog]

- [Support][contact]



[![Build Status](https://travis-ci.org/appsignal/appsignal-javascript.svg?branch=develop)](https://travis-ci.org/appsignal/appsignal-javascript) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)



## Description



## Usage



First, make sure you've installed AppSignal in your application by following the steps in [Installation](#installation).



### Track any error



Catch an error and report it to AppSignal:



```js

try {

  // do something that might throw an error

} catch (error) {

  appsignal.sendError(error)

  // handle the error

}



// You can catch errors asynchronously by listening to Promises...

asyncActionThatReturnsAPromise().catch(error => appsignal.sendError(error))



// ...or by using async/await

async function() {

  try {

    const result = await asyncActionThatReturnsAPromise()

  } catch (error) {

    appsignal.sendError(error)

    // handle the error

  }

}



// ...or in an event handler or callback function

events.on("event", (err) => {

  appsignal.sendError(err)

})

```



**NOTE:** Uncaught exceptions are **not** captured by default. We made the decision to not include this functionality as part of the core library due to the high amount of noise from browser extensions, ad blockers etc. that generally makes libraries such as this less effective.



We recommend using a relevant [integration](#integrations) as a better way to handle exceptions, or, if you _would_ prefer capture uncaught exceptions, you can do so by using the `@appsignal/plugin-window-events` package alongside this one.



## Installation



First, [sign up][appsignal-sign-up] for an AppSignal account and add the `@appsignal/javascript` package to your `package.json`. Then, run `yarn install`/`npm install`.



You can also add these packages to your `package.json` on the command line:



```bash

yarn add @appsignal/javascript

npm install --save @appsignal/javascript

```



You can then import and use the package in your bundle:



```js

import Appsignal from "@appsignal/javascript" // For ES Module

const Appsignal = require("@appsignal/javascript").default // For CommonJS module



const appsignal = new Appsignal({

  key: "YOUR FRONTEND API KEY"

})

```



It's recommended (although not necessarily required) to use the instance of the `Appsignal` object like a singleton. One way that you can do this is by `export`ing an instance of the library from a `.js`/`.ts` file somewhere in your project.



```js

import Appsignal from "@appsignal/javascript"



export default new Appsignal({

  key: "YOUR FRONTEND API KEY"

}) 

```



Currently, we have no plans to supply a CDN-hosted version of this library.



If you're stuck, feel free to [contact us][contact] for help!



## Development



### Installation




This repository is a [mono-managed monorepo](https://github.com/appsignal/mono/), containing packages (located in the `/packages` directory) that map to separate `npm` modules.



First install mono on your local machine by [following the mono installation steps](https://github.com/appsignal/mono/#installation).



Then install the dependencies and prepare the project for development use using mono:



```bash

mono bootstrap

```



You can then run the following to start the compiler in _watch_ mode. This automatically compiles both the ES Module and CommonJS variants:



```bash

mono run yarn build:watch --parallel

```



You can also build the library without watching the directory:



```

yarn build        # build both CJS and ESM

yarn build:cjs    # just CJS

yarn build:esm    # just ESM

```



### Testing



The tests for this library use [Jest](https://jestjs.io) as the test runner. Once you've installed the dependencies, you can run the following command in the root of this repository to run the tests for all packages, or in the directory of a package to run only the tests pertaining to that package:



```bash

mono test

```



### Versioning



This repo uses [Semantic Versioning][semver] (often referred to as _semver_). Each package in the repository is versioned independently from one another.



## Contributing



Thinking of contributing to this repo? Awesome! 🚀



Please follow our [Contributing guide][contributing-guide] in our documentation and follow our [Code of Conduct][coc].



Also, we would be very happy to send you Stroopwafels. Have look at everyone we send a package to so far on our [Stroopwafels page][waffles-page].



## Support



[Contact us][contact] and speak directly with the engineers working on AppSignal. They will help you get set up, tweak your code and make sure you get the most out of using AppSignal.



Also see our [SUPPORT.md file](SUPPORT.md).



[appsignal]: https://www/appsignal.com/javascript

[appsignal-sign-up]: https://appsignal.com/users/sign_up

[contact]: mailto:[email protected]

[coc]: https://docs.appsignal.com/appsignal/code-of-conduct.html

[waffles-page]: https://www.appsignal.com/waffles

[docs]: https://docs.appsignal.com/front-end/

[contributing-guide]: https://docs.appsignal.com/appsignal/contributing.html

[changelog]: https://github.com/appsignal/appsignal-javascript/blob/develop/packages/javascript/CHANGELOG.md

[semver]: http://semver.org/