npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

strapi-plugin-bunyan

v0.0.4

Published

Send Strapi error events to a log file using bunyan

Downloads

4

Readme

Strapi plugin Bunyan

Bunyan strapi plugin inspired by the official Strapi Bunyan plugin.

🧾 Features

  • Initialize a Bunyan instance when your Strapi app starts
  • Send errors encountered in your application's end API to a specific file in JSON format

⏳ Installation

To install this plugin, you need to add a NPM dependency to your Strapi application.

# Using Yarn
yarn add strapi-plugin-bunyan

# Or using NPM
npm install strapi-plugin-bunyan

⚙ Configuration

If you need to change error file location or the app name you must add your configuration in ./config/plugins.js.

| property | type | description | | -------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | path | string(default:'./error.log') | Log file location | | appName | string(default:'myapp') | Your application name provided in the logs |

Example

./config/plugins.js

module.exports = ({ env }) => ({
  // ...
    bunyan: {
        appName: 'goodProject',
        path: './error2.log',
    },
  // ...
});

If your log file path is inside your Strapi project, you need to add this lines in the config server file ./config/server.js.Otherwise your server will restart each time the log file is changed.

./config/server.js

module.exports = ({ env }) => ({
  // ...
    admin: {
        watchIgnoreFiles: [
            "./error.log"
        ]
    }
  // ...
});

Global Bunyan service

You can access a Bunyan service throughout your app.

const bunyanService = strapi.plugins.bunyan.services.bunyan;

This service exposes the following methods:

sendError(error)

Use it to manually send errors to the log file.

Example

try {
  // Your code here
} catch (error) {
  strapi.plugins.bunyan.services.bunyan.sendError(error);
  throw error;
}

getInstance()

Use it if you need direct access to the Bunyan instance, which should already already be initialized. It's useful if sendError doesn't suit your needs.

Example

const bunyanInstance = strapi.plugins.bunyan.services.bunyan.getInstance();

🎉 Use Bunyan CLI

You can use the power of Bunyan CLI http://trentm.com/node-bunyan/bunyan.1.html

Example

./node_modules/.bin/bunyan error.log

💔 Disabling

Disabling only the middleware

By default, this plugin uses a middleware that logs all your unhandled API errors to log file. You can disable this feature by turning off the bunyan middleware in your app's config.

Example

./config/middleware.js

module.exports = {
  //...
  settings: {
    bunyan: {
      enabled: false,
    },
  },
};

Only the middleware will be disabled. You will still have access to the Bunyan service.

🤝 Contributing

Feel free to fork and make a Pull Request to this plugin project. All the input is warmly welcome!

⭐️ Show your support

Give a star if this project helped you.