<!--
 ⚠️  AUTO-GENERATED FILE - DO NOT EDIT MANUALLY
 This file is automatically generated by scripts/docs-generator.js
 To make changes, edit the source TypeScript files or update the generator script
-->

[agents](../../) / [Exports](../modules) / SystemMetricsCollector

# Interface: SystemMetricsCollector

System metrics collector interface

## Implemented by

- [`NodeSystemMetricsCollector`](../classes/NodeSystemMetricsCollector)

## Table of contents

### Methods

- [getMemoryUsage](SystemMetricsCollector#getmemoryusage)
- [getCPUUsage](SystemMetricsCollector#getcpuusage)
- [getNetworkStats](SystemMetricsCollector#getnetworkstats)

## Methods

### getMemoryUsage

▸ **getMemoryUsage**(): `Promise`\<`undefined` \| \{ `used`: `number` ; `free`: `number` ; `total`: `number` ; `heap`: \{ `used`: `number` ; `total`: `number` } }\>

#### Returns

`Promise`\<`undefined` \| \{ `used`: `number` ; `free`: `number` ; `total`: `number` ; `heap`: \{ `used`: `number` ; `total`: `number` } }\>

#### Defined in

[packages/agents/src/plugins/performance/types.ts:131](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/plugins/performance/types.ts#L131)

---

### getCPUUsage

▸ **getCPUUsage**(): `Promise`\<`undefined` \| \{ `user`: `number` ; `system`: `number` ; `percent`: `number` }\>

#### Returns

`Promise`\<`undefined` \| \{ `user`: `number` ; `system`: `number` ; `percent`: `number` }\>

#### Defined in

[packages/agents/src/plugins/performance/types.ts:132](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/plugins/performance/types.ts#L132)

---

### getNetworkStats

▸ **getNetworkStats**(): `Promise`\<`undefined` \| \{ `requests`: `number` ; `bytesReceived`: `number` ; `bytesSent`: `number` ; `latency`: `number` }\>

#### Returns

`Promise`\<`undefined` \| \{ `requests`: `number` ; `bytesReceived`: `number` ; `bytesSent`: `number` ; `latency`: `number` }\>

#### Defined in

[packages/agents/src/plugins/performance/types.ts:133](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/plugins/performance/types.ts#L133)
