@talend/log v1.0.0-0

Talend-log - error logging library

A small library that provides a centralized error logger.

Minimum-config usage:

• AngularJS documentation
• React documentation
• Redux documentation
• Framework free: see next section

Breaking changes log

Before 1.0, @talend/log does NOT follow semver version in releases. You will find a list of breaking changes here. Before 2.0, we will try not to introduce breaking changes, as possible. After 2.0, we will only introduce breaking changes in major releases, and follow semver.

Advanced config

Look in ./src/errorTransformer.js for jsDoc on each parameter

import LOGGING_SERVER_URL from 'somewhere';
import { initErrorTransformer, TraceKit } from '@talend/log';

initErrorTransformer(
    LOGGING_SERVER_URL, {
        send: (payload, fetchOptions) => fetch(LOGGING_SERVER_URL, {
            method: 'POST',
            headers: {
                'Content-Type': 'application/json'
            },
            body: JSON.stringify({
                '@message': payload
            }),
            ...fetchOptions,
        }),
        payloadMiddleware: payload => Object.assign({
            state: TraceKit.store.getState()
        }, payload),
        fetchOptions: {
            headers: {
                'Content-Type': 'application/json',
                custom: 'customData'
            }
        },
        successHandler: (responseText) => {
            alert('yay! ' + responseText)
        },
        retryCount: 5,
        retryTimeout: 3000,
        failedTryHandler: function failedTry(error, payload, transportOpts, attempt) {
            alert('Oh no! ' + error);
            transportOpts.send(transportOpts.payloadMiddleware(payload), transportOpts.fetchOptions, attempt + 1);
        },
        failedReportHandler: (errorResponse) => {
            alert('oh no! ' + errorResponse)
        },
    }, {
        stackTraceLimit: 100,
        linesOfContext: 13,
        rethrowErrorHandler: () => {},
        remoteFetching: true,
        collectWindowErrors: true,
    }
);

TraceKit.report(new Error('My error'));

Notable details:

• Once initErrorTransformer is called, listener function is created and registered in TraceKit, then returned.
• Depending on the parameters you provide, TraceKit.report function may be patched to rethrow no error.
• transport.send is called with fetchOptions defined on transport.fetchOptions
• TraceKit.store should be defined in your configStore.js file if you want to attach state to report
• fetchOptions are merged with Object.assign to default options, so don't expect deepMerge
• that is also true for default transport and default options objects

Log warnings

If you have some non-critical exceptions that should be reported, but should not break application, then use a possibility to provide handler for better microcontrol:

in your config file:

import LOGGING_SERVER_URL from 'somewhere';
import initErrorTransformer from '@talend/log';
import transportConfig from 'somewhere';

// this:
initErrorTransformer(LOGGING_SERVER_URL, transportConfig, {
    rethrowErrorHandler: (e) => { if (e.type === 'critical') { throw e; } else { console.error(e); } },
})

somewhere in your application:

import { TraceKit } from '@talend/log';

fetch('google.com').catch(errorResponse => TraceKit.report(new Error(errorResponse)));

Under the hood

TraceKit - Cross browser stack traces. https://github.com/csnover/TraceKit