Eric Amodio
2 years ago
14 changed files with 564 additions and 46 deletions
Split View
Diff Options
-
+12 -1package.json
-
+3 -0src/config.ts
-
+13 -1src/container.ts
-
+21 -0src/extension.ts
-
+37 -6src/git/gitProviderService.ts
-
+3 -0src/git/remotes/remoteProviderConnections.ts
-
+52 -4src/plus/subscription/subscriptionService.ts
-
+11 -2src/system/command.ts
-
+42 -28src/system/object.ts
-
+91 -0src/telemetry/openTelemetryProvider.ts
-
+191 -0src/telemetry/telemetry.ts
-
+7 -2src/usageTracker.ts
-
+4 -1webpack.config.js
-
+77 -1yarn.lock
+ 12
- 1
package.json
View File
+ 3
- 0
src/config.ts
View File
+ 13
- 1
src/container.ts
View File
+ 21
- 0
src/extension.ts
View File
+ 37
- 6
src/git/gitProviderService.ts
View File
+ 3
- 0
src/git/remotes/remoteProviderConnections.ts
View File
+ 52
- 4
src/plus/subscription/subscriptionService.ts
View File
+ 11
- 2
src/system/command.ts
View File
+ 42
- 28
src/system/object.ts
View File
+ 91
- 0
src/telemetry/openTelemetryProvider.ts
View File
| @ -0,0 +1,91 @@ | |||
| import type { AttributeValue, Span, Tracer } from '@opentelemetry/api'; | |||
| import { diag, DiagConsoleLogger, trace } from '@opentelemetry/api'; | |||
| import { DiagLogLevel } from '@opentelemetry/api/build/src/diag/types'; | |||
| import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http'; | |||
| import { Resource } from '@opentelemetry/resources'; | |||
| import { | |||
| BasicTracerProvider, | |||
| BatchSpanProcessor, | |||
| ConsoleSpanExporter, | |||
| SimpleSpanProcessor, | |||
| } from '@opentelemetry/sdk-trace-base'; | |||
| import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions'; | |||
| import type { HttpsProxyAgent } from 'https-proxy-agent'; | |||
| import type { TelemetryContext, TelemetryProvider } from './telemetry'; | |||
| export class OpenTelemetryProvider implements TelemetryProvider { | |||
| private _globalAttributes: Record<string, AttributeValue> = {}; | |||
| private readonly tracer: Tracer; | |||
| constructor(context: TelemetryContext, agent?: HttpsProxyAgent, debugging?: boolean) { | |||
| const provider = new BasicTracerProvider({ | |||
| resource: new Resource({ | |||
| [SemanticResourceAttributes.SERVICE_NAME]: 'gitlens', | |||
| [SemanticResourceAttributes.SERVICE_VERSION]: context.extensionVersion, | |||
| [SemanticResourceAttributes.DEPLOYMENT_ENVIRONMENT]: context.env, | |||
| [SemanticResourceAttributes.DEVICE_ID]: context.machineId, | |||
| [SemanticResourceAttributes.OS_TYPE]: context.platform, | |||
| 'extension.id': context.extensionId, | |||
| 'session.id': context.sessionId, | |||
| language: context.language, | |||
| 'vscode.edition': context.vscodeEdition, | |||
| 'vscode.version': context.vscodeVersion, | |||
| 'vscode.host': context.vscodeHost, | |||
| }) as any, | |||
| }); | |||
| if (debugging) { | |||
| diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.VERBOSE); | |||
| provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter())); | |||
| } | |||
| const exporter = new OTLPTraceExporter({ | |||
| url: 'https://otel.gitkraken.com:4318/v1/traces', | |||
| compression: 'gzip' as any, | |||
| httpAgentOptions: agent?.options, | |||
| }); | |||
| provider.addSpanProcessor(debugging ? new SimpleSpanProcessor(exporter) : new BatchSpanProcessor(exporter)); | |||
| provider.register(); | |||
| this.tracer = trace.getTracer(context.extensionId); | |||
| } | |||
| dispose(): void { | |||
| trace.disable(); | |||
| } | |||
| sendEvent(name: string, data?: Record<string, AttributeValue>): void { | |||
| const span = this.tracer.startSpan(name, { startTime: Date.now() }); | |||
| span.setAttributes(this._globalAttributes); | |||
| if (data != null) { | |||
| span.setAttributes(data); | |||
| } | |||
| span.end(); | |||
| } | |||
| startEvent(name: string, data?: Record<string, AttributeValue>): Span { | |||
| const span = this.tracer.startSpan(name, { startTime: Date.now() }); | |||
| span.setAttributes(this._globalAttributes); | |||
| if (data != null) { | |||
| span.setAttributes(data); | |||
| } | |||
| return span; | |||
| } | |||
| // sendErrorEvent( | |||
| // name: string, | |||
| // data?: Record<string, string>, | |||
| // ): void { | |||
| // } | |||
| // sendException( | |||
| // error: Error | unknown, | |||
| // data?: Record<string, string>, | |||
| // ): void { | |||
| // } | |||
| setGlobalAttributes(attributes: Map<string, AttributeValue>): void { | |||
| this._globalAttributes = Object.fromEntries(attributes); | |||
| } | |||
| } | |||
+ 191
- 0
src/telemetry/telemetry.ts
View File
| @ -0,0 +1,191 @@ | |||
| import type { AttributeValue, Span } from '@opentelemetry/api'; | |||
| import type { Disposable } from 'vscode'; | |||
| import { version as codeVersion, env } from 'vscode'; | |||
| import { getProxyAgent } from '@env/fetch'; | |||
| import { getPlatform } from '@env/platform'; | |||
| import { configuration } from '../configuration'; | |||
| import type { Container } from '../container'; | |||
| export interface TelemetryContext { | |||
| env: string; | |||
| extensionId: string; | |||
| extensionVersion: string; | |||
| machineId: string; | |||
| sessionId: string; | |||
| language: string; | |||
| platform: string; | |||
| vscodeEdition: string; | |||
| vscodeHost: string; | |||
| vscodeVersion: string; | |||
| } | |||
| export interface TelemetryProvider extends Disposable { | |||
| sendEvent(name: string, data?: Record<string, AttributeValue>): void; | |||
| startEvent(name: string, data?: Record<string, AttributeValue>): Span; | |||
| setGlobalAttributes(attributes: Map<string, AttributeValue>): void; | |||
| } | |||
| interface QueuedEvent { | |||
| type: 'sendEvent'; | |||
| name: string; | |||
| data?: Record<string, AttributeValue>; | |||
| } | |||
| export class TelemetryService implements Disposable { | |||
| private provider: TelemetryProvider | undefined; | |||
| private enabled: boolean = false; | |||
| private globalAttributes = new Map<string, AttributeValue>(); | |||
| private eventQueue: QueuedEvent[] = []; | |||
| constructor(private readonly container: Container) { | |||
| container.context.subscriptions.push( | |||
| configuration.onDidChange(e => { | |||
| if (!e.affectsConfiguration('telemetry.enabled')) return; | |||
| this.ensureTelemetry(container); | |||
| }), | |||
| env.onDidChangeTelemetryEnabled(() => this.ensureTelemetry(container)), | |||
| ); | |||
| this.ensureTelemetry(container); | |||
| } | |||
| dispose(): void { | |||
| this.provider?.dispose(); | |||
| this.provider = undefined; | |||
| } | |||
| private _initializationTimer: ReturnType<typeof setTimeout> | undefined; | |||
| private ensureTelemetry(container: Container): void { | |||
| this.enabled = env.isTelemetryEnabled && configuration.get('telemetry.enabled', undefined, true); | |||
| if (!this.enabled) { | |||
| if (this._initializationTimer != null) { | |||
| clearTimeout(this._initializationTimer); | |||
| this._initializationTimer = undefined; | |||
| } | |||
| this.eventQueue.length = 0; | |||
| this.provider?.dispose(); | |||
| this.provider = undefined; | |||
| return; | |||
| } | |||
| if (this._initializationTimer != null) return; | |||
| this._initializationTimer = setTimeout(() => this.initializeTelemetry(container), 7500); | |||
| } | |||
| private async initializeTelemetry(container: Container) { | |||
| if (this._initializationTimer != null) { | |||
| clearTimeout(this._initializationTimer); | |||
| this._initializationTimer = undefined; | |||
| } | |||
| this.provider = new ( | |||
| await import(/* webpackChunkName: "telemetry" */ './openTelemetryProvider') | |||
| ).OpenTelemetryProvider( | |||
| { | |||
| env: container.env, | |||
| extensionId: container.id, | |||
| extensionVersion: container.version, | |||
| machineId: env.machineId, | |||
| sessionId: env.sessionId, | |||
| language: env.language, | |||
| platform: getPlatform(), | |||
| vscodeEdition: env.appName, | |||
| vscodeHost: env.appHost, | |||
| vscodeVersion: codeVersion, | |||
| }, | |||
| getProxyAgent(), | |||
| container.debugging, | |||
| ); | |||
| this.provider.setGlobalAttributes(this.globalAttributes); | |||
| if (this.eventQueue.length) { | |||
| const queue = [...this.eventQueue]; | |||
| this.eventQueue.length = 0; | |||
| for (const { type, name, data } of queue) { | |||
| if (type === 'sendEvent') { | |||
| this.provider.sendEvent(name, data); | |||
| } | |||
| } | |||
| } | |||
| } | |||
| sendEvent(name: string, data?: Record<string, AttributeValue | null | undefined>): void { | |||
| if (!this.enabled) return; | |||
| const attributes = stripNullOrUndefinedAttributes(data); | |||
| if (this.provider == null) { | |||
| this.eventQueue.push({ type: 'sendEvent', name: name, data: attributes }); | |||
| return; | |||
| } | |||
| this.provider.sendEvent(name, attributes); | |||
| } | |||
| async startEvent( | |||
| name: string, | |||
| data?: Record<string, AttributeValue | null | undefined>, | |||
| ): Promise<Span | undefined> { | |||
| if (!this.enabled) return; | |||
| if (this.provider == null) { | |||
| await this.initializeTelemetry(this.container); | |||
| } | |||
| const attributes = stripNullOrUndefinedAttributes(data); | |||
| return this.provider!.startEvent(name, attributes); | |||
| } | |||
| // sendErrorEvent( | |||
| // name: string, | |||
| // data?: Record<string, string>, | |||
| // ): void { | |||
| // } | |||
| // sendException( | |||
| // error: Error | unknown, | |||
| // data?: Record<string, string>, | |||
| // ): void { | |||
| // } | |||
| setGlobalAttribute(key: string, value: AttributeValue | null | undefined): void { | |||
| if (value == null) { | |||
| this.globalAttributes.delete(key); | |||
| } else { | |||
| this.globalAttributes.set(key, value); | |||
| } | |||
| this.provider?.setGlobalAttributes(this.globalAttributes); | |||
| } | |||
| setGlobalAttributes(attributes: Record<string, AttributeValue | null | undefined>): void { | |||
| for (const [key, value] of Object.entries(attributes)) { | |||
| if (value == null) { | |||
| this.globalAttributes.delete(key); | |||
| } else { | |||
| this.globalAttributes.set(key, value); | |||
| } | |||
| } | |||
| this.provider?.setGlobalAttributes(this.globalAttributes); | |||
| } | |||
| deleteGlobalAttribute(key: string): void { | |||
| this.globalAttributes.delete(key); | |||
| this.provider?.setGlobalAttributes(this.globalAttributes); | |||
| } | |||
| } | |||
| function stripNullOrUndefinedAttributes(data: Record<string, AttributeValue | null | undefined> | undefined) { | |||
| let attributes: Record<string, AttributeValue> | undefined; | |||
| if (data != null) { | |||
| attributes = Object.create(null); | |||
| for (const [key, value] of Object.entries(data)) { | |||
| if (value == null) continue; | |||
| attributes![key] = value; | |||
| } | |||
| } | |||
| return attributes; | |||
| } | |||