@gitpod/gitpod-protocol 0.1.5-port-description-3059-fork.0 → 0.1.5-port-description-3059-fork.2

package/src/util/tracing.spec.ts

@@ -0,0 +1,83 @@
+/**
+ * Copyright (c) 2021 Gitpod GmbH. All rights reserved.
+ * Licensed under the GNU Affero General Public License (AGPL).
+ * See License-AGPL.txt in the project root for license information.
+ */
+
+import { suite, test } from "mocha-typescript"
+import * as chai from "chai"
+import { TraceContext } from "./tracing";
+import { MockTracer } from "opentracing";
+
+const expect = chai.expect
+
+@suite class TestTracing {
+
+    @test public async testTracingContext_addNestedTags() {
+        const tracer = new MockTracer();
+        const span = tracer.startSpan('testTracingContext_addNestedTags');
+        TraceContext.addNestedTags({ span }, {
+            rpc: {
+                system: "jsonrpc",
+                jsonrpc: {
+                    version: "1.0",
+                    method: "test",
+                    parameters: ["abc", "def"],
+                },
+            },
+        });
+
+        const mockSpan = tracer.report().spans[0];
+        expect(mockSpan.tags()).to.deep.equal({
+            "rpc.system": "jsonrpc",
+            "rpc.jsonrpc.version": "1.0",
+            "rpc.jsonrpc.method": "test",
+            "rpc.jsonrpc.parameters.0": "abc",
+            "rpc.jsonrpc.parameters.1": "def",
+        });
+    }
+
+    @test public async testTracingContext_addNestedTags_null() {
+        const tracer = new MockTracer();
+        const span = tracer.startSpan('testTracingContext_addNestedTags_null');
+        TraceContext.addNestedTags({ span }, {
+            someShape: {
+                thisIsNull: null,
+                thisIsUndefined: undefined,
+            },
+        });
+
+        const mockSpan = tracer.report().spans[0];
+        expect(mockSpan.tags()).to.deep.equal({
+            "someShape.thisIsNull": null,
+            "someShape.thisIsUndefined": undefined,
+        });
+    }
+
+    @test public async testTracingContext_addJsonRPCParameters() {
+        const tracer = new MockTracer();
+        const span = tracer.startSpan('testTracingContext_addJsonRPCParameters');
+        const ctx = { span };
+        TraceContext.addJsonRPCParameters(ctx, {
+            one: "one",
+            two: {
+                name: "two",
+                some: "shape",
+                containing: "PII",
+            },
+            three: "three",
+        });
+
+        const mockSpan = tracer.report().spans[0];
+        expect(mockSpan.tags()).to.deep.equal({
+            "rpc.jsonrpc.parameters.one": "one",
+            "rpc.jsonrpc.parameters.two.containing": "PII",
+            "rpc.jsonrpc.parameters.two.name": "two",
+            "rpc.jsonrpc.parameters.two.some": "shape",
+            "rpc.jsonrpc.parameters.three": "three",
+            "rpc.system": "jsonrpc",
+        });
+    }
+
+}
+module.exports = new TestTracing()

package/src/util/tracing.ts

@@ -6,10 +6,12 @@
 
 
 import * as opentracing from 'opentracing';
-import { TracingConfig, initTracerFromEnv, Sampler, SamplingDecision } from 'jaeger-client';
+import { TracingConfig, initTracerFromEnv } from 'jaeger-client';
+import { Sampler, SamplingDecision } from './jaeger-client-types';
 import { initGlobalTracer } from 'opentracing';
 import { injectable } from 'inversify';
 import { ResponseError } from 'vscode-jsonrpc';
