Code Monkey home page Code Monkey logo

redux-airbrake's Introduction

Redux Airbrake

Redux middleware for Airbrake error logging

Why add Airbrake via Redux middleware?

Because Redux contains the full state of your application and is aware of the last action dispatched before each error. This information can be very useful when trying to reproduce bugs. Read below to learn how to enable this feature.

Setting up

1. Add dependencies

npm install @airbrake/browser redux-airbrake --save

2. Import dependency

import { Notifier } from '@airbrake/browser';
import airbrakeMiddleware from 'redux-airbrake';

3. Configure & add middleware

const airbrake = new Notifier({
    projectId: '******',
    projectKey: '**************'
});

const errorMiddleware = airbrakeMiddleware(airbrake);

export const store = createStore(
    rootReducer,
    applyMiddleware(
        errorMiddleware
    )
);

export default store;

Sending last action and store state to Airbrake

By default, the last action dispatched and the full store state will not be sent to Airbrake in the params object. To enable these features, simply set these options to true.

const errorMiddleware = airbrakeMiddleware(airbrake, {
    sendLastAction: true,
    sendState: true
});

IMPORTANT: If you enable either of these options, be mindful you may be sending sensitive information to Airbrake such as credentials, payment information, etc.

Adding notice annotations (optional)

It's possible to annotate error notices with all sorts of useful information at the time they're captured by supplying it in the options object.

const errorMiddleware = airbrakeMiddleware(airbrake, {
    noticeAnnotatios: { context: { environment: window.ENV } }
});

Adding filters

Since an Airbrake instrace is passed to the middleware, you can simply add filters to the instance as described here:

https://github.com/airbrake/airbrake-js#filtering-errors

The MIT License (MIT)

Copyright (c) 2017 Alex Castillo.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

redux-airbrake's People

Contributors

alexcastillo avatar benpetty avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

redux-airbrake's Issues

airbrake-js dependency update

Hello !
Thanks for sharing this helpful work.

airbrake-js latest version is now 1.1.0 but redux-airbrake requires a peer of airbrake-js@0.*
Would it be possible to update dependencies ?

Thanks again,
Mat

Add Usage Examples

As a developer using this package, I expect to find the following usage examples in the README:

  • Using filters to allow certain conditions to prevent sending airbrake errors
  • Sending a test error

Setup Airbrake for your JavaScript application

Installation

Using npm

npm install airbrake-js

Using bower

bower install airbrake-js-client

Setup

The notifier is built using a standalone browserify build and can be used with:

We include the full source code with the package, so you can use Browserify too.

If you prefer not to host the library yourself, airbrake-js is available on the excellent cdnjs CDN.

Basic Usage

First you need to initialize the notifier (You can find your project ID and API KEY with your project's settings):

var airbrake = new airbrakeJs.Client({projectId: <Your project ID>, projectKey: '<Your project API KEY>'});

Or if you are using browserify/webpack/etc:

var airbrakeJs = require('airbrake-js');

var airbrake = new airbrakeJs({projectId: <Your project ID>, projectKey: '<Your project API KEY>'});

The simplest method is to report errors directly:

try {
  // This will throw if the document has no head tag
  document.head.insertBefore(document.createElement('style'));
} catch(err) {
  airbrake.notify(err);
  throw err;
}

Alternatively you can wrap any code which may throw errors using the client's wrap method:

var startApp = function() {
  // This will throw if the document has no head tag.
  document.head.insertBefore(document.createElement('style'));
}
startApp = airbrake.wrap(startApp);

// Any exceptions thrown in startApp will be reported to Airbrake.
startApp();

For more information please visit our official GitHub Repo.

Changelog

Awesome work, thanks for making this library.
A changelog will be very helpful.

unused async await

I had a "ReferenceError: regeneratorRuntime is not defined" when using your package because I had to add it to my list of transpiled npm packages

I looked a bit at your code and the async await statement doesn't do anything
since there is no await airbrakeNotify

airbrakeNotify({ error, params });

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.