{"id":15509747,"url":"https://github.com/willin/koa-api-logger","last_synced_at":"2025-04-23T02:51:20.968Z","repository":{"id":22081374,"uuid":"95183971","full_name":"willin/koa-api-logger","owner":"willin","description":"API Logger for Koa","archived":false,"fork":false,"pushed_at":"2023-02-03T03:26:00.000Z","size":511,"stargazers_count":6,"open_issues_count":5,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-10T17:42:45.650Z","etag":null,"topics":["api","koa","logger"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/koa-api-logger","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/willin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-23T04:47:43.000Z","updated_at":"2022-02-12T03:59:05.000Z","dependencies_parsed_at":"2023-02-13T04:40:20.827Z","dependency_job_id":null,"html_url":"https://github.com/willin/koa-api-logger","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willin%2Fkoa-api-logger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willin%2Fkoa-api-logger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willin%2Fkoa-api-logger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willin%2Fkoa-api-logger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/willin","download_url":"https://codeload.github.com/willin/koa-api-logger/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249694132,"owners_count":21311497,"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":["api","koa","logger"],"created_at":"2024-10-02T09:43:40.112Z","updated_at":"2025-04-23T02:51:20.945Z","avatar_url":"https://github.com/willin.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# koa-api-logger\n\n[![npm](https://img.shields.io/npm/v/koa-api-logger.svg?style=plastic)](https://npmjs.org/package/koa-api-logger) [![npm](https://img.shields.io/npm/dm/koa-api-logger.svg?style=plastic)](https://npmjs.org/package/koa-api-logger) [![npm](https://img.shields.io/npm/dt/koa-api-logger.svg?style=plastic)](https://npmjs.org/package/koa-api-logger) [![codecov](https://codecov.io/gh/willin/koa-api-logger/branch/master/graph/badge.svg)](https://codecov.io/gh/willin/koa-api-logger) [![Travis-CI](https://travis-ci.org/willin/koa-api-logger.svg?branch=master)](https://travis-ci.org/willin/koa-api-logger)\n\n[中文说明](https://github.com/willin/koa-api-logger/blob/master/README_zh.md#koa-api-logger)\n\n## Usage\n\n### Install\n\n```bash\nyarn add koa-api-logger\n# or\nnpm i -S koa-api-logger\n```\n\n### Use\n\n```js\nconst Koa = require('koa');\nconst router = require('koa-router')();\nconst logger = require('koa-api-logger');\n\nconst app = new Koa();\n\napp.use(\n  logger({\n    // options\n  })\n);\n\nrouter.get('/user/:name', ctx =\u003e {\n  ctx.body = name;\n});\n\napp.use(router.routes()).use(router.allowedMethods());\n\napp.listen(3000);\n```\n\n### Options\n\n```js\n{\n  err: async (ctx, err) =\u003e {\n    // codes to handle error\n  },\n  // Such as: ['/upload']\n  ignore: [],\n  redis: {\n    host: '127.0.0.1',\n    port: 6379,\n    db: 0, // db to store\n    keyPrefix: 'kal:', // redis store prefix\n    ttl: 86400 * 180 // saving logs for 180 days\n  }\n}\n```\n\n## Design\n\n### Redis Hash Table\n\n`key:20170808`\n\n| key      | val                                   |\n| -------- | ------------------------------------- |\n| total    | {count:1,success:1,avg:1,max:1,min:1} |\n| /#{path} | {count:1,success:1,avg:1,max:1,min:1} |\n\n## Monitor\n\n```js\nconst monitor = require('koa-api-logger/monitor');\nconst appName = monitor({\n  host: '127.0.0.1',\n  port: 6379,\n  db: 0,\n  keyPrefix: 'kal:'\n});\n\nappName('20170808').then(data =\u003e console.log);\n/* like:\n[\n  {\n    key: 'total',\n    data: { count: 2, success: 2, avg: 0.5, max: 1, min: 0 }\n  },\n  {\n    key: 'GET::/user/:name',\n    data: { count: 3, success: 3, avg: 0.3333333333333333, max: 1, min: 0 }\n  }\n]\n*/\n```\n\nHistory:\n\n```js\nappName.history().then(data =\u003e console.log);\n/* like:\n[\n '20170504',\n '20170505'\n]\n*/\n```\n\n## License\n\nMIT\n\nDonate Via Alipay：\n\n![qr](https://cloud.githubusercontent.com/assets/1890238/15489630/fccbb9cc-2193-11e6-9fed-b93c59d6ef37.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillin%2Fkoa-api-logger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwillin%2Fkoa-api-logger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillin%2Fkoa-api-logger/lists"}