+import { log, LogContext } from './logging';
 
 export interface TraceContext {
     span?: opentracing.Span
@@ -20,49 +22,62 @@ export type TraceContextWithSpan = TraceContext & {
 
 
 export namespace TraceContext {
-    export function startSpan(operation: string, parentCtx: TraceContext): opentracing.Span {
-        const options: opentracing.SpanOptions = {
-            childOf: parentCtx.span
+    export function startSpan(operation: string, parentCtx?: TraceContext): opentracing.Span {
+        let options: opentracing.SpanOptions | undefined = undefined;
+        if (parentCtx) {
+            options = {
+                childOf: parentCtx.span
+            };
         }
         return opentracing.globalTracer().startSpan(operation, options);
     }
 
-    export function childContextWithSpan(operation: string, parentCtx: TraceContext): TraceContextWithSpan {
+    export function childContext(operation: string, parentCtx: TraceContext): TraceContextWithSpan {
         const span = startSpan(operation, parentCtx);
         return { span };
     }
 
-    export function startAsyncSpan(operation: string, ctx: TraceContext): opentracing.Span {
-        const options: opentracing.SpanOptions = {};
-        if (!!ctx.span) {
-            options.references = [opentracing.followsFrom(ctx.span.context())];
+    export function setError(ctx: TraceContext, err: Error) {
+        if (!ctx.span) {
+            return;
         }
-        return opentracing.globalTracer().startSpan(operation, options);
+
+        TraceContext.addNestedTags(ctx, {
+            error: {
+                message: err.message,
+                stacktrace: err.stack,
+            },
+        });
+        ctx.span.setTag("error", true);
     }
 
-    export function logError(ctx: TraceContext, err: Error) {
+    export function setJsonRPCMetadata(ctx: TraceContext, method?: string) {
         if (!ctx.span) {
             return;
         }
 
-        ctx.span.log({
-            "error": err.message,
-            "stacktrace": err.stack
-        })
-        ctx.span.setTag("error", true);
+        const tags: { [key: string]: any } = {
+            rpc: {
+                system: "jsonrpc",
+                //  version,
+            },
+        };
+        if (method) {
+            tags.rpc.method = method;
+        }
+        addNestedTags(ctx, tags);
     }
 
-    export function logJsonRPCError(ctx: TraceContext, method: string, err: ResponseError<any>) {
+    export function setJsonRPCError(ctx: TraceContext, method: string, err: ResponseError<any>) {
         if (!ctx.span) {
             return;
         }
-        logError(ctx, err);
+        // not use setError bc this is (most likely) a working operation
 
+        setJsonRPCMetadata(ctx);
         // https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/rpc.md#json-rpc
-        ctx.span.addTags({
+        addNestedTags(ctx, {
             rpc: {
-                system: "jsonrpc",
-                method,
                 jsonrpc: {
                     error_code: err.code,
                     error_message: err.message,
@@ -71,21 +86,75 @@ export namespace TraceContext {
         });
     }
 
-    export function addJsonRPCParameters(ctx: TraceContext, method: string, args: any[]) {
+    export function addJsonRPCParameters(ctx: TraceContext, params: { [key: string]: any }) {
         if (!ctx.span) {
             return;
         }
 
-        ctx.span.addTags({
+        setJsonRPCMetadata(ctx);
+        addNestedTags(ctx, {
             rpc: {
-                system: "jsonrpc",
-                method,
                 jsonrpc: {
-                    parameters: args.slice(),
+                    parameters: params,
                 },
             },
         });
     }
+
+    /**
+     * Does what one would expect from `span.addTags`: Calls `span.addTag` for all keys in map, recursively for objects.
+     * Example:
+     * ```
+     * TraceContext.addNestedTags(ctx, {
+     *    rpc: {
+     *       system: "jsonrpc",
+     *       jsonrpc: {
+     *          version: "1.0",
+     *          method: "test",
+     *          parameters: ["abc", "def"],
+     *       },
+     *    },
+     * });
+     * ```
+     * gives
+     * rpc.system = "jsonrpc"
+     * rpc.jsonrpc.version = "1.0"
+     * rpc.jsonrpc.method = "test"
+     * rpc.jsonrpc.parameters.0 = "abc"
+     * rpc.jsonrpc.parameters.1 = "def"
+     * @param ctx
+     * @param keyValueMap
+     * @returns
+     */
+    export function addNestedTags(ctx: TraceContext, keyValueMap: { [key: string]: any }, _namespace?: string) {
+        if (!ctx.span) {
+            return;
+        }
+        const namespace = _namespace ? `${_namespace}.` : '';
+
+        try {
+            for (const k of Object.keys(keyValueMap)) {
+                const v = keyValueMap[k];
+                if (v instanceof Object) {
+                    addNestedTags(ctx, v, `${namespace}${k}`);
+                } else {
+                    ctx.span.setTag(`${namespace}${k}`, v);
+                }
+            }
+        } catch (err) {
+            // general resilience against odd shapes/parameters
+            log.error("Tracing.addNestedTags", err, { namespace });
+        }
+    }
+
+    export function setOWI(ctx: TraceContext, owi: LogContext) {
+        if (!ctx.span) {
+            return;
+        }
+        addNestedTags(ctx, {
+            context: owi,
+        });
+    }
 }
 
 @injectable()
@@ -101,11 +170,16 @@ export class TracingManager {
             reporter: {
                 logSpans: false
             },
-            serviceName
+            serviceName,
         }
         const t = initTracerFromEnv(config, {
-            logger: console
+            logger: console,
+            tags: {
+                'service.build.commit': process.env.GITPOD_BUILD_GIT_COMMIT,
+                'service.build.version': process.env.GITPOD_BUILD_VERSION,
+            }
         });
+
         if (opts) {
             if (opts.perOpSampling) {
                 (t as any)._sampler = new PerOperationSampler((t as any)._sampler, opts.perOpSampling);

package/lib/util/repeater.d.ts

@@ -1,22 +0,0 @@
-/**
- * Copyright (c) 2020 Gitpod GmbH. All rights reserved.
- * Licensed under the GNU Affero General Public License (AGPL).
- * See License-AGPL.txt in the project root for license information.
- */
-import { Deferred } from "./deferred";
-/**
- * Repeats a given function until it is stopped
- */
-export declare class Repeater {
-    protected readonly fn: () => Promise<void> | void;
-    protected readonly timeout: number;
-    protected shouldRun: boolean;
-    protected finished: Deferred<void>;
-    protected timer?: any;
-    constructor(fn: () => Promise<void> | void, timeout: number);
-    start(): Promise<void>;
-    run(): Promise<void>;
-    protected sleep(timeout: number): Promise<unknown>;
-    stop(): Promise<void>;
-}
-//# sourceMappingURL=repeater.d.ts.map

package/lib/util/repeater.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"repeater.d.ts","sourceRoot":"","sources":["../../src/util/repeater.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC;;GAEG;AACH,qBAAa,QAAQ;IAKL,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;IAAE,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM;IAJjG,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC;IAC7B,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAA;IAClC,SAAS,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC;gBAES,EAAE,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,EAAqB,OAAO,EAAE,MAAM;IAE3F,KAAK;IAIL,GAAG;cAcO,KAAK,CAAC,OAAO,EAAE,MAAM;IAI/B,IAAI;CAOb"}

package/lib/util/repeater.js

@@ -1,65 +0,0 @@
-"use strict";
-/**
- * Copyright (c) 2020 Gitpod GmbH. All rights reserved.
- * Licensed under the GNU Affero General Public License (AGPL).
- * See License-AGPL.txt in the project root for license information.
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Repeater = void 0;
-const deferred_1 = require("./deferred");
-const logging_1 = require("./logging");
-/**
- * Repeats a given function until it is stopped
- */
-class Repeater {
-    constructor(fn, timeout) {
-        this.fn = fn;
-        this.timeout = timeout;
-    }
-    start() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.run();
-        });
-    }
-    run() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.shouldRun = true;
-            this.finished = new deferred_1.Deferred();
-            while (this.shouldRun) {
-                try {
-                    yield this.fn();
-                }
-                catch (err) {
-                    logging_1.log.error(err);
-                }
-                yield this.sleep(this.timeout);
-            }
-            this.finished.resolve();
-        });
-    }
-    sleep(timeout) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return new Promise(resolve => this.timer = setTimeout(resolve, timeout));
-        });
-    }
-    stop() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.shouldRun = false;
-            if (this.timer) {
-                clearTimeout(this.timer);
-            }
-            return this.finished.promise;
-        });
-    }
-}
-exports.Repeater = Repeater;
-//# sourceMappingURL=repeater.js.map

package/lib/util/repeater.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"repeater.js","sourceRoot":"","sources":["../../src/util/repeater.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;;;;;;;AAEH,yCAAsC;AACtC,uCAAgC;AAEhC;;GAEG;AACH,MAAa,QAAQ;IAKjB,YAA+B,EAA8B,EAAqB,OAAe;QAAlE,OAAE,GAAF,EAAE,CAA4B;QAAqB,YAAO,GAAP,OAAO,CAAQ;IAAI,CAAC;IAEhG,KAAK;;YACP,IAAI,CAAC,GAAG,EAAE,CAAC;QACf,CAAC;KAAA;IAEK,GAAG;;YACL,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,EAAQ,CAAC;YACrC,OAAO,IAAI,CAAC,SAAS,EAAE;gBACnB,IAAI;oBACA,MAAM,IAAI,CAAC,EAAE,EAAE,CAAC;iBACnB;gBAAC,OAAO,GAAG,EAAE;oBACV,aAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;iBAClB;gBACD,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aAClC;YACD,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;QAC5B,CAAC;KAAA;IAEe,KAAK,CAAC,OAAe;;YACjC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QAC7E,CAAC;KAAA;IAEK,IAAI;;YACN,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;YACvB,IAAI,IAAI,CAAC,KAAK,EAAE;gBACZ,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aAC5B;YACD,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QACjC,CAAC;KAAA;CACJ;AApCD,4BAoCC"}

package/src/util/jaeger-client.d.ts

@@ -1,105 +0,0 @@
-/**
- * Copyright (c) 2020 Gitpod GmbH. All rights reserved.
- * Licensed under the GNU Affero General Public License (AGPL).
- * See License-AGPL.txt in the project root for license information.
- */
-
-// Type definitions for jaeger-client
-// Project: https://github.com/uber/jaeger-client-node
-// Definitions by: Julian Steger <https://github.com/julianste>
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-
-declare module 'jaeger-client' {
-    import * as opentracing from "opentracing";
-
-    export interface TracingConfig {
-        serviceName?: string;
-        disable?: boolean;
-        sampler?: SamplerConfig;
-        reporter?: ReporterConfig;
-    }
-
-    export interface TracingOptions {
-        reporter?: Reporter;
-        metrics?: MetricsFactory;
-        logger?: Logger;
-        tags?: any;
-    }
-
-    export interface ReporterConfig {
-        logSpans?: boolean;
-        agentHost?: string;
-        agentPort?: number;
-        flushIntervalMs?: number;
-    }
-
-    export interface SamplerConfig {
-        type: string;
-        param: number;
-        host?: string;
-        port?: number;
-        refreshIntervalMs?: number;
-    }
-
-    export interface Logger {
-        info(msg: string): void;
-        error(msg: string): void;
-    }
-
-    export interface Reporter {
-        report(span: opentracing.Span): void;
-        close(callback?: () => void): void;
-        setProcess(serviceName: string, tags: any): void;
-    }
-
-    export interface MetricsFactory {
-        createCounter(name: string, tags: any): Counter;
-        createTimer(name: string, tags: any): Timer;
-        createGauge(name: string, tags: any): Gauge;
-    }
-
-    // Counter tracks the number of times an event has occurred
-    export interface Counter {
-        // Adds the given value to the counter.
-        increment(delta: number): void;
-    }
-
-    // Timer tracks how long an operation took and also computes percentiles.
-    export interface Timer {
-        // Records the time passed in.
-        record(value: number): void;
-    }
-
-    // Gauge returns instantaneous measurements of something as an int64 value
-    export interface Gauge {
-        // Update the gauge to the value passed in.
-        update(value: number): void;
-    }
-
-    export function initTracer(
-        tracingConfig: TracingConfig,
-        tracingOptions: TracingOptions,
-    ): opentracing.Tracer;
-
-    export function initTracerFromEnv(
-        tracingConfig: TracingConfig,
-        tracingOptions: TracingOptions,
-    ): opentracing.Tracer;
-
-    export interface SamplingDecision {
-        sample: boolean;
-        retryable: boolean;
-        tags: any;
-    }
-
-    // added by TypeFox
-    export interface Sampler {
-        name(): string
-        isSampled(operation: string, tags: any): boolean;
-        onCreateSpan(span: opentracing.Span): SamplingDecision;
-        onSetOperationName(span: opentracing.Span, operationName: string): SamplingDecision;
-        onSetTag(span: opentracing.Span, key: string, value: any): SamplingDecision;
-        close(callback: () => void): void
-    }
-
-}

package/src/util/repeater.ts

@@ -1,49 +0,0 @@
-/**
- * Copyright (c) 2020 Gitpod GmbH. All rights reserved.
- * Licensed under the GNU Affero General Public License (AGPL).
- * See License-AGPL.txt in the project root for license information.
- */
-
-import { Deferred } from "./deferred";
-import { log } from './logging';
-
-/**
- * Repeats a given function until it is stopped
- */
-export class Repeater {
-    protected shouldRun: boolean;
-    protected finished: Deferred<void>
-    protected timer?: any;
-
-    constructor(protected readonly fn: () => Promise<void> | void, protected readonly timeout: number) { }
-
-    async start() {
-        this.run();
-    }
-
-    async run() {
-        this.shouldRun = true;
-        this.finished = new Deferred<void>();
-        while (this.shouldRun) {
-            try {
-                await this.fn();
-            } catch (err) {
-                log.error(err);
-            }
-            await this.sleep(this.timeout);
-        }
-        this.finished.resolve();
-    }
-
-    protected async sleep(timeout: number) {
-        return new Promise(resolve => this.timer = setTimeout(resolve, timeout));
-    }
-
-    async stop() {
-        this.shouldRun = false;
-        if (this.timer) {
-            clearTimeout(this.timer);
-        }
-        return this.finished.promise;
-    }
-}