# @usvc/logger-request

> Morgan based logger for usage in a microservices architecture.

Latest version **0.1.1** (published 2018-08-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @usvc/logger-request
pnpm add @usvc/logger-request
yarn add @usvc/logger-request
bun add @usvc/logger-request
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2018-08-05 |
| First published | 2018-07-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 23.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | zephinzer |
| Maintainers | zephinzer |
| Keywords | log, logs, logger, microservices, morgan, request, usvc |

## Links

- npm: https://www.npmjs.com/package/@usvc/logger-request
- Repository: https://github.com/zephinzer/ms
- Homepage: https://github.com/zephinzer/ms#readme
- Issues: https://github.com/zephinzer/ms/issues
- npm.io page: https://npm.io/package/@usvc/logger-request

## Dependencies (2)

- [case](https://npm.io/package/case.md) ^1.5.5
- [morgan](https://npm.io/package/morgan.md) ^1.9.0

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 0.1.1 (latest) — 2018-08-05
- 0.1.0 — 2018-07-30
- 0.0.2 — 2018-07-29
- 0.0.1 — 2018-07-28

## README

# `@usvc/logger-request`
Morgan based logger for usage in a microservices architecture.

The output logs will include the following properties:

| Key | Description |
| --- | --- |
| level | This will always be `"access"` |
| method | The method of the HTTP request |
| url | The requested URL |
| status | The status code of the request |
| contentLength | The content length |
| responseTimeMs | The response time in milliseconds |
| httpVersion | The HTTP version |
| referrer | The referrer (if applicable) |
| remoteHostname | The remote hostname (if found) |
| remoteAddress | The remote IP address |
| serverHostname | The server hostname as specified in the `createLogger` method |
| time | ISO timestamp of the request |
| userAgent | User agent of the request |

## Scope

- [x] Creates an Express compatible request logger middleware
- [x] Allow for token extension
- [x] Allow for specification of a custom logger and log level

## Installation

```bash
npm i @usvc/logger-request;
# OR
yarn add @usvc/logger-request;
```

## Usage

```js
// es5:
const {createLogger} = require('@usvc/logger-request');
// es6:
import {createLogger} from '@usvc/logger-request';
```

### Basic

```js
const express = require('express');
// require as ^
const app = express();
app.use(createLogger());
app.listen(...);
```

### Full Configuration

```js
const express = require('express');
// require as ^
const app = express();
app.use(createLogger({

}));
app.listen(...);
```


## API Documentaiton

### `createLogger(:options)`
Creates the request logger middleware and returns an Express compatible middleware that you can `app.use(...)`.

**Parameters**

| Key | Defaults To | Description |
| --- | --- | --- |
| `additionalTokens` | `[]` | Additional tokenizers. Each item in the array should be of the form `{id: 'some-property', fn: (req, res) => (/*your code here*/)}`. |
| `hostname` | `os.hostname() || process.env.HOSTNAME || 'unknown'` | The host name to use for the server in the logs |
| `logger` | `console` | The logger to be used. |
| `level` | `info` | The level of the logger to be used. |

### `getZipkinTokenizers()`
This function returns an array of tokenizers that you can use in the `additionalTokenizers` option in `createLogger()`.

These tokenizers depend on there being a `.context` property in the `Request` object passed by Express. This is automatically done if you are using the Zipkin tracer as defined in [`@usvc/tracer`](../tracer).

Using the returned tokenizers will result in the following additional keys in the log:

| Key | Description |
| --- | --- |
| `traceId` | The trace ID |
| `spanId` | The span ID |
| `parentSpanId` | The parent span ID |
| `sampled` | Indication whether the request was sampled or not |

## Examples

### Usage with ES5
Goto: [./example/es5](./example/es5)

Or run: `npm run eg:es5`

### Usage with ES6
Goto: [./example/es6](./example/es6)

Or run: `npm run eg:es6`

### Usage with Winston
Goto: [./example/winston](./example/winston)

Or run: `npm run eg:winston`

## Development

See the [development instructions on the main repository's README](../../README.md#development).

## License

This package is licensed under the MIT license.

View the license at [LICENSE](./LICENSE).

## Changelog

WIP

## Contributors

| Name | Email | Website | About Me |
| --- | --- | --- | --- |
| Joseph | dev-at-joeir-dot-net | https://github.com/zephinzer | N/A |

# Cheers

---
_Source: https://npm.io/package/@usvc/logger-request · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._