Add document size metrics (#231)

Author: satyakigh

src/document/DocumentManager.ts

@@ -5,11 +5,13 @@ import { DefaultSettings, EditorSettings } from '../settings/Settings';
 import { LoggerFactory } from '../telemetry/LoggerFactory';
 import { ScopedTelemetry } from '../telemetry/ScopedTelemetry';
 import { Telemetry } from '../telemetry/TelemetryDecorator';
+import { Closeable } from '../utils/Closeable';
 import { Delayer } from '../utils/Delayer';
+import { byteSize } from '../utils/String';
 import { CloudFormationFileType, Document, DocumentType } from './Document';
 import { DocumentMetadata } from './DocumentProtocol';
 
-export class DocumentManager implements SettingsConfigurable {
+export class DocumentManager implements SettingsConfigurable, Closeable {
     private readonly log = LoggerFactory.getLogger(DocumentManager);
 
     @Telemetry() private readonly telemetry!: ScopedTelemetry;
@@ -19,6 +21,7 @@ export class DocumentManager implements SettingsConfigurable {
     private readonly documentMap = new Map<string, Document>();
 
     private settingsSubscription?: SettingsSubscription;
+    private readonly interval: NodeJS.Timeout;
 
     constructor(
         private readonly documents: TextDocuments<TextDocument>,
@@ -27,6 +30,9 @@ export class DocumentManager implements SettingsConfigurable {
         },
     ) {
         this.registerDocumentGauges();
+        this.interval = setInterval(() => {
+            this.emitDocSizeMetrics();
+        }, 30 * 1000);
     }
 
     configure(settingsManager: ISettingsSubscriber): void {
@@ -157,6 +163,12 @@ export class DocumentManager implements SettingsConfigurable {
         }
     }
 
+    private emitDocSizeMetrics() {
+        for (const doc of this.documentMap.values()) {
+            this.telemetry.histogram(`documents.size.bytes`, byteSize(doc.contents()), { unit: 'By' });
+        }
+    }
+
     private countDocumentsByCfnType(cfnType: CloudFormationFileType): number {
         return [...this.documentMap.values()].filter((doc) => doc.cfnFileType === cfnType).length;
     }
@@ -168,4 +180,8 @@ export class DocumentManager implements SettingsConfigurable {
     private countDocumentsByExtension(extension: string): number {
         return [...this.documentMap.values()].filter((doc) => doc.isTemplate() && doc.extension === extension).length;
     }
+
+    close() {
+        clearInterval(this.interval);
+    }
 }

src/server/CfnInfraCore.ts

@@ -72,8 +72,13 @@ export class CfnInfraCore implements Configurables, Closeable {
     }
 
     async close() {
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
-        return await closeSafely(this.dataStoreFactory, TelemetryService.instance, LoggerFactory._instance);
+        return await closeSafely(
+            this.documentManager,
+            this.dataStoreFactory,
+            TelemetryService.instance,
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            LoggerFactory._instance,
+        );
     }
 }

src/telemetry/OTELInstrumentation.ts

@@ -59,6 +59,15 @@ export function otelSdk(clientId: string, client?: ClientInfo) {
                     },
                 },
             } satisfies ViewOptions,
+            {
+                instrumentName: '*.bytes',
+                aggregation: {
+                    type: AggregationType.EXPONENTIAL_HISTOGRAM,
+                    options: {
+                        recordMinMax: true,
+                    },
+                },
+            } satisfies ViewOptions,
         ],
         instrumentations: [
             getNodeAutoInstrumentations({