kaankc/jovo-plugin-error-slack

Installation

If you are using the Jovo Framework version < 2.0.0, please checkout the v1 branch here

$ npm install jovo-plugin-error-slack --save

In your Jovo project:

const {SlackErrorPlugin} = require('jovo-plugin-error-slack');

const app = new App();

app.use(
    // other plugins, platforms, etc.
    new SlackErrorPlugin()
);

To create enable incoming webhooks for your Slack follow this guide.

Customize

NOTE: The webhookUrl is a required parameter

The plugin sends the error message as an attachement. Every parameter is customizable except the ts parameter.

You can use the config.js file to add the changes in the following format:

module.exports = {
    // other configurations
    plugin: {
        SlackErrorPlugin: {
            webhookUrl: '',
            channel: '',
            fallback: '',
            color: '',
            pretext: '', 
            author_name: '',
            author_link: '',
            author_icon: '',
            title: '',
            title_link: '',
            text: '',
            image_url: '',
            thumb_url: '',
            footer: '',
            footer_icon: '',
        },
        // other plugins
    }
};

If you don't customize anything, these default values will be used:

module.exports = {
    plugin: {
        SlackErrorPlugin: {
            channel: 'Channel you specified in your webhook\'s settings',
            fallback: 'Error Message',
            color: '#ff0000',
            title: 'An error has occured!',
            footer: 'Jovo Plugin - Slack Error',
            footer_icon: jovoLogo
        },
    }
};

Checkout the official documentation for more information on each parameter: Docs

You can also override the channel/user the message should be sent to:

module.exports = {
    plugin: {
        SlackErrorPlugin: {
            channel: '#channel-name / @user-name',
        },
    }
};

Manual Logs

You can manually log stuff using the logError(jovo: Jovo, error: string | Error) and logMessage(jovo: Jovo, msg: string | Error) functions. You always have to parse the jovo object. Inside your intents it would look like this:

LAUNCH() {
    SlackErrorPlugin.logError(this, 'Test Error');
    SlackErrorPlugin.logError(this, new Error('Test Error'));
    return this.tell('Hello World');
},

The logError() function will use the same design as the other error messages. logMessage() will log the message as simple text.

License

MIT