Add logs for database (#343)

Author: satyakigh

src/datastore/FileStore.ts

@@ -4,6 +4,7 @@ import { Logger } from 'pino';
 import { LoggerFactory } from '../telemetry/LoggerFactory';
 import { ScopedTelemetry } from '../telemetry/ScopedTelemetry';
 import { Telemetry } from '../telemetry/TelemetryDecorator';
+import { formatNumber } from '../utils/String';
 import { DataStore, DataStoreFactory, StoreName } from './DataStore';
 import { EncryptedFileStore } from './file/EncryptedFileStore';
 import { encryptionKey } from './file/Encryption';
@@ -40,7 +41,7 @@ export class FileStoreFactory implements DataStoreFactory {
             2 * 60 * 1000,
         );
 
-        this.log.info(`Initialized FileDB ${Version}`);
+        this.log.info(`Initialized FileDB ${Version} and ${formatNumber(this.totalBytes() / (1024 * 1024), 4)} MB`);
     }
 
     get(store: StoreName): DataStore {
@@ -66,18 +67,16 @@ export class FileStoreFactory implements DataStoreFactory {
         this.telemetry.histogram('version', VersionNumber);
         this.telemetry.histogram('env.entries', this.stores.size);
 
-        let totalBytes = 0;
         for (const [name, store] of this.stores.entries()) {
             const stats = store.stats();
 
-            totalBytes += stats.totalSize;
             this.telemetry.histogram(`store.${name}.entries`, stats.entries);
             this.telemetry.histogram(`store.${name}.size.bytes`, stats.totalSize, {
                 unit: 'By',
             });
         }
 
-        this.telemetry.histogram('total.size.bytes', totalBytes, {
+        this.telemetry.histogram('total.size.bytes', this.totalBytes(), {
             unit: 'By',
         });
     }
@@ -96,6 +95,16 @@ export class FileStoreFactory implements DataStoreFactory {
             }
         }
     }
+
+    private totalBytes() {
+        let totalBytes = 0;
+
+        for (const store of this.stores.values()) {
+            totalBytes += store.stats().totalSize;
+        }
+
+        return totalBytes;
+    }
 }
 
 const VersionNumber = 2;

src/datastore/LMDB.ts

@@ -5,7 +5,7 @@ import { LoggerFactory } from '../telemetry/LoggerFactory';
 import { ScopedTelemetry } from '../telemetry/ScopedTelemetry';
 import { Telemetry } from '../telemetry/TelemetryDecorator';
 import { isWindows } from '../utils/Environment';
-import { toString } from '../utils/String';
+import { formatNumber, toString } from '../utils/String';
 import { DataStore, DataStoreFactory, StoreName } from './DataStore';
 import { LMDBStore } from './lmdb/LMDBStore';
 import { stats } from './lmdb/Stats';
@@ -69,7 +69,7 @@ export class LMDBStoreFactory implements DataStoreFactory {
                 noSubdir: config.noSubdir,
                 overlappingSync: config.overlappingSync,
             },
-            `Initialized LMDB ${Version} with stores: ${toString(storeNames)}`,
+            `Initialized LMDB ${Version} with stores: ${toString(storeNames)} and ${formatNumber(this.totalBytes() / (1024 * 1024), 4)} MB`,
         );
     }
 
@@ -110,19 +110,18 @@ export class LMDBStoreFactory implements DataStoreFactory {
     }
 
     private emitMetrics(): void {
-        let totalBytes = 0;
+        const totalBytes = this.totalBytes();
+
         const envStat = stats(this.env);
         this.telemetry.histogram('version', VersionNumber);
         this.telemetry.histogram('env.size.bytes', envStat.totalSize, { unit: 'By' });
         this.telemetry.histogram('env.max.size.bytes', envStat.maxSize, {
             unit: 'By',
         });
         this.telemetry.histogram('env.entries', envStat.entries);
-        totalBytes += envStat.totalSize;
 
         for (const [name, store] of this.stores.entries()) {
             const stat = store.stats();
-            totalBytes += stat.totalSize;
 
             this.telemetry.histogram(`store.${name}.size.bytes`, stat.totalSize, {
                 unit: 'By',
@@ -137,6 +136,17 @@ export class LMDBStoreFactory implements DataStoreFactory {
             unit: 'By',
         });
     }
+
+    private totalBytes() {
+        let totalBytes = 0;
+        totalBytes += stats(this.env).totalSize;
+
+        for (const store of this.stores.values()) {
+            totalBytes += store.stats().totalSize;
+        }
+
+        return totalBytes;
+    }
 }
 
 const VersionNumber = 5;

src/schema/GetSamSchemaTask.ts

@@ -34,7 +34,7 @@ export class GetSamSchemaTask extends GetSchemaTask {
 
             await dataStore.put(SamStoreKey, samSchemasData);
 
-            this.logger.info(`${resourceSchemas.size} SAM schemas downloaded and stored`);
+            this.logger.info(`${resourceSchemas.size} SAM schemas downloaded and saved`);
         } catch (error) {
             this.logger.error(error, 'Failed to download SAM schemas');
             throw error;

src/schema/GetSchemaTask.ts

@@ -66,7 +66,7 @@ export class GetPublicSchemaTask extends GetSchemaTask {
         };
 
         await dataStore.put<RegionalSchemasType>(this.region, value);
-        this.logger.info(`${schemas.length} public schemas retrieved for ${this.region}`);
+        this.logger.info(`${schemas.length} public schemas downloaded for ${this.region} and saved`);
     }
 }
 

src/telemetry/ScopedTelemetry.ts

@@ -9,20 +9,15 @@ import {
     Tracer,
     UpDownCounter,
     ValueType,
-    MetricAdvice,
 } from '@opentelemetry/api';
 import { Closeable } from '../utils/Closeable';
 import { typeOf } from '../utils/TypeCheck';
 import { TelemetryContext } from './TelemetryContext';
 
-export type MetricConfig = {
-    description?: string;
-    unit?: string;
-    valueType?: ValueType;
-    advice?: MetricAdvice;
+export interface MetricConfig extends MetricOptions {
     trackObjectKey?: string;
     attributes?: Attributes;
-};
+}
 
 export class ScopedTelemetry implements Closeable {
     private readonly counters = new Map<string, Counter>();

src/utils/String.ts

@@ -34,3 +34,7 @@ export function byteSize(str: string) {
     const bytes: Uint8Array = new TextEncoder().encode(str);
     return bytes.length;
 }
+
+export function formatNumber(value: number, decimals: number = 2) {
+    return value.toFixed(decimals);
+}