@mts-pjsc/bretrics 1.0.0 → 1.0.1
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.
- package/README.md +10 -10
- package/dist/index.d.ts +2 -3
- package/dist/index.js +4 -4
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
[](CODE_OF_CONDUCT.md)
|
|
4
4
|
[](https://github.com/LabEG/reca/blob/main/LICENSE)
|
|
5
5
|
|
|
6
|
-
#
|
|
6
|
+
# Bretrics - Realtime user Browser Monitoring
|
|
7
7
|
|
|
8
8
|
Monitor the performance of the user's browser and code for real users. Allows you to collect WebVitals metrics, performance and business metrics through the Prometheuse monitoring system.
|
|
9
9
|
|
|
@@ -36,10 +36,10 @@ yarn add @mts-pjsc/bretrics
|
|
|
36
36
|
The package has a pre-configured monitoring mode that includes the necessary webvitals metrics.
|
|
37
37
|
|
|
38
38
|
``` typescript
|
|
39
|
-
import {
|
|
39
|
+
import {bretrics} from "@mts-pjsc/bretrics";
|
|
40
40
|
|
|
41
|
-
|
|
42
|
-
.setup({apiPath: "/
|
|
41
|
+
bretrics
|
|
42
|
+
.setup({apiPath: "/bretrics"}) // <-- microservice deploy location
|
|
43
43
|
.useDefaultMonitoring()
|
|
44
44
|
.sendMetrics({my_metric: 5}); // <-- custom metrics
|
|
45
45
|
```
|
|
@@ -51,10 +51,10 @@ If you need to send custom metric, you must use the `sendMetrics` method.
|
|
|
51
51
|
Prometheus labels can be set as default for all metrics, or individually for each value.
|
|
52
52
|
|
|
53
53
|
``` typescript
|
|
54
|
-
import {
|
|
54
|
+
import {bretrics} from "@mts-pjsc/bretrics";
|
|
55
55
|
|
|
56
|
-
|
|
57
|
-
.setup({apiPath: "/
|
|
56
|
+
bretrics
|
|
57
|
+
.setup({apiPath: "/bretrics"})
|
|
58
58
|
.useDefaultMonitoring()
|
|
59
59
|
.setLabels({stage: "beta", path: location.pathname})
|
|
60
60
|
.sendMetrics({
|
|
@@ -67,14 +67,14 @@ webmon
|
|
|
67
67
|
|
|
68
68
|
The default labels will be added to the metrics if you didn't pass them in the `sendMetrics` method.
|
|
69
69
|
|
|
70
|
-
### Example
|
|
70
|
+
### Example Bretrics customization
|
|
71
71
|
|
|
72
72
|
The library exports the web monitoring constructor class, so you can inherit from it and implement logic according to OOP principles.
|
|
73
73
|
|
|
74
74
|
``` typescript
|
|
75
|
-
import {
|
|
75
|
+
import {Bretrics} from "@mts-pjsc/bretrics";
|
|
76
76
|
|
|
77
|
-
export class
|
|
77
|
+
export class BretricsService extends Bretrics {
|
|
78
78
|
|
|
79
79
|
public override sendMetrics (metric: Record<string, number>): this {
|
|
80
80
|
super.sendMetrics(metric);
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { Metric } from "web-vitals";
|
|
2
2
|
import type { IMetric } from "./interfaces/IMetric";
|
|
3
|
-
export declare class
|
|
3
|
+
export declare class Bretrics {
|
|
4
4
|
apiPath: string;
|
|
5
5
|
labels: Record<string, number | string>;
|
|
6
6
|
sendWebVitalsMetrics(): this;
|
|
@@ -14,5 +14,4 @@ export declare class WebMonitoring {
|
|
|
14
14
|
protected prepareData(metrics: Record<string, IMetric | number>): Record<string, IMetric | number>;
|
|
15
15
|
protected getDeviceType(): string;
|
|
16
16
|
}
|
|
17
|
-
export declare const
|
|
18
|
-
export declare const webmon: WebMonitoring;
|
|
17
|
+
export declare const bretrics: Bretrics;
|
package/dist/index.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { onLCP, onFID, onCLS, onFCP, onINP, onTTFB } from "web-vitals";
|
|
2
|
-
export class
|
|
2
|
+
export class Bretrics {
|
|
3
3
|
constructor() {
|
|
4
|
-
this.apiPath = "/
|
|
4
|
+
this.apiPath = "/bretrics";
|
|
5
5
|
this.labels = {};
|
|
6
6
|
}
|
|
7
7
|
sendWebVitalsMetrics() {
|
|
@@ -98,6 +98,7 @@ export class WebMonitoring {
|
|
|
98
98
|
}
|
|
99
99
|
return sendMetrics;
|
|
100
100
|
}
|
|
101
|
+
// eslint-disable-next-line @typescript-eslint/class-methods-use-this
|
|
101
102
|
getDeviceType() {
|
|
102
103
|
const ua = navigator.userAgent;
|
|
103
104
|
if ((/(tablet|ipad|playbook|silk)|(android(?!.*mobi))/iu).test(ua)) {
|
|
@@ -109,6 +110,5 @@ export class WebMonitoring {
|
|
|
109
110
|
return "desktop";
|
|
110
111
|
}
|
|
111
112
|
}
|
|
112
|
-
export const
|
|
113
|
-
export const webmon = webmonitoring;
|
|
113
|
+
export const bretrics = new Bretrics();
|
|
114
114
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAC,MAAM,YAAY,CAAC;AAGrE,MAAM,OAAO,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAC,MAAM,YAAY,CAAC;AAGrE,MAAM,OAAO,QAAQ;IAArB;QAEW,YAAO,GAAW,WAAW,CAAC;QAE9B,WAAM,GAAoC,EAAE,CAAC;IAgIxD,CAAC;IA9HU,oBAAoB;QACvB,KAAK,CAAC,CAAC,MAAc,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;QACtD,KAAK,CAAC,CAAC,MAAc,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;QACtD,KAAK,CAAC,CAAC,MAAc,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;QACtD,KAAK,CAAC,CAAC,MAAc,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;QACtD,KAAK,CAAC,CAAC,MAAc,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;QACtD,MAAM,CAAC,CAAC,MAAc,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;QAEvD,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,KAAK,CAAE,MAAqB;QAC/B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;QAE9C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,WAAW,CAAE,MAA8B;QAC9C,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEhC,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,oBAAoB;QACvB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAE5B,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;YACxB,IAAI,CAAC,WAAW,CAAC;gBACb,qCAAqC;gBACrC,cAAc,EAAE,QAAQ,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,MAAM;aAC5D,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,gBAAgB;QACnB,MAAM,aAAa,GAAG;YAClB,qCAAqC;YACrC,WAAW,EAAE,IAAI,CAAC,aAAa,EAAE;YACjC,IAAI,EAAE,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,4CAA4C;SAC3F,CAAC;QACF,IAAI,CAAC,MAAM,GAAG;YACV,GAAG,IAAI,CAAC,MAAM;YACd,GAAG,aAAa;SACnB,CAAC;QAEF,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,SAAS,CAAE,MAAuC;QACrD,IAAI,CAAC,MAAM,GAAG;YACV,GAAG,IAAI,CAAC,MAAM;YACd,GAAG,MAAM;SACZ,CAAC;QAEF,OAAO,IAAI,CAAC;IAChB,CAAC;IAES,aAAa,CAAE,eAAuB;QAC5C,MAAM,aAAa,GAAG,EAAE,CAAC;QACzB,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,eAAe,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QAEtF,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;IAED,0CAA0C;IAChC,kBAAkB,CAAE,OAAyC;QACnE,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,OAAO,uBAAuB,CAAC;QACpD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;QAEvD,IAAI,OAAO,SAAS,CAAC,UAAU,KAAK,UAAU,EAAE;YAC5C,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;SACpC;aAAM;YACH,KAAK,CAAC,IAAI,EAAE;gBACR,IAAI;gBACJ,MAAM,EAAE,MAAM;gBACd,SAAS,EAAE,IAAI;aAClB,CAAC,CAAC;SACN;IACL,CAAC;IAES,WAAW,CAAE,OAAyC;QAC5D,MAAM,WAAW,GAAG,EAAE,CAAC;QACvB,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC9C,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC;QAExD,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;YACpC,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,WAAW,CAAqB,CAAC;YAE1E,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,WAAW,KAAK,CAAC,EAAE;gBACtD,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;aACtD;iBAAM,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;gBACxC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE;oBAClC,KAAK,EAAE,WAAW;oBAClB,MAAM,EAAE,IAAI,CAAC,MAAM;iBACtB,CAAC,CAAC;aACN;iBAAM;gBACH,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE;oBAClC,KAAK,EAAE,WAAW,CAAC,KAAK;oBACxB,MAAM,EAAE;wBACJ,GAAG,IAAI,CAAC,MAAM;wBACd,GAAG,WAAW,CAAC,MAAM;qBACxB;iBACJ,CAAC,CAAC;aACN;SACJ;QAED,OAAO,WAAW,CAAC;IACvB,CAAC;IAED,qEAAqE;IAC3D,aAAa;QACnB,MAAM,EAAE,GAAG,SAAS,CAAC,SAAS,CAAC;QAC/B,IAAI,CAAC,mDAAmD,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE;YAChE,OAAO,QAAQ,CAAC;SACnB;QACD,IACI,CAAC,sGAAsG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EACnH;YACE,OAAO,QAAQ,CAAC;SACnB;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;CAEJ;AAED,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC"}
|