@eggjs/tracer 4.0.0-beta.29 → 4.0.0-beta.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +21 -15
  2. package/dist/index.d.ts +14 -4
  3. package/dist/index.js +18 -5
  4. package/package.json +7 -10
package/README.md CHANGED
@@ -27,36 +27,42 @@ npm i @eggjs/tracer
27
27
  Enable tracer plugin:
28
28
 
29
29
  ```js
30
- // config/plugin.js
31
- exports.tracer = {
32
- enable: true,
33
- package: '@eggjs/tracer',
30
+ // config/plugin.ts
31
+ import tracerPlugin from '@eggjs/tracer';
32
+
33
+ export default {
34
+ ...tracerPlugin(),
34
35
  };
35
36
  ```
36
37
 
37
- ### Build my own tracer
38
+ ### Build my own Tracer Class
38
39
 
39
- ```js
40
- // my_tracer.js
41
- const { Tracer } = require('@eggjs/tracer');
40
+ ```ts
41
+ // ./path/to/my_tracer.ts
42
+ import { Tracer } from '@eggjs/tracer';
42
43
 
43
44
  const counter = 0;
44
45
 
45
- class MyTracer extends Tracer {
46
+ export class MyTracer extends Tracer {
46
47
  get traceId() {
47
48
  return `${counter++}-${Date.now()}-${process.pid}`;
48
49
  }
49
50
  }
50
- module.exports = MyTracer;
51
51
  ```
52
52
 
53
53
  Change the config to use `MyTracer`:
54
54
 
55
- ```js
56
- // config/config.default.js
57
- exports.tracer = {
58
- Class: require('path/to/my_tracer.js'),
59
- };
55
+ ```ts
56
+ // config/config.default.ts
57
+ import { defineConfig } from 'egg';
58
+
59
+ import { MyTracer } from './path/to/my_tracer.ts';
60
+
61
+ export default defineConfig({
62
+ tracer: {
63
+ Class: MyTracer,
64
+ },
65
+ });
60
66
  ```
61
67
 
62
68
  ## Questions & Suggestions
package/dist/index.d.ts CHANGED
@@ -1,7 +1,17 @@
1
- import './config/config.default.ts';
2
- import './app/extend/application.ts';
3
- import './app/extend/agent.ts';
4
- import './app/extend/context.ts';
1
+ import { type EggPluginFactory } from 'egg';
5
2
  import './types.ts';
6
3
  import { Tracer } from './lib/tracer.ts';
7
4
  export { Tracer };
5
+ /**
6
+ * Usage:
7
+ * ```ts
8
+ * // config/plugin.ts
9
+ * import tracerPlugin from '@eggjs/tracer';
10
+ *
11
+ * export default {
12
+ * ...tracerPlugin(),
13
+ * };
14
+ * ```
15
+ */
16
+ declare const _default: EggPluginFactory;
17
+ export default _default;
package/dist/index.js CHANGED
@@ -1,8 +1,21 @@
1
- import "./config/config.default.js";
2
- import "./app/extend/application.js";
3
- import "./app/extend/agent.js";
4
- import "./app/extend/context.js";
1
+ import { definePluginFactory } from 'egg';
5
2
  import "./types.js";
6
3
  import { Tracer } from "./lib/tracer.js";
7
4
  export { Tracer };
8
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyw0QkFBNEIsQ0FBQztBQUNwQyxPQUFPLDZCQUE2QixDQUFDO0FBQ3JDLE9BQU8sdUJBQXVCLENBQUM7QUFDL0IsT0FBTyx5QkFBeUIsQ0FBQztBQUNqQyxPQUFPLFlBQVksQ0FBQztBQUVwQixPQUFPLEVBQUUsTUFBTSxFQUFFLE1BQU0saUJBQWlCLENBQUM7QUFFekMsT0FBTyxFQUFFLE1BQU0sRUFBRSxDQUFDIn0=
5
+ /**
6
+ * Usage:
7
+ * ```ts
8
+ * // config/plugin.ts
9
+ * import tracerPlugin from '@eggjs/tracer';
10
+ *
11
+ * export default {
12
+ * ...tracerPlugin(),
13
+ * };
14
+ * ```
15
+ */
16
+ export default definePluginFactory({
17
+ name: 'tracer',
18
+ enable: true,
19
+ path: import.meta.dirname,
20
+ });
21
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLG1CQUFtQixFQUF5QixNQUFNLEtBQUssQ0FBQztBQUVqRSxPQUFPLFlBQVksQ0FBQztBQUVwQixPQUFPLEVBQUUsTUFBTSxFQUFFLE1BQU0saUJBQWlCLENBQUM7QUFFekMsT0FBTyxFQUFFLE1BQU0sRUFBRSxDQUFDO0FBRWxCOzs7Ozs7Ozs7O0dBVUc7QUFDSCxlQUFlLG1CQUFtQixDQUFDO0lBQ2pDLElBQUksRUFBRSxRQUFRO0lBQ2QsTUFBTSxFQUFFLElBQUk7SUFDWixJQUFJLEVBQUUsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPO0NBQzFCLENBQXFCLENBQUMifQ==
package/package.json CHANGED
@@ -1,13 +1,10 @@
1
1
  {
2
2
  "name": "@eggjs/tracer",
3
- "version": "4.0.0-beta.29",
3
+ "version": "4.0.0-beta.31",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
7
7
  "description": "tracer for egg",
8
- "eggPlugin": {
9
- "name": "tracer"
10
- },
11
8
  "keywords": [
12
9
  "egg",
13
10
  "egg-plugin",
@@ -32,15 +29,15 @@
32
29
  "node": ">=22.18.0"
33
30
  },
34
31
  "peerDependencies": {
35
- "egg": "4.1.0-beta.29"
32
+ "egg": "4.1.0-beta.31"
36
33
  },
37
34
  "devDependencies": {
38
- "tsdown": "0.15.6",
35
+ "tsdown": "0.15.10",
39
36
  "typescript": "^5.9.3",
40
- "vitest": "4.0.0-beta.18",
41
- "@eggjs/tsconfig": "3.1.0-beta.29",
42
- "egg": "4.1.0-beta.29",
43
- "@eggjs/mock": "7.0.0-beta.29"
37
+ "vitest": "4.0.4",
38
+ "@eggjs/tsconfig": "3.1.0-beta.31",
39
+ "egg": "4.1.0-beta.31",
40
+ "@eggjs/mock": "7.0.0-beta.31"
44
41
  },
45
42
  "type": "module",
46
43
  "exports": {