@harperfast/harper 5.0.7 → 5.0.9

package/dist/utility/environment/systemInformation.d.ts

@@ -1,68 +1,197 @@
+import si from 'systeminformation';
+import { TableSizeObject } from '../../dataLayer/harperBridge/TableSizeObject.ts';
+import { StatsHistogramData } from '@harperfast/rocksdb-js';
+export declare class SystemInformationRequest {
+    operator: string;
+    attributes: string[];
+    constructor(attributes: any);
+}
+export declare class SystemInformationResponse {
+    system?: SystemInfo;
+    time?: TimeData;
+    cpu?: CpuInfo;
+    memory?: MemoryInfo;
+    disk?: DiskInfo;
+    network?: NetworkInfo;
+    harperdb_processes?: HarperdbProcesses;
+    table_size?: TableSizeObject[];
+    metrics?: DatabaseMetrics;
+    threads?: Record<string, unknown>;
+    constructor(system?: SystemInfo, time?: TimeData, cpu?: CpuInfo, memory?: MemoryInfo, disk?: DiskInfo, network?: NetworkInfo, harperdbProcesses?: HarperdbProcesses, tableSize?: TableSizeObject[], metrics?: DatabaseMetrics, threads?: Record<string, unknown>);
+}
+type TimeData = si.Systeminformation.TimeData;
 /**
- * searches for & returns the processes for hdb core
- * @returns {Promise<{core: []}>}
+ * Returns the current local time, uptime, timezone, and timezone name.
  */
-export function getHDBProcessInfo(): Promise<{
-    core: [];
-}>;
+export declare function getTimeInfo(): TimeData;
+type CpuInfo = Pick<si.Systeminformation.CpuData, 'manufacturer' | 'brand' | 'vendor' | 'speed' | 'cores' | 'physicalCores' | 'performanceCores' | 'efficiencyCores' | 'processors' | 'flags' | 'virtualization'> & {
+    cpu_speed: si.Systeminformation.CpuCurrentSpeedData;
+    current_load: Pick<si.Systeminformation.CurrentLoadData, 'avgLoad' | 'currentLoad' | 'currentLoadUser' | 'currentLoadSystem' | 'currentLoadNice' | 'currentLoadIdle' | 'currentLoadIrq'> & {
+        cpus: Pick<si.Systeminformation.CurrentLoadCpuData, 'load' | 'loadUser' | 'loadSystem' | 'loadNice' | 'loadIdle' | 'loadIrq'>[];
+    };
+};
 /**
- * gets networking & connection information & stats
- * @returns {Promise<{interfaces: [], default_interface: null, stats: [], latency: {}, connections: []}>}
+ * Detects CPU information such as manufacturer, brand, vendor, speed, cores, physical cores, and
+ * processors.
+ */
+export declare function getCPUInfo(): Promise<CpuInfo | null>;
+type MemoryInfo = Pick<si.Systeminformation.MemData, 'total' | 'free' | 'used' | 'active' | 'available' | 'reclaimable' | 'swaptotal' | 'swapused' | 'swapfree' | 'writeback' | 'dirty'> & NodeJS.MemoryUsage;
+/**
+ * Detect system and Node.js memory usage.
  */
-export function getNetworkInfo(): Promise<{
-    interfaces: [];
-    default_interface: null;
-    stats: [];
-    latency: {};
-    connections: [];
-}>;
+export declare function getMemoryInfo(): Promise<MemoryInfo | null>;
+type CoreInfo = si.Systeminformation.ProcessesProcessData & {
+    parent?: string;
+};
+type HarperdbProcesses = {
+    core: CoreInfo[];
+};
 /**
- * gets disk related info & stats
- * @returns {Promise<{}>}
+ * Detects the Harper process PID and returns the process info.
+ * @returns {Promise<{core: []}>}
+ */
+export declare function getHDBProcessInfo(): Promise<HarperdbProcesses>;
+type DiskInfo = {
+    io?: Pick<si.Systeminformation.DisksIoData, 'rIO' | 'wIO' | 'tIO'>;
+    read_write?: Pick<si.Systeminformation.FsStatsData, 'rx' | 'tx' | 'wx'>;
+    size?: si.Systeminformation.FsSizeData[];
+};
+/**
+ * Retrieves disk related info & stats
+ * @returns {Promise<DiskInfo>}
  */
