Discover the Power of jsonserver-logger

The jsonserver-logger is a powerful tool that enhances the capabilities of JSON server by adding comprehensive logging functionalities. This will greatly help in monitoring and debugging of APIs. In this guide, we will walk you through the various APIs provided by jsonserver-logger along with code snippets to get you started. Let’s dive in!

API Explanations with Code Snippets

1. Basic Setup

To start using jsonserver-logger, you need to set up a basic JSON server. Below is a simple example:

  const jsonServer = require('json-server')
  const server = jsonServer.create()
  const router = jsonServer.router('db.json')
  const middlewares = jsonServer.defaults()
  const logger = require('jsonserver-logger')
  
  server.use(middlewares)
  server.use(logger)
  server.use(router)
  
  server.listen(3000, () => {
    console.log('JSON Server is running with logger')
  })

2. Custom Logging Formats

You can customize the format of logging messages to suit your needs:

  const logger = require('jsonserver-logger')
  
  logger.format('custom', ':method :url :status :res[content-length] - :response-time ms')

3. Conditional Logging

Conditional logging can be implemented to log only specific requests:

  const logger = require('jsonserver-logger')

  logger.use((req, res, next) => {
    if (req.method === 'POST') {
      console.log('Post request logged:', req.url)
    }
    next()
  })

4. Error Logging

Log errors encountered during handling requests:

  const logger = require('jsonserver-logger')

  logger.use((err, req, res, next) => {
    console.error('Error encountered:', err.message)
    next(err)
  })

5. Integration with Third-party Services

Integrate with third-party logging services like Sentry:

  const Sentry = require('@sentry/node')
  const jsonLogger = require('jsonserver-logger')

  Sentry.init({ dsn: 'your-dsn-url' })

  jsonLogger.use((req, res, next) => {
    Sentry.captureMessage('Request received: ' + req.method + ' ' + req.url)
    next()
  })

Full App Example

Below is a full example demonstrating the various APIs introduced above:

  const jsonServer = require('json-server')
  const server = jsonServer.create()
  const router = jsonServer.router('db.json')
  const middlewares = jsonServer.defaults()
  const logger = require('jsonserver-logger')
  const Sentry = require('@sentry/node')

  Sentry.init({ dsn: 'your-dsn-url' })

  logger.format('custom', ':method :url :status :res[content-length] - :response-time ms')

  server.use(middlewares)
  server.use(logger)
  server.use((req, res, next) => {
    if (req.method === 'POST') {
      console.log('Post request logged:', req.url)
    }
    next()
  })
  server.use((err, req, res, next) => {
    console.error('Error encountered:', err.message)
    next(err)
  })
  server.use((req, res, next) => {
    Sentry.captureMessage('Request received: ' + req.method + ' ' + req.url)
    next()
  })
  server.use(router)

  server.listen(3000, () => {
    console.log('JSON Server is running with comprehensive logging')
  })

Start using jsonserver-logger today and streamline your API logging and debugging processes!

Hash: ddb3e93403796a6d0bb73dbe8db2a7302ea396c3af332f6a5751adcc41e1a682