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

@ovotech/axios-logger

v2.0.1

Published

Log responses with sanitization

Downloads

22

Readme

Axios Logger Interceptor

Log request and response, redact all possible PII sources by default, but allow to add custom redact paths so more info can be logged.

Using

yarn add @ovotech/axios-logger
import { axiosLogger, redactHeader } from '@ovotech/axios-logger';
import axios from 'axios';

const logger = axiosLogger((level, meta, config) => console.log(level, meta, config.url));

const api = axios.create();
api.interceptors.request.use(logger.request.onFullfilled);
api.interceptors.response.use(logger.response.onFullfilled, logger.response.onRejected);

// ...

api.get('/my/path');

const body = { user: { cards: [{ id: '111' }, { id: '222' }] } };
api.post('/update/path', body, { headers: { [redactHeader]: 'requestBody.user.cards.*.id' } });

You have 3 interceptors. logger.request.onFullfilled, logger.response.onFullfilled and logger.response.onRejected.

  • logger.request.onFullfilled used to setup the initial execution time. If omitted request time would not be logged.
  • logger.response.onFullfilled logs a successful response
  • logger.response.onRejected logs an error

Each one can be omitted if you don't want or need that feature.

The log function will receive 3 arguments - level, meta and axios request config. The first one indicates what type of log level to use - "info" for success and "error" for error. The second contains an object of data to log.

{
  uri: '/my/path',
  method: 'get',
  params: { id: '10' }
  requestBody: { id: '10' },
  responseBody: { user: 'Name' },
  status: 200,
  responseTime: 21,
}

By default uri, params, requestBody and responseBody will be "redacted", since they can contain personally identifiable information. You can control that with the redactHeader. Its a comma separated list of dot delimited field paths to be redacted. Can contain wildcard * path to target all array items.

For example to redact some fields.

api.post('/update/path', body, { headers: { [redactHeader]: 'requestBody.id, responseBody.user' });

You can also set redact at the axios instance level for global redaction rules:

const api = axios.create({ redact: ['requestBody'] });

Granular logging

You can perform different things on error / success by inspecting the "level" argument, passed to the log function.

import { axiosLogger } from '@ovotech/axios-logger';
import axios from 'axios';

const logger = axiosLogger((level, meta) => {
  if (level === 'info') {
    myOwnLogger.info('Successful request', meta);
    graphResponseTimes(meta.responseTime);
  }
  if (level === 'error') {
    myOwnLogger.error('Error request', meta);
  }
});

Running the tests

You can run the tests with:

yarn test

Coding style (linting, etc) tests

Style is maintained with prettier and tslint

yarn lint

Deployment

Deployment is preferment by lerna automatically on merge / push to master, but you'll need to bump the package version numbers yourself. Only updated packages with newer versions will be pushed to the npm registry.

Contributing

Have a bug? File an issue with a simple example that reproduces this so we can take a look & confirm.

Want to make a change? Submit a PR, explain why it's useful, and make sure you've updated the docs (this file) and the tests (see test folder).

License

This project is licensed under Apache 2 - see the LICENSE file for details