-export function getDiskInfo(): Promise<{}>;
+export declare function getDiskInfo(): Promise<DiskInfo>;
+type NetworkInfo = {
+    default_interface: string | null;
+    latency: si.Systeminformation.InetChecksiteData | Record<never, never>;
+    interfaces: Pick<si.Systeminformation.NetworkInterfacesData, 'iface' | 'ifaceName' | 'default' | 'ip4' | 'ip4subnet' | 'ip6' | 'ip6subnet' | 'mac' | 'operstate' | 'type' | 'duplex' | 'speed'>[];
+    stats: any[];
+    connections: any[];
+};
 /**
- * fetches information related memory
- * @returns {Promise<{}|Pick<si.Systeminformation.MemData, "total" | "free" | "used" | "active" | "available" | "swaptotal" | "swapused" | "swapfree">>}
+ * Detects networking connection information & stats
+ * @returns {Promise<{interfaces: [], default_interface: null, stats: [], latency: {}, connections: []}>}
  */
-export function getMemoryInfo(): Promise<{} | Pick<si.Systeminformation.MemData, "total" | "free" | "used" | "active" | "available" | "swaptotal" | "swapused" | "swapfree">>;
+export declare function getNetworkInfo(): Promise<NetworkInfo>;
+type SystemInfo = Partial<Pick<si.Systeminformation.OsData, 'platform' | 'distro' | 'release' | 'codename' | 'kernel' | 'arch' | 'hostname' | 'fqdn'>> & {
+    node_version?: string;
+    npm_version?: string;
+};
 /**
- * executes cpu related functions
- * @returns {Promise<{}|Pick<si.Systeminformation.CpuData, "manufacturer" | "brand" | "vendor" | "speed" | "cores" | "physicalCores" | "processors">>}
+ * Detect operating system and Node.js runtime information.
+ * @returns {Promise<SystemInfo>}
  */
-export function getCPUInfo(): Promise<{} | Pick<si.Systeminformation.CpuData, "manufacturer" | "brand" | "vendor" | "speed" | "cores" | "physicalCores" | "processors">>;
+export declare function getSystemInformation(): Promise<SystemInfo>;
 /**
- * executes the time function to return the time info for the system
- * @returns {si.Systeminformation.TimeData}
+ * Retrieves table size information.
+ * @returns {TableSizeObject[]}
  */
