[![view on npm](https://badgen.net/npm/v/common-log-format)](https://www.npmjs.org/package/common-log-format)
[![npm module downloads](https://badgen.net/npm/dt/common-log-format)](https://www.npmjs.org/package/common-log-format)
[![Gihub repo dependents](https://badgen.net/github/dependents-repo/75lb/common-log-format)](https://github.com/75lb/common-log-format/network/dependents?dependent_type=REPOSITORY)
[![Gihub package dependents](https://badgen.net/github/dependents-pkg/75lb/common-log-format)](https://github.com/75lb/common-log-format/network/dependents?dependent_type=PACKAGE)
[![Node.js CI](https://github.com/75lb/common-log-format/actions/workflows/node.js.yml/badge.svg)](https://github.com/75lb/common-log-format/actions/workflows/node.js.yml)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)

# common-log-format

Pipe [common log format](http://en.wikipedia.org/wiki/Common_Log_Format) in, get JSON out. Useful for converting web logs into a format more easily consumed by Javascript.

Standard log input such as:

```
127.0.0.1 - - [Wed, 11 Jun 2014 16:24:02 GMT] "GET / HTTP/1.1" 200 10305 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_3) AppleWebKit/537.76.4 (KHTML, like Gecko) Version/7.0.4 Safari/537.76.4"
127.0.0.1 - - [Wed, 11 Jun 2014 16:24:08 GMT] "GET /package.json HTTP/1.1" 304 - "http://localhost:8000/" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_3) AppleWebKit/537.76.4 (KHTML, like Gecko) Version/7.0.4 Safari/537.76.4"
```

would be converted to

```json
{
  "remoteHost": "127.0.0.1",
  "remoteLogName": "-",
  "authUser": "-",
  "date": "2014-06-11T16:24:02.000Z",
  "request": "GET / HTTP/1.1",
  "status": 200,
  "bytes": 10305
}
{
  "remoteHost": "127.0.0.1",
  "remoteLogName": "-",
  "authUser": "-",
  "date": "2014-06-11T16:24:08.000Z",
  "request": "GET /package.json HTTP/1.1",
  "status": 304,
  "bytes": null
}
```

## Usage

### As a library

```sh
$ npm install common-log-format
```

```js
import clf from 'common-log-format'

process.stdin.pipe(clf()).pipe(process.stdout)
```

### Command line

This will install the `clf` command line tool:

```sh
$ npm install -g common-log-format
```

```sh
$ cat my-web-log.txt | clf
{"remoteHost":"127.0.0.1","remoteLogName":"-","authUser":"-","date":"2014-06-11T16:05:26.000Z","request":"GET /package.json HTTP/1.1","status":200,"bytes":733}
```

* * *

&copy; 2015-2023 Lloyd Brookes \<75pound@gmail.com\>.