@midwayjs/prometheus 3.6.1-beta.0 → 3.7.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013 - Now midwayjs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,80 @@
+### 自定义方法
+
+定义 Histogram 方法：
+```
+@Configuration({
+  imports: [
+    koa,
+    validate,
+    prometheus,
+    {
+      component: info,
+      enabledEnvironment: ['local'],
+    },
+  ],
+  importConfigs: [join(__dirname, './config')],
+})
+export class ContainerLifeCycle {
+  @App()
+  app: koa.Application;
+
+  async onReady() {
+    const result = await this.app.getApplicationContext().getAsync(DataService);
+    // 此处定义了一个名字叫 test_histogram 的 Histogram
+    result.define('test_histogram', 'Histogram', {
+      help: '132',
+      name: 'test_histogram',
+      buckets: [5, 10, 25, 50, 100, 250, 500, 1000, 2500, 5000, 10000],
+    });
+  }
+}
+```
+
+为了测试这个Histogram，我们在一个接口里面：
+```
+import { Inject, Controller, Get, Query } from '@midwayjs/decorator';
+import { Context } from '@midwayjs/koa';
+import { DataService } from '@midwayjs/prometheus';
+import { UserService } from '../service/user.service';
+
+@Controller('/api')
+export class APIController {
+  @Inject()
+  ctx: Context;
+
+  @Inject()
+  userService: UserService;
+
+  @Inject()
+  dataService: DataService;
+
+  @Get('/get_user')
+  async getUser(@Query('uid') uid) {
+    this.dataService.observe('test_histogram', [], 100); //此处我们observe了这个histogram
+    const user = await this.userService.getUser({ uid });
+    return { success: true, message: 'OK', data: user };
+  }
+}
+```
+
+然后访问这个接口，然后我们查看我们 /metrics 的接口返回:
+```
+# HELP test_histogram 132
+# TYPE test_histogram histogram
+test_histogram_bucket{le="5",APP_NAME="default"} 0
+test_histogram_bucket{le="10",APP_NAME="default"} 0
+test_histogram_bucket{le="25",APP_NAME="default"} 0
+test_histogram_bucket{le="50",APP_NAME="default"} 0
+test_histogram_bucket{le="100",APP_NAME="default"} 1
+test_histogram_bucket{le="250",APP_NAME="default"} 1
+test_histogram_bucket{le="500",APP_NAME="default"} 1
+test_histogram_bucket{le="1000",APP_NAME="default"} 1
+test_histogram_bucket{le="2500",APP_NAME="default"} 1
+test_histogram_bucket{le="5000",APP_NAME="default"} 1
+test_histogram_bucket{le="10000",APP_NAME="default"} 1
+test_histogram_bucket{le="+Inf",APP_NAME="default"} 1
+test_histogram_sum{APP_NAME="default"} 100
+test_histogram_count{APP_NAME="default"} 1
+```
+
+至此，已经我们想要的自定义 Histogram 了。

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/service/dataService.js

@@ -64,7 +64,9 @@ let DataService = class DataService {
         this.userDefinedMetrics[name].inc({ ...labels, ...this.prometheusConfig.labels }, value);
     }
     async observe(name, labels, value) {
-        this.userDefinedMetrics[name].labels(...labels, ...Object.values(this.prometheusConfig.labels)).observe(value);
+        this.userDefinedMetrics[name]
+            .labels(...labels, ...Object.values(this.prometheusConfig.labels))
+            .observe(value);
     }
     async set(name, value) {
         this.userDefinedMetrics[name].set({ ...this.prometheusConfig.labels }, value);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/prometheus",
-  "version": "3.6.1-beta.0",
+  "version": "3.7.0",
   "description": "midway component for prometheus",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -23,11 +23,10 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/core": "^3.6.0",
-    "@midwayjs/koa": "^3.6.0",
-    "@midwayjs/mock": "^3.6.0",
-    "@types/request": "2.48.8",
-    "typescript": "4.5.4"
+    "@midwayjs/core": "^3.7.0",
+    "@midwayjs/koa": "^3.7.0",
+    "@midwayjs/mock": "^3.7.0",
+    "@types/request": "2.48.8"
   },
   "dependencies": {
     "prom-client": "^14.0.0",
@@ -35,5 +34,6 @@
   },
   "engines": {
     "node": ">=12"
-  }
+  },
+  "gitHead": "99386083ee26b386fd508b9c892091c914e77535"
 }