-export function getTimeInfo(): si.Systeminformation.TimeData;
+export declare function getTableSize(): TableSizeObject[];
+type LMDBEnvStats = {
+    entryCount: number;
+    overflowPages: number;
+    pageSize: number;
+    treeBranchPageCount: number;
+    treeDepth: number;
+    treeLeafPageCount: number;
+};
+type LMDBStats = LMDBEnvStats & {
+    free: LMDBEnvStats;
+    lastPageNumber: number;
+    lastTxnId: number;
+    mapSize: number;
+    maxReaders: number;
+    numReaders: number;
+    root: LMDBEnvStats;
+};
+type RocksDBStats = {
+    blockCacheCapacity: number;
+    blockCacheDataHit: number;
+    blockCacheDataMiss: number;
+    blockCacheFilterHit: number;
+    blockCacheFilterMiss: number;
+    blockCacheHit: number;
+    blockCacheIndexHit: number;
+    blockCacheIndexMiss: number;
+    blockCacheMiss: number;
+    blockCachePinnedUsage: number;
+    blockCacheUsage: number;
+    bytesRead: number;
+    bytesWritten: number;
+    dbFlushMicros: StatsHistogramData;
+    dbGetMicros: StatsHistogramData;
+    dbSeekMicros: StatsHistogramData;
+    dbWriteMicros: StatsHistogramData;
+    noFileErrors: number;
+    numberKeysRead: number;
+    numberKeysWritten: number;
+    numberReseeksIteration: number;
+    numRunningFlushes: number;
+    oldestSnapshotTime: number;
+    stallMicros: number;
+    txnOverheadMutexOldCommitMap: number;
+    txnOverheadMutexPrepare: number;
+    txnOverheadMutexSnapshot: number;
+};
+type RocksDBTableStats = {
+    blobdbValueSize: StatsHistogramData;
+    bloomFilterFullPositive: number;
+    bloomFilterFullTruePositive: number;
+    bloomFilterUseful: number;
+    compactReadBytes: number;
+    compactWriteBytes: number;
+    compactionCancelled: number;
+    compactionPending: number;
+    compactionTimesMicros: StatsHistogramData;
+    curSizeActiveMemTable: number;
+    curSizeAllMemTables: number;
+    currentSuperVersionNumber: number;
+    dbIterBytesRead: number;
+    dbWriteStall: StatsHistogramData;
+    estimateLiveDataSize: number;
+    estimateNumKeys: number;
+    estimatePendingCompactionBytes: number;
+    liveBlobFileSize: number;
+    liveSstFilesSize: number;
+    memTableFlushPending: number;
+    memtableHit: number;
+    memtableMiss: number;
+    numBlobFiles: number;
+    numDeletesActiveMemTable: number;
+    numEntriesActiveMemTable: number;
+    numImmutableMemTable: number;
+    numImmutableMemTableFlushed: number;
+    numLiveVersions: number;
+    numRunningCompactions: number;
+    readAmpEstimateUsefulBytes: number;
+    readAmpTotalReadBytes: number;
+    sizeAllMemTables: number;
+    sstReadMicros: StatsHistogramData;
+    totalBlobFileSize: number;
+    totalSstFilesSize: number;
+};
+type TableStats = RocksDBTableStats | Pick<LMDBStats, 'entryCount' | 'overflowPages' | 'treeBranchPageCount' | 'treeDepth' | 'treeLeafPageCount'>;
+type DBStats = RocksDBStats & {
+    audit?: Pick<LMDBStats, 'treeDepth' | 'treeBranchPageCount' | 'treeLeafPageCount' | 'entryCount' | 'overflowPages'>;
+    readers?: {
+        pid: string;
+        thread: string;
+        txnid: string;
+    }[];
+    tables: Record<string, TableStats>;
+};
+type DatabaseMetrics = {
+    [dbName: string]: DBStats;
+};
 /**
- * gets system information
- * @returns {Promise<Pick<si.Systeminformation.OsData, "platform" | "distro" | "release" | "codename" | "kernel" | "arch" | "hostname">|{}>}
+ * Get RocksDB or LMDB metrics for all databases and tables.
+ * @returns {Promise<DatabaseMetrics>}
  */
-export function getSystemInformation(): Promise<Pick<si.Systeminformation.OsData, "platform" | "distro" | "release" | "codename" | "kernel" | "arch" | "hostname"> | {}>;
+export declare function getMetrics(): Promise<DatabaseMetrics>;
 /**
- *
+ * Retrieves system information for the requested attributes.
  * @param {SystemInformationRequest} systemInfoReq
  * @returns {Promise<SystemInformationResponse>}
  */
-export function systemInformation(systemInfoReq: SystemInformationRequest): Promise<SystemInformationResponse>;
-export function getTableSize(): Promise<import("../../dataLayer/harperBridge/lmdbBridge/lmdbUtility/TableSizeObject.js")[]>;
-export function getMetrics(): Promise<{}>;
-export class SystemInformationRequest {
-    constructor(attributes: any);
-    operator: "system_information";
-    attributes: any;
-}
-import si = require("systeminformation");
-declare class SystemInformationResponse {
-    constructor(system: any, time: any, cpu: any, memory: any, disk: any, network: any, harperdbProcesses: any);
-    system: any;
-    time: any;
-    cpu: any;
-    memory: any;
-    disk: any;
-    network: any;
-    harperdb_processes: any;
-}
+export declare function systemInformation(systemInfoReq: SystemInformationRequest): Promise<SystemInformationResponse>;
 export {};