# @elartedelcodigo/express-logger

> Librería para generar logs para express con pino

Latest version **1.3.0** (published 2023-05-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @elartedelcodigo/express-logger
pnpm add @elartedelcodigo/express-logger
yarn add @elartedelcodigo/express-logger
bun add @elartedelcodigo/express-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.3.0 |
| Published | 2023-05-15 |
| First published | 2023-04-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 57.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Alex Quispe |
| Maintainers | alexquispe |
| Keywords | Librería, para, generar, logs, para, express, con, pino |

## Links

- npm: https://www.npmjs.com/package/@elartedelcodigo/express-logger
- Repository: https://github.com/ElArteDelCodigo/express-logger
- Homepage: https://github.com/ElArteDelCodigo/express-logger#readme
- Issues: https://github.com/ElArteDelCodigo/express-logger/issues
- npm.io page: https://npm.io/package/@elartedelcodigo/express-logger

## Dependencies (9)

- [ip](https://npm.io/package/ip.md) ^1.1.8
- [pino](https://npm.io/package/pino.md) ^8.11.0
- [axios](https://npm.io/package/axios.md) ^1.3.6
- [dayjs](https://npm.io/package/dayjs.md) ^1.11.7
- [express](https://npm.io/package/express.md) ^4.18.2
- [pino-http](https://npm.io/package/pino-http.md) ^8.3.3
- [cls-rtracer](https://npm.io/package/cls-rtracer.md) ^2.6.2
- [rotating-file-stream](https://npm.io/package/rotating-file-stream.md) ^3.1.0
- [express-list-endpoints](https://npm.io/package/express-list-endpoints.md) ^6.0.0

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 1.3.0 (latest) — 2023-05-15
- 1.2.0 — 2023-04-29
- 1.1.1 — 2023-04-28
- 1.1.0 — 2023-04-28
- 1.0.0 — 2023-04-26

## README

<h1 align="center">Express Logger</h1>

<p align="center">
  <a href="https://github.com/ElArteDelCodigo/express-logger/releases">
    <img src="https://img.shields.io/github/v/release/ElArteDelCodigo/express-logger" alt="release">
  </a>
  <a href="https://github.com/ElArteDelCodigo/express-logger/blob/main/LICENSE">
    <img src="https://img.shields.io/github/license/ElArteDelCodigo/express-logger" alt="License: MIT" />
  </a>
</p>

Librería para generar logs para express con pino

## Instalación

```bash
npm install @elartedelcodigo/express-logger
```

## Ejemplo

```txt
app
  ├─ src
  │     └─ routes
  │           └─ application.ts
  └─ server.ts
```

Archivo `src/routes/application.ts`

```ts
import express, { NextFunction, Request, Response } from 'express'
import { ExpressLogger } from '@elartedelcodigo/express-logger'

const router = express.Router()
const logger = ExpressLogger.getInstance()

// eslint-disable-next-line
router.get('/success/:logLevel', (req: Request, res: Response, next: NextFunction) => {
  logger[req.params.logLevel](`Mensaje de tipo ${req.params.logLevel}`)
  res.status(200).send('ok')
})

// eslint-disable-next-line
router.get('/error', (req: Request, res: Response, next: NextFunction) => {
  logger.error('[local] error from src/routes/application.ts')
  throw new Error('some error')
})

export default router
```

Archivo `server.ts`

```ts
import express, { NextFunction, Request, Response } from 'express'
import { ExpressLogger, printLogo, printInfo, printRoutes } from '@elartedelcodigo/express-logger'
import router from './src/routes/application'

export const app = express()

ExpressLogger.initialize(app, {
  appName: 'test-backend',
  logPath: '/tmp/log',
})

const logger = ExpressLogger.getInstance()

app.use((req: Request, res: Response, next: NextFunction) => {
  logger.trace(`${req.method} ${req.originalUrl}`)
  return next()
})

// eslint-disable-next-line
app.get('/', (req: Request, res: Response, next: NextFunction) => {
  logger.info('ok')
  res.status(200).send('ok')
})

// api routes
app.use('/api', router)

// eslint-disable-next-line
app.use((err: Error, req: Request, res: Response, next: NextFunction) => {
  logger.error(err)
  res.status(500).send('error')
})

printRoutes(app)
printLogo()
printInfo({
  name: 'test-backend',
  version: '1.0.0',
  env: 'development',
  port: '3333',
})

app.listen(3333, () => {
  process.stdout.write(`App running on port ${3333}\n`)
})
```

Resultado 1: Al ejecutar la aplicación

![Captura 1](./assets/screen_1.png)

Resultado 2: Al realizar algunas peticiones

![Captura 2](./assets/screen_2.png)

Resultado 3:

Se habrán creado los siguientes archivos: `error.log`, `info.log` y `warn.log`.

```txt
/tmp
  ├─ log
        └─ test-backend
              ├─ error.log
              ├─ info.log
              └─ warn.log
```

Contenido del archivo: `info.log`

```json
{"level":30,"time":"2023-04-28T00:41:33.936Z","pid":21195,"hostname":"server","name":"test-backend","context":"print-routes.ts:14:1","msg":"Cargando aplicación..."}
{"level":30,"time":"2023-04-28T00:41:33.941Z","pid":21195,"hostname":"server","name":"test-backend","context":"print-info.ts:17:1","msg":"test-backend v1.0.0"}
{"level":30,"time":"2023-04-28T00:41:35.974Z","pid":21195,"hostname":"server","name":"test-backend","reqId":"6e117330-e55d-11ed-ae62-f1c38d6314d3","context":"server.ts:21:1","msg":"ok"}
{"level":30,"time":"2023-04-28T00:41:35.977Z","pid":21195,"hostname":"server","name":"test-backend","request":{"id":"6e117330-e55d-11ed-ae62-f1c38d6314d3","method":"GET","url":"/"},"response":{"statusCode":200},"response time [ms]":5,"msg":"Petición concluida - 200"}
{"level":30,"time":"2023-04-28T00:41:36.988Z","pid":21195,"hostname":"server","name":"test-backend","reqId":"6eac53a0-e55d-11ed-ae62-f1c38d6314d3","context":"application.ts:9:3","msg":"Mensaje de tipo info"}
...
```

## Opciones de configuración

| Opción        | Descripción                                                                    | Valor por defecto |
| ------------- | ------------------------------------------------------------------------------ | ----------------- |
| appName       | Nombre de la aplicación                                                        | 'app'             |
| logPath       | Ruta absoluta de la carpeta logs. Si esta vacio no se crearán los archvos.     | ''                |
| logLevel      | Nivel de logs a registrar. error > warn > info > debug > trace                 | 'info'            |
| logSize       | Para los ficheros de logs es el tamaño máximo que estos pueden llegar a pesar. | '5M'              |
| logInterval   | Para los ficheros de logs es el intervalo de tiempo para rotar los ficheros.   | '1d'              |
| logCompress   | Para indicar si se comprimirá o no los ficheros de logs.                       | 'false'           |
| logHide       | Indica los campos que serán ofuscados al momento de guardar los logs.          | ''                |
| subFolderName | Subcarpeta que se utilizará para guardar los ficheros de logs                  | ''                |

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