logger-nodejs

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 16 Open GitHub ↗

Log API calls with Node.js

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# resurfaceio-logger-nodejs
Easily log API requests and responses to your own <a href="https://resurface.io">security data lake</a>.

[![npm](https://img.shields.io/npm/v/resurfaceio-logger)](https://badge.fury.io/js/resurfaceio-logger)
[![CodeFactor](https://www.codefactor.io/repository/github/resurfaceio/logger-nodejs/badge)](https://www.codefactor.io/repository/github/resurfaceio/logger-nodejs)
[![License](https://img.shields.io/github/license/resurfaceio/logger-nodejs)](https://github.com/resurfaceio/logger-nodejs/blob/master/LICENSE)
[![Contributing](https://img.shields.io/badge/contributions-welcome-green.svg)](https://github.com/resurfaceio/logger-nodejs/blob/master/CONTRIBUTING.md)

## Contents

<ul>
<li><a href="#dependencies">Dependencies</a></li>
<li><a href="#installing_with_npm">Installing With npm</a></li>
<li><a href="#logging_from_express_middleware">Logging From Express Middleware</a></li>
<li><a href="#logging_from_apollo_server_on_express">Logging From Apollo Server on Express</a></li>
<li><a href="#logging_from_express_route">Logging From Specific Express Routes</a></li>
<li><a href="#logging_with_api">Logging With API</a></li>
<li><a href="#privacy">Protecting User Privacy</a></li>
</ul>

## Dependencies

Requires Node.js 10.x or later, and Axios http client. No other dependencies to conflict with your app.

## Installing With npm

```
npm install resurfaceio-logger --save
```

## Logging From Express Middleware

After <a href="#installing_with_npm">installing the module</a>, add a `HttpLoggerForExpress` instance to your app, after
any body parsers in use.

```js
const express = require('express');
const app = express();

// add body parsers

const resurfaceio = require('resurfaceio-logger');
resurfaceio.HttpLoggerForExpress.add(app, {
    url: 'http://localhost:7701/message', 
    rules: 'include debug'
});

// define routes
```

## Logging From Koa Middleware

After <a href="#installing_with_npm">installing the module</a>, add a `HttpLoggerForKoa` instance to your app, after
any body parsers in use.

```js
const Koa = require('koa');
const app = new Koa();

// add body parsers

const resurfaceio = require('resurfaceio-logger');
resurfaceio.HttpLoggerForKoa.add(app, {
    url: 'http://localhost:7701/message', 
    rules: 'include debug'
});

```

## Logging From Apollo Server on Express

After <a href="#installing_with_npm">installing the module</a>, add a `HttpLoggerForExpress` instance before calling `applyMiddleware`.

```js
const app = express();

const resurfaceio = require('resurfaceio-logger');
resurfaceio.HttpLoggerForExpress.add(app, {
    url: 'http://localhost:7701/message', 
    rules: 'include debug'
});

const server = new ApolloServer({ ... });

server.applyMiddleware({ app });
```

## Logging From Specific Express Routes

After <a href="#installing_with_npm">installing the module</a>, create a logger and call it from the routes of interest.

```js
const express = require('express');
const app = express();

const resurfaceio = require('resurfaceio-logger');
const logger = new resurfaceio.HttpLogger({
    url: 'http://localhost:7701/message',
    rules: 'include debug'
});

app.get('/', function (request, response) {
    response.render('pages/index', function (e, html) {
        response.status(200).send(html);
        resurfaceio.HttpMessage.send(logger, request, response, html);
    });
});
```

## Logging With API

Loggers can be directly integrated into your application using our [API](API.md). This requires the most effort compared with
the options described above, but also offers the greatest flexibility and control.

[API documentation](API.md)

## Protecting User Privacy

Loggers always have an active set of <a href="https://resurface.io/rules.html">rules</a> that control what data is logged
and how sensitive data is masked. All of the examples above apply a predefined set of rules (`include debug`),
but logging rules are easily customized to meet the needs of any application.

<a href="https://resurface.io/rules.html">Logging rules documentation</a>

logger-nodejs

Today's picks

Was this content helpful?

Recent Feedback

logger-nodejs

Today's picks

Was this content helpful?

Recent Feedback

Download README