<!--
 ⚠️  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) / PerformancePluginOptions

# Interface: PerformancePluginOptions

Configuration options for performance plugin

## Hierarchy

- [`IPluginOptions`](IPluginOptions)

  ↳ **`PerformancePluginOptions`**

## Table of contents

### Properties

- [enabled](PerformancePluginOptions#enabled)
- [category](PerformancePluginOptions#category)
- [priority](PerformancePluginOptions#priority)
- [moduleEvents](PerformancePluginOptions#moduleevents)
- [subscribeToAllModuleEvents](PerformancePluginOptions#subscribetoallmoduleevents)
- [strategy](PerformancePluginOptions#strategy)
- [filePath](PerformancePluginOptions#filepath)
- [remoteEndpoint](PerformancePluginOptions#remoteendpoint)
- [prometheusEndpoint](PerformancePluginOptions#prometheusendpoint)
- [remoteHeaders](PerformancePluginOptions#remoteheaders)
- [maxEntries](PerformancePluginOptions#maxentries)
- [monitorMemory](PerformancePluginOptions#monitormemory)
- [monitorCPU](PerformancePluginOptions#monitorcpu)
- [monitorNetwork](PerformancePluginOptions#monitornetwork)
- [batchSize](PerformancePluginOptions#batchsize)
- [flushInterval](PerformancePluginOptions#flushinterval)
- [aggregateStats](PerformancePluginOptions#aggregatestats)
- [aggregationInterval](PerformancePluginOptions#aggregationinterval)
- [performanceThreshold](PerformancePluginOptions#performancethreshold)

## Properties

### enabled

• `Optional` **enabled**: `boolean`

Whether the plugin is enabled

#### Inherited from

[IPluginOptions](IPluginOptions).[enabled](IPluginOptions#enabled)

#### Defined in

[packages/agents/src/abstracts/abstract-plugin.ts:126](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/abstracts/abstract-plugin.ts#L126)

---

### category

• `Optional` **category**: [`PluginCategory`](../enums/PluginCategory)

Plugin category for classification

#### Inherited from

[IPluginOptions](IPluginOptions).[category](IPluginOptions#category)

#### Defined in

[packages/agents/src/abstracts/abstract-plugin.ts:128](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/abstracts/abstract-plugin.ts#L128)

---

### priority

• `Optional` **priority**: `number`

Plugin priority for execution order

#### Inherited from

[IPluginOptions](IPluginOptions).[priority](IPluginOptions#priority)

#### Defined in

[packages/agents/src/abstracts/abstract-plugin.ts:130](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/abstracts/abstract-plugin.ts#L130)

---

### moduleEvents

• `Optional` **moduleEvents**: [`EventType`](../modules#eventtype)[]

Events to subscribe to from modules

#### Inherited from

[IPluginOptions](IPluginOptions).[moduleEvents](IPluginOptions#moduleevents)

#### Defined in

[packages/agents/src/abstracts/abstract-plugin.ts:132](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/abstracts/abstract-plugin.ts#L132)

---

### subscribeToAllModuleEvents

• `Optional` **subscribeToAllModuleEvents**: `boolean`

Whether to subscribe to all module events

#### Inherited from

[IPluginOptions](IPluginOptions).[subscribeToAllModuleEvents](IPluginOptions#subscribetoallmoduleevents)

#### Defined in

[packages/agents/src/abstracts/abstract-plugin.ts:134](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/abstracts/abstract-plugin.ts#L134)

---

### strategy

• **strategy**: [`PerformanceMonitoringStrategy`](../modules#performancemonitoringstrategy)

Performance monitoring strategy to use

#### Defined in

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

---

### filePath

• `Optional` **filePath**: `string`

File path for file strategy

#### Defined in

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

---

### remoteEndpoint

• `Optional` **remoteEndpoint**: `string`

Remote endpoint for remote strategy

#### Defined in

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

---

### prometheusEndpoint

• `Optional` **prometheusEndpoint**: `string`

Prometheus endpoint for prometheus strategy

#### Defined in

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

---

### remoteHeaders

• `Optional` **remoteHeaders**: `Record`\<`string`, `string`\>

Headers for remote monitoring

#### Defined in

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

---

### maxEntries

• `Optional` **maxEntries**: `number`

Maximum number of performance entries to keep in memory

#### Defined in

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

---

### monitorMemory

• `Optional` **monitorMemory**: `boolean`

Whether to monitor memory usage

#### Defined in

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

---

### monitorCPU

• `Optional` **monitorCPU**: `boolean`

Whether to monitor CPU usage

#### Defined in

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

---

### monitorNetwork

• `Optional` **monitorNetwork**: `boolean`

Whether to monitor network stats

#### Defined in

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

---

### batchSize

• `Optional` **batchSize**: `number`

Batch size for remote reporting

#### Defined in

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

---

### flushInterval

• `Optional` **flushInterval**: `number`

Flush interval for batched reporting in milliseconds

#### Defined in

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

---

### aggregateStats

• `Optional` **aggregateStats**: `boolean`

Whether to aggregate statistics

#### Defined in

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

---

### aggregationInterval

• `Optional` **aggregationInterval**: `number`

Aggregation interval in milliseconds

#### Defined in

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

---

### performanceThreshold

• `Optional` **performanceThreshold**: `number`

Performance threshold in milliseconds to log warnings

#### Defined in

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