# server-summary

> Log basic server information after an http server start.

Latest version **6.1.0** (published 2016-11-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install server-summary
pnpm add server-summary
yarn add server-summary
bun add server-summary
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 6.1.0 |
| Published | 2016-11-08 |
| First published | 2014-12-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Maintainers | yoshuawuyts |
| Keywords | server, log, callback |

## Links

- npm: https://www.npmjs.com/package/server-summary
- Repository: https://github.com/yoshuawuyts/server-summary
- Homepage: https://github.com/yoshuawuyts/server-summary#readme
- Issues: https://github.com/yoshuawuyts/server-summary/issues
- npm.io page: https://npm.io/package/server-summary

## 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

- 6.1.0 (latest) — 2016-11-08
- 6.0.1 — 2016-03-23
- 6.0.0 — 2016-03-23
- 5.0.1 — 2016-02-24
- 5.0.0 — 2015-12-07
- 4.0.1 — 2015-10-21
- 4.0.0 — 2015-10-21
- 3.3.1 — 2015-09-29
- 3.3.0 — 2015-09-29
- 3.2.0 — 2015-09-07
- 3.1.0 — 2015-09-06
- 3.0.2 — 2015-08-08
- 3.0.1 — 2015-08-08
- 3.0.0 — 2015-08-08
- 2.0.2 — 2015-05-09
- … 3 more at https://npm.io/package/server-summary/versions

## README

# server-summary
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]
[![Downloads][downloads-image]][downloads-url]

Log basic server information after an http server start as
[ndjson](http://ndjson.org/).

## Features
- log local url (useful for tools like
  [opnr](https://github.com/mattdesl/opnr))
- log port
- log environment
- log process id (useful for `dtrace(1)`, `kill(1)`)

## Usage
```js
const summary = require('server-summary')
const http = require('http')
const bole = require('bole')

const log = bole('my-server')

process.env.NODE_ENV = 'development'

const server = http.createServer()
server.listen(1337, summary(server, log.info))
```

## Why?
Knowing on what port your server is listening is nice to have. This module
logs some basic information after your server has started to `stdout`.

## Installation
```sh
$ npm install server-summary
```

## License
[MIT](https://tldrlegal.com/license/mit-license)

[npm-image]: https://img.shields.io/npm/v/server-summary.svg?style=flat-square
[npm-url]: https://npmjs.org/package/server-summary
[travis-image]: https://img.shields.io/travis/yoshuawuyts/server-summary.svg?style=flat-square
[travis-url]: https://travis-ci.org/yoshuawuyts/server-summary
[coveralls-image]: https://img.shields.io/coveralls/yoshuawuyts/server-summary.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/yoshuawuyts/server-summary?branch=master
[downloads-image]: http://img.shields.io/npm/dm/server-summary.svg?style=flat-square
[downloads-url]: https://npmjs.org/package/server-summary

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