@midwayjs/prometheus 3.6.0 → 3.7.0

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/service/dataService.d.ts

@@ -10,6 +10,7 @@ export declare class DataService {
     getUser(method: any, status: any, path: any, time: any): Promise<void>;
     define(name: any, type: any, options: any): void;
     inc(name: any, labels: any, value?: number): Promise<void>;
+    observe(name: any, labels: any, value: any): Promise<void>;
     set(name: any, value: any): Promise<void>;
     setDiff(name: any, diff: any): Promise<void>;
     getData(): Promise<string>;

package/dist/service/dataService.js

@@ -63,6 +63,11 @@ let DataService = class DataService {
     async inc(name, labels, value = 1) {
         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);
+    }
     async set(name, value) {
         this.userDefinedMetrics[name].set({ ...this.prometheusConfig.labels }, value);
     }
@@ -95,6 +100,12 @@ __decorate([
     __metadata("design:paramtypes", [Object, Object, Object]),
     __metadata("design:returntype", Promise)
 ], DataService.prototype, "inc", null);
+__decorate([
+    (0, master_1.Master)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, Object, Object]),
+    __metadata("design:returntype", Promise)
+], DataService.prototype, "observe", null);
 __decorate([
     (0, master_1.Master)(),
     __metadata("design:type", Function),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/prometheus",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "description": "midway component for prometheus",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -23,9 +23,9 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/core": "^3.6.0",
-    "@midwayjs/koa": "^3.6.0",
-    "@midwayjs/mock": "^3.6.0",
+    "@midwayjs/core": "^3.7.0",
+    "@midwayjs/koa": "^3.7.0",
+    "@midwayjs/mock": "^3.7.0",
     "@types/request": "2.48.8"
   },
   "dependencies": {
@@ -35,5 +35,5 @@
   "engines": {
     "node": ">=12"
   },
-  "gitHead": "22643b0e8519766bb7c68b975930199fc136336e"
+  "gitHead": "99386083ee26b386fd508b9c892091c914e77535"
 }