{"id":20791561,"url":"https://github.com/nftgo/egg-exporter","last_synced_at":"2026-07-16T05:32:59.501Z","repository":{"id":75281043,"uuid":"482701078","full_name":"NFTGo/egg-exporter","owner":"NFTGo","description":null,"archived":false,"fork":false,"pushed_at":"2022-04-18T03:57:43.000Z","size":595,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-20T09:27:46.862Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/NFTGo.png","metadata":{"files":{"readme":"README-CN.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-18T03:24:32.000Z","updated_at":"2022-04-18T03:35:03.000Z","dependencies_parsed_at":"2023-07-17T21:15:21.504Z","dependency_job_id":null,"html_url":"https://github.com/NFTGo/egg-exporter","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/NFTGo/egg-exporter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NFTGo%2Fegg-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NFTGo%2Fegg-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NFTGo%2Fegg-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NFTGo%2Fegg-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NFTGo","download_url":"https://codeload.github.com/NFTGo/egg-exporter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NFTGo%2Fegg-exporter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35532635,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-16T02:00:06.687Z","response_time":83,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-17T15:45:33.414Z","updated_at":"2026-07-16T05:32:59.484Z","avatar_url":"https://github.com/NFTGo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# egg-exporter\n\nLanguages: [[English](./README.md)] [简体中文]\n\n[![NPM version][npm-image]][npm-url]\n[![npm download][download-image]][download-url]\n\n[npm-image]: https://img.shields.io/npm/v/egg-exporter.svg?style=flat-square\n[npm-url]: https://npmjs.org/package/egg-exporter\n[download-image]: https://img.shields.io/npm/dm/egg-exporter.svg?style=flat-square\n[download-url]: https://npmjs.org/package/egg-exporter\n\n\u003c!--\n[![build status][travis-image]][travis-url]\n[![Test coverage][codecov-image]][codecov-url]\n[![David deps][david-image]][david-url]\n[![Known Vulnerabilities][snyk-image]][snyk-url]\n\n[travis-image]: https://img.shields.io/travis/eggjs/egg-prometheus.svg?style=flat-square\n[travis-url]: https://travis-ci.org/eggjs/egg-prometheus\n[codecov-image]: https://codecov.io/gh/eggjs/egg-prometheus/branch/master/graph/badge.svg\n[codecov-url]: https://codecov.io/gh/eggjs/egg-prometheus\n[david-image]: https://img.shields.io/david/eggjs/egg-prometheus.svg?style=flat-square\n[david-url]: https://david-dm.org/eggjs/egg-prometheus\n[snyk-image]: https://snyk.io/test/npm/egg-prometheus/badge.svg?style=flat-square\n[snyk-url]: https://snyk.io/test/npm/egg-prometheus\n--\u003e\n\n基于 [egg-prometheus](https://github.com/eggjs/egg-prometheus) 开发，增加更多性能指标，为 egg 提供 [Prometheus](https://prometheus.io) 功能支持。了解更多请看 [Node.js 监控方案](https://hahhub.com/post/2020-05-eggjs-prometheus-monitor/)。\n\n\n## 展示\n\n![./screenshots/egg-metrics-v1.png](./screenshots/egg-metrics-v1.png)\n\n## 安装\n\n```bash\n$ npm i egg-exporter --save\n```\n\n## 用法\n\n### 开启插件\n\n通过 `${app_root}/config/plugin.js` 配置启动 Prometheus 插件:\n\n```js\nexports.exporter = {\n  enable: true,\n  package: 'egg-exporter',\n};\n```\n\n### 配置\n\n```js\nexports.exporter = {\n  scrapePort: 3000,\n  scrapePath: '/metrics',\n  prefix: 'egg_',\n  defaultLabels: { stage: 'dev' },\n};\n```\n\n- `scrapePort`: 监听的用于采集 metrics 的端口\n- `scrapePath`: 监听的采集 metrics 的服务路径\n- `prefix`: 指定 metrics 名称的前缀\n- `defaultLabels`: 默认的 metrics 标签，全局生效\n- `aggregatorPort`: 配置 TCP 进程通信所使用的端口\n\n## 内置的 Metrics\n\n- `http_request_duration_milliseconds histogram`: http 请求耗时\n- `http_request_size_bytes summary`: http 请求 body 大小\n- `http_response_size_bytes summary`: http 响应 body 大小\n- `http_request_total counter`: http 请求数\n- `http_all_errors_total counter`: http 错误数\n- `http_all_request_in_processing_total gauge`: http 处理中请求数\n- `process_resident_memory_bytes gauge`: 驻留内存大小\n- `nodejs_heap_size_total_bytes gauge`: 已申请堆内存大小\n- `nodejs_heap_size_used_bytes gauge`: 已使用堆内存大小\n- `nodejs_external_memory_bytes gauge`: V8 管理的，绑定到 Javascript 的 C++ 对象的内存使用情况\n- `nodejs_version_info`: 版本信息\n\n当 egg-rpc-base 插件开启时，还会提供下面 metrics\n- `rpc_consumer_response_time_ms summary`: rpc 客户端请求耗时\n- `rpc_consumer_request_rate counter`: rpc 客户端请求数\n- `rpc_consumer_fail_response_time_ms summary`: rpc 客户端失败的请求耗时\n- `rpc_consumer_request_fail_rate counter`: rpc 客户端失败的请求数\n- `rpc_consumer_request_size_bytes summary`: rpc 请求大小统计\n- `rpc_consumer_response_size_bytes summary`: rpc 响应大小统计\n- `rpc_provider_response_time_ms summary`: rpc 服务端处理时间\n- `rpc_provider_request_rate counter`: rpc 服务端收到请求数\n- `rpc_provider_fail_response_time_ms summary`: rpc 服务端失败的请求处理时间\n- `rpc_provider_request_fail_rate counter`: rpc 服务端失败的请求数\n\n## 自定义 Metrics\n\n可以通过下面 API 自定义业务 metrics\n```js\nconst counter = new app.prometheus.Counter({\n  name: 'xxx_total',\n  help: 'custom counter',\n  labelNames: [ 'xxx' ],\n});\n\nconst gauge = new app.prometheus.Gauge({\n  name: 'xxx_gauge',\n  help: 'custom gauge',\n  labelNames: [ 'xxx' ],\n});\n\nconst histogram = new app.prometheus.Histogram({\n  name: 'xxx_histogram',\n  help: 'custom histogram',\n  labelNames: [ 'xxx' ],\n});\n\nconst summary = new app.prometheus.Summary({\n  name: 'xxx_summary',\n  help: 'custom summary',\n  labelNames: [ 'xxx' ],\n});\n```\n\n## 如何贡献\n\n请告知我们可以为你做些什么，不过在此之前，请检查一下是否有[已经存在的Bug或者意见](https://github.com/NFTGo/egg-exporter/issues)。\n\n## License\n\n[MIT](LICENSE)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnftgo%2Fegg-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnftgo%2Fegg-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnftgo%2Fegg-exporter/lists"}