Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

🟩 AppSignal for Node.js
https://github.com/appsignal/appsignal-nodejs

apm appsignal error-monitoring javascript nodejs performance-monitoring

Last synced: 2 days ago
JSON representation

🟩 AppSignal for Node.js

Awesome Lists containing this project

README

        

# AppSignal for Node.js

The AppSignal for Node.js library.

- [AppSignal.com website][appsignal]
- [Documentation][docs]
- [Support][contact]

![npm (scoped)](https://img.shields.io/npm/v/@appsignal/nodejs) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

## Installation

Please follow our [installation guide](https://docs.appsignal.com/nodejs/3.x/installation) in our documentation. We try to automatically instrument as many packages as possible, but may not always be able to. Make to sure follow any [instructions to add manual instrumentation](https://docs.appsignal.com/nodejs/3.x/integrations).

## Development

### Installation

This repository is a [mono-managed repository](https://github.com/appsignal/mono/). 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.

```bash
npm run build:watch --parallel
```

You can also build the library without watching the directory:

```bash
mono build
```

Version management configuration is provided for [`asdf`](https://github.com/asdf-vm/asdf-nodejs).

### 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
```

## 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.

[appsignal]: https://www.appsignal.com/nodejs
[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/nodejs/
[contributing-guide]: http://docs.appsignal.com/appsignal/contributing.html