@theia/plugin-metrics 1.34.2 → 1.34.3

package/src/browser/plugin-metrics-output-registry.ts

@@ -1,37 +1,37 @@
-// *****************************************************************************
-// Copyright (C) 2019 Red Hat, Inc. and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { injectable, inject } from '@theia/core/shared/inversify';
-import { OutputChannelRegistryMainImpl } from '@theia/plugin-ext/lib/main/browser/output-channel-registry-main';
-import { PluginMetricsCreator } from './plugin-metrics-creator';
-import { createDefaultRequestData } from '../common/plugin-metrics-types';
-import { PluginInfo } from '@theia/plugin-ext/lib/common/plugin-api-rpc';
-
-@injectable()
-export class PluginMetricsOutputChannelRegistry extends OutputChannelRegistryMainImpl {
-
-    @inject(PluginMetricsCreator)
-    protected readonly pluginMetricsCreator: PluginMetricsCreator;
-
-    override $append(channelName: string, errorOrValue: string, pluginInfo: PluginInfo): PromiseLike<void> {
-        if (errorOrValue.startsWith('[Error')) {
-            const createdMetric = createDefaultRequestData(pluginInfo.id, errorOrValue);
-            this.pluginMetricsCreator.createErrorMetric(createdMetric);
-        }
-        return super.$append(channelName, errorOrValue, pluginInfo);
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2019 Red Hat, Inc. and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { injectable, inject } from '@theia/core/shared/inversify';
+import { OutputChannelRegistryMainImpl } from '@theia/plugin-ext/lib/main/browser/output-channel-registry-main';
+import { PluginMetricsCreator } from './plugin-metrics-creator';
+import { createDefaultRequestData } from '../common/plugin-metrics-types';
+import { PluginInfo } from '@theia/plugin-ext/lib/common/plugin-api-rpc';
+
+@injectable()
+export class PluginMetricsOutputChannelRegistry extends OutputChannelRegistryMainImpl {
+
+    @inject(PluginMetricsCreator)
+    protected readonly pluginMetricsCreator: PluginMetricsCreator;
+
+    override $append(channelName: string, errorOrValue: string, pluginInfo: PluginInfo): PromiseLike<void> {
+        if (errorOrValue.startsWith('[Error')) {
+            const createdMetric = createDefaultRequestData(pluginInfo.id, errorOrValue);
+            this.pluginMetricsCreator.createErrorMetric(createdMetric);
+        }
+        return super.$append(channelName, errorOrValue, pluginInfo);
+    }
+
+}

package/src/browser/plugin-metrics-resolver.ts

@@ -1,57 +1,57 @@
-// *****************************************************************************
-// Copyright (C) 2019 Red Hat, Inc. and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-// *****************************************************************************
-
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-import { injectable, inject } from '@theia/core/shared/inversify';
-import { PluginMetricsCreator } from './plugin-metrics-creator';
-import { createRequestData } from '../common/plugin-metrics-types';
-
-/**
- * This class helps resolve language server requests into successes or failures
- * and sends the data to the metricsExtractor
- */
-@injectable()
-export class PluginMetricsResolver {
-
-    @inject(PluginMetricsCreator)
-    private metricsCreator: PluginMetricsCreator;
-
-    /**
-     * Resolve a request for pluginID and create a metric based on whether or not
-     * the language server errored.
-     *
-     * @param pluginID the ID of the plugin that made the request
-     * @param method  the method that was request
-     * @param request the result of the language server request
-     */
-    async resolveRequest(pluginID: string, method: string, request: PromiseLike<any> | Promise<any> | Thenable<any> | any): Promise<any> {
-        const currentTime = performance.now();
-        try {
-            const value = await request;
-            this.createAndSetMetric(pluginID, method, performance.now() - currentTime, true);
-            return value;
-        } catch (error) {
-            this.createAndSetMetric(pluginID, method, performance.now() - currentTime, false);
-            return Promise.reject(error);
-        }
-    }
-
-    private createAndSetMetric(pluginID: string, method: string, time: number, successful: boolean): void {
-        const createdSuccessMetric = createRequestData(pluginID, method, time);
-        this.metricsCreator.createMetric(createdSuccessMetric, successful);
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2019 Red Hat, Inc. and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { injectable, inject } from '@theia/core/shared/inversify';
+import { PluginMetricsCreator } from './plugin-metrics-creator';
+import { createRequestData } from '../common/plugin-metrics-types';
+
+/**
+ * This class helps resolve language server requests into successes or failures
+ * and sends the data to the metricsExtractor
+ */
+@injectable()
+export class PluginMetricsResolver {
+
+    @inject(PluginMetricsCreator)
+    private metricsCreator: PluginMetricsCreator;
+
+    /**
+     * Resolve a request for pluginID and create a metric based on whether or not
+     * the language server errored.
+     *
+     * @param pluginID the ID of the plugin that made the request
+     * @param method  the method that was request
+     * @param request the result of the language server request
+     */
+    async resolveRequest(pluginID: string, method: string, request: PromiseLike<any> | Promise<any> | Thenable<any> | any): Promise<any> {
+        const currentTime = performance.now();
+        try {
+            const value = await request;
+            this.createAndSetMetric(pluginID, method, performance.now() - currentTime, true);
+            return value;
+        } catch (error) {
+            this.createAndSetMetric(pluginID, method, performance.now() - currentTime, false);
+            return Promise.reject(error);
+        }
+    }
+
+    private createAndSetMetric(pluginID: string, method: string, time: number, successful: boolean): void {
+        const createdSuccessMetric = createRequestData(pluginID, method, time);
+        this.metricsCreator.createMetric(createdSuccessMetric, successful);
+    }
+}

package/src/common/metrics-protocol.ts

@@ -1,27 +1,27 @@
-// *****************************************************************************
-// Copyright (C) 2019 Red Hat, Inc. and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-// *****************************************************************************
-
-/**
- * The JSON-RPC interface for plugin metrics
- */
-export const metricsJsonRpcPath = '/services/plugin-ext/metrics';
-export const PluginMetrics = Symbol('PluginMetrics');
-export interface PluginMetrics {
-    setMetrics(metrics: string): void;
-    getMetrics(): string;
-}
-
-export const METRICS_TIMEOUT = 10000;
+// *****************************************************************************
+// Copyright (C) 2019 Red Hat, Inc. and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+/**
+ * The JSON-RPC interface for plugin metrics
+ */
+export const metricsJsonRpcPath = '/services/plugin-ext/metrics';
+export const PluginMetrics = Symbol('PluginMetrics');
+export interface PluginMetrics {
+    setMetrics(metrics: string): void;
+    getMetrics(): string;
+}
+
+export const METRICS_TIMEOUT = 10000;

package/src/common/plugin-metrics-types.ts

@@ -1,80 +1,80 @@
-// *****************************************************************************
-// Copyright (C) 2019 Red Hat, Inc. and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-// *****************************************************************************
-
-// Define common interfaces that multiple classes can use
-
-export interface MetricsMap {
-    [extensionID: string]: MethodToAnalytics
-}
-
-export interface MethodToAnalytics {
-    [methodID: string]: AnalyticsFromRequests;
-}
-
-export interface AnalyticsFromRequests {
-    totalRequests: number;
-    successfulResponses: number;
-    sumOfTimeForSuccess: number;
-    sumOfTimeForFailure: number;
-}
-
-export interface DataFromRequest {
-    pluginID: string;
-    errorContentsOrMethod: string;
-    timeTaken: number;
-}
-
-export interface MetricOutput {
-    header: string;
-    createMetricOutput(pluginID: string, method: string, requestAnalytics: AnalyticsFromRequests): string;
-}
-
-/**
- * Helper functions for creating an object that corresponds to the DataFromRequest interface
- */
-export function createRequestData(pluginID: string, errorContentsOrMethod: string, timeTaken: number): DataFromRequest {
-    return {
-        pluginID,
-        errorContentsOrMethod,
-        timeTaken
-    };
-}
-
-export function createDefaultRequestData(pluginID: string, errorContentsOrMethod: string): DataFromRequest {
-    return {
-        pluginID,
-        errorContentsOrMethod,
-        timeTaken: 0
-    };
-}
-
-export function createDefaultAnalytics(timeTaken: number, isRequestSuccessful: boolean): AnalyticsFromRequests {
-    if (isRequestSuccessful) {
-        return {
-            sumOfTimeForSuccess: timeTaken,
-            sumOfTimeForFailure: 0,
-            successfulResponses: 0,
-            totalRequests: 0
-        };
-    } else {
-        return {
-            sumOfTimeForSuccess: 0,
-            sumOfTimeForFailure: timeTaken,
-            successfulResponses: 0,
-            totalRequests: 0
-        };
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2019 Red Hat, Inc. and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+// Define common interfaces that multiple classes can use
+
+export interface MetricsMap {
+    [extensionID: string]: MethodToAnalytics
+}
+
+export interface MethodToAnalytics {
+    [methodID: string]: AnalyticsFromRequests;
+}
+
+export interface AnalyticsFromRequests {
+    totalRequests: number;
+    successfulResponses: number;
+    sumOfTimeForSuccess: number;
+    sumOfTimeForFailure: number;
+}
+
+export interface DataFromRequest {
+    pluginID: string;
+    errorContentsOrMethod: string;
+    timeTaken: number;
+}
+
+export interface MetricOutput {
+    header: string;
+    createMetricOutput(pluginID: string, method: string, requestAnalytics: AnalyticsFromRequests): string;
+}
+
+/**
+ * Helper functions for creating an object that corresponds to the DataFromRequest interface
+ */
+export function createRequestData(pluginID: string, errorContentsOrMethod: string, timeTaken: number): DataFromRequest {
+    return {
+        pluginID,
+        errorContentsOrMethod,
+        timeTaken
+    };
+}
+
+export function createDefaultRequestData(pluginID: string, errorContentsOrMethod: string): DataFromRequest {
+    return {
+        pluginID,
+        errorContentsOrMethod,
+        timeTaken: 0
+    };
+}
+
+export function createDefaultAnalytics(timeTaken: number, isRequestSuccessful: boolean): AnalyticsFromRequests {
+    if (isRequestSuccessful) {
+        return {
+            sumOfTimeForSuccess: timeTaken,
+            sumOfTimeForFailure: 0,
+            successfulResponses: 0,
+            totalRequests: 0
+        };
+    } else {
+        return {
+            sumOfTimeForSuccess: 0,
+            sumOfTimeForFailure: timeTaken,
+            successfulResponses: 0,
+            totalRequests: 0
+        };
+    }
+}

package/src/node/metric-output/plugin-metrics-time-count.ts

@@ -1,36 +1,36 @@
-// *****************************************************************************
-// Copyright (C) 2019 Red Hat, Inc. and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { MetricOutput, AnalyticsFromRequests } from '../../common/plugin-metrics-types';
-import { injectable } from '@theia/core/shared/inversify';
-
-@injectable()
-export class PluginMetricTimeCount implements MetricOutput {
-
-    public header = '# HELP language_server_time_count Number of language server requests\n# TYPE language_server_time_count gauge\n';
-
-    createMetricOutput(id: string, method: string, requestAnalytics: AnalyticsFromRequests): string {
-        if (requestAnalytics.successfulResponses < 0) {
-            requestAnalytics.successfulResponses = 0;
-        }
-        const successMetric = `language_server_time_count{id="${id}" method="${method}" result="success"} ${requestAnalytics.successfulResponses}\n`;
-
-        const failedRequests = requestAnalytics.totalRequests - requestAnalytics.successfulResponses;
-        const failureMetric = `language_server_time_count{id="${id}" method="${method}" result="fail"} ${failedRequests}\n`;
-        return successMetric + failureMetric;
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2019 Red Hat, Inc. and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { MetricOutput, AnalyticsFromRequests } from '../../common/plugin-metrics-types';
+import { injectable } from '@theia/core/shared/inversify';
+
+@injectable()
+export class PluginMetricTimeCount implements MetricOutput {
+
+    public header = '# HELP language_server_time_count Number of language server requests\n# TYPE language_server_time_count gauge\n';
+
+    createMetricOutput(id: string, method: string, requestAnalytics: AnalyticsFromRequests): string {
+        if (requestAnalytics.successfulResponses < 0) {
+            requestAnalytics.successfulResponses = 0;
+        }
+        const successMetric = `language_server_time_count{id="${id}" method="${method}" result="success"} ${requestAnalytics.successfulResponses}\n`;
+
+        const failedRequests = requestAnalytics.totalRequests - requestAnalytics.successfulResponses;
+        const failureMetric = `language_server_time_count{id="${id}" method="${method}" result="fail"} ${failedRequests}\n`;
+        return successMetric + failureMetric;
+    }
+
+}

package/src/node/metric-output/plugin-metrics-time-sum.ts

@@ -1,35 +1,35 @@
-// *****************************************************************************
-// Copyright (C) 2019 Red Hat, Inc. and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { MetricOutput, AnalyticsFromRequests } from '../../common/plugin-metrics-types';
-import { injectable } from '@theia/core/shared/inversify';
-
-@injectable()
-export class PluginMetricTimeSum implements MetricOutput {
-
-    public header = '# HELP language_server_time_sum Sum of time in milliseconds that language server requests take\n# TYPE language_server_time_sum gauge\n';
-
-    createMetricOutput(id: string, method: string, requestAnalytics: AnalyticsFromRequests): string {
-        const successTime = requestAnalytics.sumOfTimeForSuccess;
-        const success = `language_server_time_sum{id="${id}" method="${method}" result="success"} ${successTime}\n`;
-
-        const failureTime = requestAnalytics.sumOfTimeForFailure;
-        const failure = `language_server_time_sum{id="${id}" method="${method}" result="failure"} ${failureTime}\n`;
-
-        return success + failure;
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2019 Red Hat, Inc. and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { MetricOutput, AnalyticsFromRequests } from '../../common/plugin-metrics-types';
+import { injectable } from '@theia/core/shared/inversify';
+
+@injectable()
+export class PluginMetricTimeSum implements MetricOutput {
+
+    public header = '# HELP language_server_time_sum Sum of time in milliseconds that language server requests take\n# TYPE language_server_time_sum gauge\n';
+
+    createMetricOutput(id: string, method: string, requestAnalytics: AnalyticsFromRequests): string {
+        const successTime = requestAnalytics.sumOfTimeForSuccess;
+        const success = `language_server_time_sum{id="${id}" method="${method}" result="success"} ${successTime}\n`;
+
+        const failureTime = requestAnalytics.sumOfTimeForFailure;
+        const failure = `language_server_time_sum{id="${id}" method="${method}" result="failure"} ${failureTime}\n`;
+
+        return success + failure;
+    }
+
+}