en-US/about_DRMMThrottleStatus.help.txt
|
TOPIC
about_DRMMThrottleStatus SHORT DESCRIPTION Represents the combined throttle and rate-limit status for a DRMM account, merging API-reported data with local tracking state. LONG DESCRIPTION The DRMMThrottleStatus class provides a detailed snapshot of the current API rate-limit state, combining fresh data from the Datto RMM rate-status endpoint with the local sliding-window throttle model. It includes the active throttle profile, read and write utilisation (tracked independently), throttle and pause flags, current computed delays for each track, calibration metadata, configured thresholds, the rolling window size, and a collection of DRMMThrottleBucket objects representing every tracked bucket (read, write, and per-operation). This class is designed for monitoring, diagnostics, and long-running load test analysis, providing the complete throttle picture before any drift adjustment is applied. The Datto RMM API tracks reads and writes as independent quotas: - accountCount / accountRateLimit → read (GET) operations only - accountWriteCount / accountWriteRateLimit → write (PUT/POST/DELETE) operations only This class inherits from DRMMObject. ## PROPERTIES The DRMMThrottleStatus class exposes the following properties: Property Type Description ----------------------------- -------------------- ---------------------------------------- Profile string The name of the active throttle profi... AccountUid string The unique identifier (UID) of the ac... WindowSizeSeconds int The rolling window size in seconds fo... ReadUtilisation double The global read utilisation ratio (0.... WriteUtilisation double The global write utilisation ratio (0... AccountCutOffRatio double The account cut-off ratio from the AP... ThrottleUtilisationThreshold double The configured utilisation threshold ... PauseThreshold double The computed utilisation threshold at... Throttle bool Boolean indicating whether soft throt... Pause bool Boolean indicating whether hard pause... ReadDelayMs double The current computed delay in millise... WriteDelayMs double The current computed delay in millise... DelayMultiplier double The configured multiplier (e.g., 500)... ReadLastCalibrationUtc Nullable[datetime] The UTC datetime of the last read-tra... WriteLastCalibrationUtc Nullable[datetime] The UTC datetime of the last write-tr... ReadSamplesAtLastCalibration int The number of local read request samp... WriteSamplesAtLastCalibration int The number of local write request sam... Buckets DRMMThrottleBucket[] A collection of DRMMThrottleBucket ob... ## METHODS The DRMMThrottleStatus class provides the following methods: ### GetSummary() Generates a summary string for the throttle status, including key utilisation metrics and flags. **Returns:** `string` - Returns string ## NOTES This class is defined in the DattoRMM.Core module's class system. SEE ALSO Online Documentation https://github.com/TheShadowTek/DattoRMM.Core/blob/main/docs/about/classes/DRMMThrottleStatus/about_DRMMThrottleStatus.md |