---
title: "MetricMonitor"
description: "API documentation for MetricMonitor"
url: https://developer.disguise.one/python-api/docs/metricmonitor/
---

# MetricMonitor

Base class (inherits properties and methods): _[Resource](/python-api/docs/resource#resource)_

Subclasses: _[AutoFilter3Monitor](/python-api/docs/autofilter3monitor#autofilter3monitor)_, _[BatteryMonitor](/python-api/docs/batterymonitor#batterymonitor)_, _[CPUMonitor](/python-api/docs/cpumonitor#cpumonitor)_, _[DiskMonitor](/python-api/docs/diskmonitor#diskmonitor)_, _[GPUMemoryMonitor](/python-api/docs/gpumemorymonitor#gpumemorymonitor)_, _[GPUProfilerMonitor](/python-api/docs/gpuprofilermonitor#gpuprofilermonitor)_, _[Kalman3Monitor](/python-api/docs/kalman3monitor#kalman3monitor)_, _[MachineMonitor](/python-api/docs/machinemonitor#machinemonitor)_, _[PciToCpuIOMonitor](/python-api/docs/pcitocpuiomonitor#pcitocpuiomonitor)_, _[ProcessMemoryMonitor](/python-api/docs/processmemorymonitor#processmemorymonitor)_, _[RemoteMonitor](/python-api/docs/remotemonitor#remotemonitor)_, _[SimpleGraph](/python-api/docs/simplegraph#simplegraph)_

## Properties

#### **expired** : _bool_

#### **name** : _str_

#### **pollInterval** : _float_

_UserName: Poll interval_

#### **pollUnits** : _int_

_Options: {0: ‘Frames’, 1: ‘Seconds’, 2: ‘Minutes’, 3: ‘Hours’}  
UserName: Poll units_

#### **title** : _str_ _(Read-Only)_

#### **xZoom** : _float_

_UserName: Zoom_

## Methods

#### **addSample**(self, idx: _int_, sample: _float_)

#### **addSeries**(self, title: _str_, bufferSize: _int_, colour: _[Colour](/python-api/docs/colour#colour) | [Col](/python-api/docs/col#col) | [HDRColour](/python-api/docs/hdrcolour#hdrcolour)_, mode: _[MetricSamplingMode](/python-api/docs/metricsamplingmode#metricsamplingmode)_) -> _int_

#### **clearData**(self)

#### **dumpDataToDisk**(self, folder: _str_)

#### **graphDescriptor**(self, returnSnapshotIfPaused: _bool_) -> _[GraphDescriptor](/python-api/docs/graphdescriptor#graphdescriptor)_

#### **nSeries**(self) -> _int_

#### **paused**(self) -> _bool_

#### **seriesAverage**(self, title: _str_, nSamples: _int_) -> _float_

#### **seriesAverageByIndex**(self, idx: _int_, nSamples: _int_) -> _float_

## Static Methods

#### **togglePause**()