# resting-squirrel-es-logger

> ElasticSearch logger for Resting Squirrel apps.

Latest version **1.0.3** (published 2020-10-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install resting-squirrel-es-logger
pnpm add resting-squirrel-es-logger
yarn add resting-squirrel-es-logger
bun add resting-squirrel-es-logger
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2020-10-26 |
| First published | 2020-06-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 1 |
| Unpacked size | 27.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Lukas Macuda |
| Maintainers | zabkwak |

## Links

- npm: https://www.npmjs.com/package/resting-squirrel-es-logger
- Repository: https://github.com/zabkwak/resting-squirrel-es-logger
- Homepage: https://github.com/zabkwak/resting-squirrel-es-logger#readme
- Issues: https://github.com/zabkwak/resting-squirrel-es-logger/issues
- npm.io page: https://npm.io/package/resting-squirrel-es-logger

## Dependencies (1)

- [moment](https://npm.io/package/moment.md) ^2.27.0

## Recent versions

- 1.0.3 (latest) — 2020-10-26
- 1.0.2 — 2020-10-26
- 1.0.1 — 2020-10-26
- 1.0.0 — 2020-06-29

## README

# resting-squirrel-es-logger
ElasticSearch logger for Resting Squirrel apps.

## Requirements
- Node.js >= 8
- ElasticSearch 7

## Installation
```bash
npm install resting-squirrel-es-logger --save
```

## Usage
```javascript
import rs from 'resting-squirrel'; // peer dependency
import logger from 'resting-squirrel-es-logger';

const app = rs({
	logger: logger(/* options */),
});

app.start();

```

## Options
**appName: string** - Name of the application. Default: `RS App`  
**clearTemplate: boolean** - Indicates if the ES template is deleted before the logger init. Default: `false`  
**getCustomData: (property: string, loggerData: ILoggerData) => any** - Function to get the value of custom property. Default: `null`  
**indexTimeFormat: string** - Time format from `moment` for the index suffix. Default: `YYYY-MM-DD`  
**node: string** - ES node. Default: `http://localhost:9200`  
**onError: (error: any) => void** - Function called if some error occurs. Default: `null`  
**onReady: () => void** - Function called if the logger is ready. Default: `null`  
**template: Template** - Template data. Default: `{ name: 'rs-es-logger', numberOfReplicas: 0, numberOfShards: 1, properties: {} }`  
**transformBody: (property: string, value: any) => any** - Function to transform property value before the save in the request body. Default: `null`  
**transformQuery: (property: string, value: any) => any** - Function to transform property value before the save in the request query. Default: `null`  
### Template
**name: string** - Name of the template. Default: `rs-es-logger`  
**numberOfReplicas: number** - Number of replicas. Default: `0`  
**numberOfShards: number** - Number of shards. Default: `1`  
**properties: { [key: string]: any }** - Custom template properties for custom data. Default: `{}`  

## Transforms
Data in body and query can be transformed. 
```javascript
import logger from 'resting-squirrel-es-logger';

logger({
	transformBody(property, value) {
		switch (property) {
			case 'password':
				return '********'; // We really don't want to have passwords in database
			case 'profile_picture': // The picture is in base64
				return `[file(${value?.length})]`; // We don't want to save large data to database
			default: 
				return value;
		}
	},
});

```

## Custom data
Custom data can be indexed as well. It should be the data for further searches.
```javascript
import logger from 'resting-squirrel-es-logger';

logger({
	template: {
		properties: {
			userId: {
				type: 'integer',
			},
		},
	},
	getCustomData(property, { headers }) {
		// Logger doesn't have access to the incoming request so we have to store the userId to the headers in auth middleware
		switch (property) {
			case 'userId':
				// After that we can access userId from headers and save it
				return headers?.userId || null;
			default: 
				return null;
		}
	},
});

```

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