@forge/metrics 0.1.0-next.0

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+# @forge/metrics
+
+## 0.1.0-next.0
+### Minor Changes
+
+- fbce4437: Add experimental metrics API (use it at your own risk)

package/README.md

@@ -0,0 +1,23 @@
+# Forge internal metrics
+
+Internal metrics methods. Use it at your own risk.
+
+## Requirements
+
+See [Set up Forge](https://developer.atlassian.com/platform/forge/set-up-forge/) for details of the software required to develop Forge apps.
+
+## Usage
+
+In your Forge app, include the following:
+
+```
+
+import { internalMetrics } from '@forge/metrics';
+
+```
+
+See [Runtime API reference](https://developer.atlassian.com/platform/forge/runtime-api-reference/) for details of the methods available and how to use them.
+
+## Support
+
+See [Get help](https://developer.atlassian.com/platform/forge/get-help/) for how to get help and provide feedback.

package/out/index.d.ts

@@ -0,0 +1,2 @@
+export { internalMetrics, Counter, Gauge, Timer, Metrics } from './internal';
+//# sourceMappingURL=index.d.ts.map

package/out/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC"}

package/out/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.internalMetrics = void 0;
+var internal_1 = require("./internal");
+Object.defineProperty(exports, "internalMetrics", { enumerable: true, get: function () { return internal_1.internalMetrics; } });

package/out/internal/data-types.d.ts

@@ -0,0 +1,56 @@
+export interface RuntimeMetrics {
+    invokeCounter(method: 'incr' | 'decr', counterName: string, value: number): void;
+    invokeGauge(gaugeName: string, value: number): void;
+    invokeTimer(method: 'start', timerId: null, timerName: string): string;
+    invokeTimer(method: 'stop', timerId: string, timerName: string): void;
+}
+export interface Counter {
+    incr(): void;
+    incrBy(value: number): void;
+    decr(): void;
+    decrBy(value: number): void;
+}
+export interface Gauge {
+    set(value: number): void;
+}
+export interface TimerStop {
+    stop(): void;
+}
+export interface Timer {
+    measure(): TimerStop;
+}
+export declare class TimerNotInitialisedError extends Error {
+    constructor();
+}
+export declare class TimerDeadError extends Error {
+    constructor();
+}
+export declare class ExperimentalCounter implements Counter {
+    private name;
+    private readonly runtimeMetrics;
+    constructor(name: string);
+    incrBy(value: number): void;
+    incr(): void;
+    decrBy(value: number): void;
+    decr(): void;
+}
+export declare class ExperimentalGauge implements Gauge {
+    private name;
+    private readonly runtimeMetrics;
+    constructor(name: string);
+    set(value: number): void;
+}
+export declare class ExperimentalTimerStop implements TimerStop {
+    private timerName;
+    private readonly runtimeMetrics;
+    private timerId;
+    private isAlive;
+    constructor(timerName: string);
+    stop(): void;
+}
+export declare class ExperimentalTimer implements Timer {
+    private name;
+    constructor(name: string);
+    measure(): ExperimentalTimerStop;
+}
+//# sourceMappingURL=data-types.d.ts.map

package/out/internal/data-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-types.d.ts","sourceRoot":"","sources":["../../src/internal/data-types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACjF,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpD,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IACvE,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CACvE;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,IAAI,IAAI,CAAC;IACb,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,IAAI,IAAI,CAAC;IACb,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,KAAK;IACpB,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,IAAI,IAAI,CAAC;CACd;AAED,MAAM,WAAW,KAAK;IACpB,OAAO,IAAI,SAAS,CAAC;CACtB;AAMD,qBAAa,wBAAyB,SAAQ,KAAK;;CAIlD;AAED,qBAAa,cAAe,SAAQ,KAAK;;CAIxC;AAED,qBAAa,mBAAoB,YAAW,OAAO;IAGrC,OAAO,CAAC,IAAI;IAFxB,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAuB;gBAElC,IAAI,EAAE,MAAM;IAEhC,MAAM,CAAC,KAAK,EAAE,MAAM;IAIpB,IAAI;IAIJ,MAAM,CAAC,KAAK,EAAE,MAAM;IAIpB,IAAI;CAGL;AAED,qBAAa,iBAAkB,YAAW,KAAK;IAGjC,OAAO,CAAC,IAAI;IAFxB,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAuB;gBAElC,IAAI,EAAE,MAAM;IAEhC,GAAG,CAAC,KAAK,EAAE,MAAM;CAGlB;AAED,qBAAa,qBAAsB,YAAW,SAAS;IAKzC,OAAO,CAAC,SAAS;IAJ7B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAuB;IACtD,OAAO,CAAC,OAAO,CAAuB;IACtC,OAAO,CAAC,OAAO,CAAS;gBAEJ,SAAS,EAAE,MAAM;IAKrC,IAAI;CAYL;AAED,qBAAa,iBAAkB,YAAW,KAAK;IACjC,OAAO,CAAC,IAAI;gBAAJ,IAAI,EAAE,MAAM;IAEhC,OAAO;CAGR"}

package/out/internal/data-types.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExperimentalTimer = exports.ExperimentalTimerStop = exports.ExperimentalGauge = exports.ExperimentalCounter = exports.TimerDeadError = exports.TimerNotInitialisedError = void 0;
+const getRuntimeMetrics = () => {
+    return global.api.internalMetrics;
+};
+class TimerNotInitialisedError extends Error {
+    constructor() {
+        super('Timer is not initialised');
+    }
+}
+exports.TimerNotInitialisedError = TimerNotInitialisedError;
+class TimerDeadError extends Error {
+    constructor() {
+        super('Timer has not been started yet or has been stopped already');
+    }
+}
+exports.TimerDeadError = TimerDeadError;
+class ExperimentalCounter {
+    constructor(name) {
+        this.name = name;
+        this.runtimeMetrics = getRuntimeMetrics();
+    }
+    incrBy(value) {
+        this.runtimeMetrics.invokeCounter('incr', this.name, value);
+    }
+    incr() {
+        this.incrBy(1);
+    }
+    decrBy(value) {
+        global.api.internalMetrics.invokeCounter('decr', this.name, value);
+    }
+    decr() {
+        this.decrBy(1);
+    }
+}
+exports.ExperimentalCounter = ExperimentalCounter;
+class ExperimentalGauge {
+    constructor(name) {
+        this.name = name;
+        this.runtimeMetrics = getRuntimeMetrics();
+    }
+    set(value) {
+        this.runtimeMetrics.invokeGauge(this.name, value);
+    }
+}
+exports.ExperimentalGauge = ExperimentalGauge;
+class ExperimentalTimerStop {
+    constructor(timerName) {
+        this.timerName = timerName;
+        this.runtimeMetrics = getRuntimeMetrics();
+        this.timerId = null;
+        this.isAlive = false;
+        this.timerId = this.runtimeMetrics.invokeTimer('start', null, this.timerName);
+        this.isAlive = true;
+    }
+    stop() {
+        if (!this.timerId) {
+            throw new TimerNotInitialisedError();
+        }
+        if (!this.isAlive) {
+            throw new TimerDeadError();
+        }
+        this.runtimeMetrics.invokeTimer('stop', this.timerId, this.timerName);
+        this.isAlive = false;
+    }
+}
+exports.ExperimentalTimerStop = ExperimentalTimerStop;
+class ExperimentalTimer {
+    constructor(name) {
+        this.name = name;
+    }
+    measure() {
+        return new ExperimentalTimerStop(this.name);
+    }
+}
+exports.ExperimentalTimer = ExperimentalTimer;

package/out/internal/index.d.ts

@@ -0,0 +1,14 @@
+import { Counter, ExperimentalCounter, ExperimentalGauge, ExperimentalTimer, Gauge, Timer } from './data-types';
+export interface Metrics {
+    counter(name: string): Counter;
+    gauge(name: string): Gauge;
+    timer(name: string): Timer;
+}
+declare class ExperimentalMetrics implements Metrics {
+    counter(name: string): ExperimentalCounter;
+    gauge(name: string): ExperimentalGauge;
+    timer(name: string): ExperimentalTimer;
+}
+export declare const internalMetrics: ExperimentalMetrics;
+export { Counter, Gauge, Timer };
+//# sourceMappingURL=index.d.ts.map

package/out/internal/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/internal/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAEhH,MAAM,WAAW,OAAO;IACtB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC;IAC3B,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC;CAC5B;AAED,cAAM,mBAAoB,YAAW,OAAO;IAC1C,OAAO,CAAC,IAAI,EAAE,MAAM;IAIpB,KAAK,CAAC,IAAI,EAAE,MAAM;IAIlB,KAAK,CAAC,IAAI,EAAE,MAAM;CAGnB;AAED,eAAO,MAAM,eAAe,qBAA4B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC"}

package/out/internal/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.internalMetrics = void 0;
+const data_types_1 = require("./data-types");
+class ExperimentalMetrics {
+    counter(name) {
+        return new data_types_1.ExperimentalCounter(name);
+    }
+    gauge(name) {
+        return new data_types_1.ExperimentalGauge(name);
+    }
+    timer(name) {
+        return new data_types_1.ExperimentalTimer(name);
+    }
+}
+exports.internalMetrics = new ExperimentalMetrics();

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@forge/metrics",
+  "version": "0.1.0-next.0",
+  "description": "Forge internal metrics",
+  "author": "Atlassian",
+  "license": "UNLICENSED",
+  "main": "out/index.js",
+  "types": "out/index.d.ts",
+  "scripts": {
+    "build": "yarn run clean && yarn run compile",
+    "clean": "rm -rf ./out && rm -f tsconfig.tsbuildinfo",
+    "compile": "tsc -b -v"
+  }
+}