{"id":18974976,"url":"https://github.com/bufferapp/buffer-js-logger","last_synced_at":"2026-04-08T18:30:17.328Z","repository":{"id":65840774,"uuid":"64961363","full_name":"bufferapp/buffer-js-logger","owner":"bufferapp","description":"Node.js logging for Buffer applications","archived":false,"fork":false,"pushed_at":"2020-03-02T07:39:03.000Z","size":33,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-02-01T14:04:53.166Z","etag":null,"topics":["javascript","middleware"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bufferapp.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-04T19:25:30.000Z","updated_at":"2020-03-02T07:39:02.000Z","dependencies_parsed_at":"2023-02-13T14:10:12.113Z","dependency_job_id":null,"html_url":"https://github.com/bufferapp/buffer-js-logger","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bufferapp%2Fbuffer-js-logger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bufferapp%2Fbuffer-js-logger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bufferapp%2Fbuffer-js-logger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bufferapp%2Fbuffer-js-logger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bufferapp","download_url":"https://codeload.github.com/bufferapp/buffer-js-logger/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239972513,"owners_count":19727394,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","middleware"],"created_at":"2024-11-08T15:16:52.402Z","updated_at":"2026-04-08T18:30:17.283Z","avatar_url":"https://github.com/bufferapp.png","language":"JavaScript","readme":"# @bufferapp/logger\n\n[![NPM Version](https://img.shields.io/npm/v/@bufferapp/logger.svg)](https://www.npmjs.com/package/@bufferapp/logger)\n[![Build Status](https://travis-ci.org/bufferapp/buffer-js-logger.svg?branch=master)](https://travis-ci.org/bufferapp/buffer-js-logger)\n\nProvides standard middleware and functions for logging to stdout. In our production cluster these\nlogs will be indexed in our application-logs Elasticsearch cluster as well as get backed up in s3.\n\n## Install\n\n```\nnpm install @bufferapp/logger -SE\n```\n\n## Usage\n\nTo log something, use the logger's `info` method which takes 2 arguments, an object for\nstructured logging and a string for a message:\n\n```js\nlogger.info(\u003cObject\u003e, \u003cString\u003e);\n```\n\nTo use as a normal logger, require and create the logger:\n\n```js\nconst logger = require('@bufferapp/logger')({ name: 'Some-Worker' });\n\nfunction run(data) {\n  // log something one-off...\n  logger.info({\n    metadata: {\n      service: data.service,\n    },\n    stats: {\n      processingTime: data.time,\n      count: data.count,\n    }\n  }, `Successfully processed ${data.count} items`);\n}\n```\n\n### Middleware\n\n```js\nconst logMiddleware = require('@bufferapp/logger/middleware');\n\napp = express();\napp.use(logMiddleware({ name: 'My-App' }));\n// ...other middleware and route handlers\n```\n\n#### Metadata\n\nAdd application metadata to your logs using the `getMetadata` option.\n\n```js\napp.use(logMiddleware({\n  getMetadata: (req) =\u003e {\n    return {\n      userId: req.session.userId,\n      profileId: req.query.profileId,\n    };\n  },\n}));\n```\n\n#### Stats\n\nAdd application stats to your logs. You receive the request object and the response time in\nmilliseconds. For example, you can add tracking metrics to a `req.trackingData` attribute and\nthen handle them in your `getStats` method:\n\n```js\napp.use(logMiddleware({\n  name: 'My-App',\n  getStats: (req, responseTime) =\u003e {\n    return {\n      responseTime,\n      processingTime: responseTime - req.trackingData.externalRequestTime,\n      imagesScanned: req.trackingData.imagesScanned,\n    };\n  },\n}));\n// In your request handler\napp.get('/get-images', (req, res) =\u003e {\n  req.trackingData = {};\n  getImages(req.url, (images) =\u003e {\n    req.trackingData.imagesScanned = images.length;\n    res.json(images);\n  });\n});\n```\n\n#### Params\n\nAdd logging of specific query string params using the `getMetadata` option.\n\n```js\napp.use(logMiddleware({\n  params: ['profile_id', 'utm_campaign'],\n}));\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbufferapp%2Fbuffer-js-logger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbufferapp%2Fbuffer-js-logger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbufferapp%2Fbuffer-js-logger/lists"}