# @namics/remlog-server

> ###### Contents

Latest version **0.3.2** (published 2018-10-10) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @namics/remlog-server
pnpm add @namics/remlog-server
yarn add @namics/remlog-server
bun add @namics/remlog-server
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.3.2 |
| Published | 2018-10-10 |
| First published | 2018-01-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 24.2 KB |
| Known vulnerabilities | 0 (+5 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Jan Biasi |
| Maintainers | ddegiorgioo, ernscht, janbiasi, jantimon, namicsorg, regaddi, smollweide |
| Keywords | remote, logging, remlog, node, debug, transport, @namics/remlog, remotely, server |

## Links

- npm: https://www.npmjs.com/package/@namics/remlog-server
- Repository: https://github.com/namics/node-remlog
- Homepage: https://github.com/namics/node-remlog#readme
- Issues: https://github.com/namics/node-remlog/issues
- npm.io page: https://npm.io/package/@namics/remlog-server

## Dependencies (10)

- [hbs](https://npm.io/package/hbs.md) 4.0.1
- [cors](https://npm.io/package/cors.md) ^2.8.4
- [helmet](https://npm.io/package/helmet.md) 3.9.0
- [express](https://npm.io/package/express.md) 4.16.2
- [body-parser](https://npm.io/package/body-parser.md) 1.18.2
- [compression](https://npm.io/package/compression.md) 1.7.1
- [@namics/remlog-debug](https://npm.io/package/@namics/remlog-debug.md) 0.2.2
- [@namics/remlog-utils](https://npm.io/package/@namics/remlog-utils.md) 0.2.2
- [@namics/remlog-scheme](https://npm.io/package/@namics/remlog-scheme.md) 0.2.2
- [@namics/remlog-transports](https://npm.io/package/@namics/remlog-transports.md) 0.2.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.3.2 (latest) — 2018-10-10
- 0.2.0 — 2018-02-01
- 0.1.11 — 2018-01-25
- 0.1.9 — 2018-01-24
- 0.1.7 — 2018-01-24
- 0.1.6 — 2018-01-23
- 0.1.5 — 2018-01-23
- 0.1.4 — 2018-01-22
- 0.1.3 — 2018-01-22
- 0.1.2 — 2018-01-22

## README

# @namics/remlog-server

###### Contents

```js
const { Server } = require('@namics/remlog-server');
```

The server package is the main core for the remote logging process and provides you the API needed to trace logs immediately.
There are a few endpoints you should know first:

* `/` will give you an overview about all the logs happend in the current process
* `/info` will show you the package name and version of the server instance
* `/trace` is a HTTP POST route and will take the JSON body as trace payload
* `/tracer.jpg` is a HTTP GET API and is implement by the [`@namics/remlog-browser-client`](/packages/browser-client) package to provide a cross-browser method to log messages
* `/logs.json` will return an array of JSON objects representing all your logs
* `/logs/<log-id>.json` will show you a single log entry in JSON format

### Examples

```js
new require('@namics/remlog-server')
	.Server({
		port: 8123,
		transport: `@namics/remlog-transports/Console`, // default
		cors: ['*'] // default
	})
	.start();
```

```js
new require('@namics/remlog-server')
	.Server({
		port: 9001,
		transport: `@namics/remlog-transports/FileSystem`,
		cors: ['my-domain.com', 'remote.namics.com'],
		// enables SSL on the server
		ssl: {
			key: './ssl/my-domain/key.pem',
			cert: './ssl/my-domain/cert.pem',
			passphrase: 'k12Sh1$£1e3^7VcaR#t'
		}
	})
	.start();
```

### Sending a trace to the Server via AJAX

> This uses the HTTP POST JSON API from the server exposed under the `/trace` route.

```js
import axios from 'axios';
import { LOGLEVEL, getTraceUrl } from '@namics/remlog-utils';

const serverConfig = {
	host: '127.0.0.1',
	port: '<your-server-port>'
};

axios.post(getTraceUrl(serverConfig), {
	shortMessage: 'Hey you!',
	fullMessage: 'Blablabla',
	level: LOGLEVEL.INFO
});
```

> Review the [Changelog](/packages/server/CHANGELOG.md)

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