# @elastic/ecs-helpers > ecs-logging-nodejs helpers Latest version **2.1.1** (published 2023-10-31) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install @elastic/ecs-helpers pnpm add @elastic/ecs-helpers yarn add @elastic/ecs-helpers bun add @elastic/ecs-helpers ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 2.1.1 | | Published | 2023-10-31 | | First published | 2020-02-11 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Node | >=10 | | Dependencies | 0 | | Unpacked size | 25.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 69 | | Author | Tomas Della Vedova | | Maintainers | bradtimmerman, devcorpio, yan.savitski, jeramysoucy, tkajtoch, johnwcambra, colleen.mcginnis, scottybollinger, kyrspl, phoey1, verogo, breehall, trevorpierce, glitteringkatie, jen-huang, delvedor, lukasolson, ccowan, jbudz, thomasneirynck, weltenwort, pugnascotia, zinckiwi, brandon.kobel, nreese, mgreau, jonahbull, jarpy, leathekd, lukeelmers, ddillinger, joshdover, jasonstoltz, bamieh, markov00, joshmock, vignesh.shanmugam, watson, rhodesjason, jmlrt, mattkime, constancecchen, afoucret, nickpeihl, axw, mistic, elasticmachine, gtback, pickypg, trentm, andrewvc-elastic, jorge.sanz, stratoula, nkammah, streamich, nickofthyme, chloeruka | ## Links - npm: https://www.npmjs.com/package/@elastic/ecs-helpers - Repository: https://github.com/elastic/ecs-logging-nodejs - Homepage: https://github.com/elastic/ecs-logging-nodejs/blob/main/helpers/README.md - Issues: https://github.com/elastic/ecs-logging-nodejs/issues - npm.io page: https://npm.io/package/@elastic/ecs-helpers ## Recent versions - 2.1.1 (latest) — 2023-10-31 - 2.1.0 — 2023-10-30 - 2.0.0 — 2023-10-25 - 1.1.0 — 2021-03-18 - 1.0.0 — 2021-02-08 - 0.6.0 — 2021-01-26 - 0.5.0 — 2021-01-21 - 0.4.0 — 2021-01-20 - 0.3.0 — 2021-01-05 - 0.2.1 — 2020-05-21 - 0.2.0 — 2020-03-16 - 0.1.0 — 2020-02-11 ## README # @elastic/ecs-helpers [![Build Status](https://apm-ci.elastic.co/buildStatus/icon?job=apm-agent-nodejs%2Fecs-logging-nodejs-mbp%2Fmain)](https://apm-ci.elastic.co/job/apm-agent-nodejs/job/ecs-logging-nodejs-mbp/job/main/) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/) A set of helpers for the other [ecs-logging-nodejs packages](../). You should not directly use this package. ## Install ```sh npm install @elastic/ecs-helpers ``` ## API ### `version` The currently supported version of [Elastic Common Schema](https://www.elastic.co/guide/en/ecs/current/index.html). ### `formatError(obj, err) -> bool` A function that adds [ECS Error fields](https://www.elastic.co/guide/en/ecs/current/ecs-error.html) for a given `Error` object. It returns true iff the given `err` was an Error object it could process. ```js const { formatError } = require('@elastic/ecs-helpers') const logRecord = { msg: 'oops', /* ... */ } formatError(logRecord, new Error('boom')) console.log(logRecord) ``` will show: ```js { msg: 'oops', error: { type: 'Error', message: 'boom', stack_trace: 'Error: boom\n' + ' at REPL30:1:26\n' + ' at Script.runInThisContext (vm.js:133:18)\n' + // ... } } ``` The ECS logging libraries typically use this to automatically handle an `err` metadata field passed to a logging statement. E.g. `log.warn({err: myErr}, '...')` for pino, `log.warn('...', {err: myErr})` for winston. ### `formatHttpRequest(obj, req) -> bool` Function that enhances an ECS object with http request data. The given request object, `req`, must be one of the following: - Node.js's core [`http.IncomingMessage`](https://nodejs.org/api/all.html#http_class_http_incomingmessage), - [Express's request object](https://expressjs.com/en/5x/api.html#req) that extends IncomingMessage, or - a [hapi request object](https://hapi.dev/api/#request). The function returns true iff the given `req` was a request object it could process. Note that currently this notably does not process a [`http.ClientRequest`](https://nodejs.org/api/all.html#http_class_http_clientrequest) as returned from `http.request()`. ```js const http = require('http') const { formatHttpRequest } = require('@elastic/ecs-helpers') http.createServer(function (req, res) { res.end('hi') const obj = {} formatHttpRequest(obj, req) console.log('obj:', JSON.stringify(obj, null, 4)) }).listen(3000) ``` Running this and making a request via `curl http://localhost:3000/` will print something close to: ``` obj: { "http": { "version": "1.1", "request": { "method": "get", "headers": { "host": "localhost:3000", "accept": "*/*" } } }, "url": { "full": "http://localhost:3000/", "path": "/" }, "client": { "address": "::1", "ip": "::1", "port": 61969 }, "user_agent": { "original": "curl/7.64.1" } } ``` ### `formatHttpResponse(obj, res)` Function that enhances an ECS object with http response data. The given request object, `req`, must be one of the following: - Node.js's core [`http.ServerResponse`](https://nodejs.org/api/all.html#http_class_http_serverresponse), - [Express's response object](https://expressjs.com/en/5x/api.html#res) that extends ServerResponse, or - a [hapi **request** object](https://hapi.dev/api/#request) The function returns true iff the given `res` was a response object it could process. Note that currently this notably does not process a [`http.IncomingMessage`](https://nodejs.org/api/all.html#http_class_http_incomingmessage) that is the argument to the ["response" event](https://nodejs.org/api/all.html#http_event_response) of a [client `http.request()`](https://nodejs.org/api/all.html#http_http_request_options_callback) ```js const http = require('http') const { formatHttpRequest } = require('@elastic/ecs-helpers') http.createServer(function (req, res) { res.setHeader('Foo', 'Bar') res.end('hi') const obj = {} formatHttpResponse(obj, res) console.log('obj:', JSON.stringify(obj, null, 4)) }).listen(3000) ``` Running this and making a request via `curl http://localhost:3000/` will print something close to: ``` rec: { "http": { "response": { "status_code": 200, "headers": { "foo": "Bar" } } } } ``` ## License This software is licensed under the [Apache 2 license](./LICENSE). --- _Source: https://npm.io/package/@elastic/ecs-helpers · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._