@appsignal/plugin-breadcrumbs-network

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

The @appsignal/javascript plugin for automatically adding a breadcrumb on every network request. Works with both XMLHttpRequest and fetch.

See also the mono repo README for more information.

Installation

Add the @appsignal/plugin-breadcrumbs-network and @appsignal/javascript packages to your package.json. Then, run yarn install/npm install.

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

``
yarn add @appsignal/javascript @appsignal/plugin-breadcrumbs-network
npm install --save @appsignal/javascript @appsignal/plugin-breadcrumbs-network
`

Usage

`js
import Appsignal from "@appsignal/javascript"
import { plugin } from "@appsignal/plugin-breadcrumbs-network"

const appsignal = new Appsignal({
key: "YOUR FRONTEND API KEY"
})

appsignal.use(plugin(options))
`

$3

The plugin can be initialized with the following options:

| Param | Type | Description |
| ------ | ------ | ----- |
| xhrEnabled | Boolean | (optional) A boolean value representing whether the plugin should bind to XMLHttpRequest. Defaults to true. |
| fetchEnabled | Boolean | (optional) A boolean value representing whether the plugin should bind to fetch. Defaults to true. |

Development

$3

Make sure mono is installed and bootstrapped, see the project README's development section for more information.

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

`bash
yarn build:watch
`

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
`

$3

The tests for this library use Jest 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
yarn test
``

$3

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

@TODO: define how this works once we know more about releasing

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 Stroopwafles. Have look at everyone we send a package to so far on our [Stroopwafles 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://appsignal.com
[appsignal-sign-up]: https://appsignal.com/users/sign_up
[contact]: mailto:support@appsignal.com
[coc]: https://docs.appsignal.com/appsignal/code-of-conduct.html
[waffles-page]: https://appsignal.com/waffles
[docs]: http://docs.appsignal.com
[contributing-guide]: http://docs.appsignal.com/appsignal/contributing.html

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