Stats
Performance metrics for a game.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
| Memory category | Instances |
|---|
Member index 27
Removed member index 7
| History | Member | |
|---|---|---|
| 310 | MinReportInterval: double | |
| 310 | ReporterType: string | |
| 325 | GetTotalUsedMemory(): float | |
| 310 | Report(category: string, data: Dictionary): void | |
| 310 | ReportJobsStepWindow(): void | |
| 310 | ReportTaskScheduler(includeJobs: bool = false): void | |
| 310 | SetReportUrl(url: string): void |
Description
Stats is a service that provides real-time performance information about the current running game instance. Its primary purpose is to provide developers with an end point to measure where resources are being consumed, as well as how much memory is being consumed overall.
The service also stores a tree of StatsItem, which can have their values read by plugins.
History 80
- 649 Add UI3DTriangleCount
- 649 Add UI3DDrawcallCount
- 649 Add UI2DTriangleCount
- 649 Add UI2DDrawcallCount
- 649 Add ShadowsTriangleCount
- 649 Add ShadowsDrawcallCount
- 649 Add SceneTriangleCount
- 649 Add SceneDrawcallCount
- 649 Add RenderGPUFrameTime
- 649 Add RenderCPUFrameTime
- 649 Change Tags of PhysicsStepTimeMs from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
- 649 Add PhysicsStepTime
- 649 Change Tags of HeartbeatTimeMs from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
- 649 Add HeartbeatTime
- 649 Add FrameTime
- 553 Change Default of PrimitivesCount from to
- 553 Change Default of PhysicsStepTimeMs from to
- 553 Change Default of PhysicsSendKbps from to
- 553 Change Default of PhysicsReceiveKbps from to
- 553 Change Default of MovingPrimitivesCount from to
- 553 Change Default of InstanceCount from to
- 553 Change Default of HeartbeatTimeMs from to
- 553 Change Default of DataSendKbps from to
- 553 Change Default of DataReceiveKbps from to
- 553 Change Default of ContactsCount from to
- 486 Change ThreadSafety of PrimitivesCount from ReadOnly to ReadSafe
- 486 Change ThreadSafety of PhysicsStepTimeMs from ReadOnly to ReadSafe
- 486 Change ThreadSafety of PhysicsSendKbps from ReadOnly to ReadSafe
- 486 Change ThreadSafety of PhysicsReceiveKbps from ReadOnly to ReadSafe
- 486 Change ThreadSafety of MovingPrimitivesCount from ReadOnly to ReadSafe
- 486 Change ThreadSafety of InstanceCount from ReadOnly to ReadSafe
- 486 Change ThreadSafety of HeartbeatTimeMs from ReadOnly to ReadSafe
- 486 Change ThreadSafety of DataSendKbps from ReadOnly to ReadSafe
- 486 Change ThreadSafety of DataReceiveKbps from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ContactsCount from ReadOnly to ReadSafe
- 462 Change ThreadSafety of GetTotalMemoryUsageMb from to Unsafe
- 462 Change ThreadSafety of GetPaginatedMemoryByTexture from to Unsafe
- 462 Change ThreadSafety of GetMemoryUsageMbForTag from to Unsafe
- 462 Change ThreadSafety of GetBrowserTrackerId from to Unsafe
- 462 Change ThreadSafety of PrimitivesCount from to ReadOnly
- 462 Change ThreadSafety of PhysicsStepTimeMs from to ReadOnly
- 462 Change ThreadSafety of PhysicsSendKbps from to ReadOnly
- 462 Change ThreadSafety of PhysicsReceiveKbps from to ReadOnly
- 462 Change ThreadSafety of MovingPrimitivesCount from to ReadOnly
- 462 Change ThreadSafety of InstanceCount from to ReadOnly
- 462 Change ThreadSafety of HeartbeatTimeMs from to ReadOnly
- 462 Change ThreadSafety of DataSendKbps from to ReadOnly
- 462 Change ThreadSafety of DataReceiveKbps from to ReadOnly
- 462 Change ThreadSafety of ContactsCount from to ReadOnly
- 385 Add GetBrowserTrackerId
- 325 Remove GetTotalUsedMemory
- 325 Add GetTotalMemoryUsageMb
- 323 Add GetTotalUsedMemory
- 310 Remove SetReportUrl
- 310 Remove ReportTaskScheduler
- 310 Remove ReportJobsStepWindow
- 310 Remove Report
- 310 Remove ReporterType
- 310 Remove MinReportInterval
- 305 Add GetMemoryUsageMbForTag
- 305 Add PrimitivesCount
- 305 Add PhysicsStepTimeMs
- 305 Add PhysicsSendKbps
- 305 Add PhysicsReceiveKbps
- 305 Add MovingPrimitivesCount
- 305 Add InstanceCount
- 305 Add HeartbeatTimeMs
- 305 Add DataSendKbps
- 305 Add DataReceiveKbps
- 305 Add ContactsCount
- 281 Change Tags of GetPaginatedMemoryByTexture from [] to [Yields]
- 281 Change Parameters of GetPaginatedMemoryByTexture from (pageIndex: int, pageSize: int) to (queryType: TextureQueryType, pageIndex: int, pageSize: int)
- 280 Add GetPaginatedMemoryByTexture
- 49 Add ReportJobsStepWindow
- 48 Add SetReportUrl
- 48 Add ReportTaskScheduler
- 48 Add Report
- 48 Add ReporterType
- 48 Add MinReportInterval
- 47 Add Stats
Members 27
ContactsCount
| Type | Default | |
|---|---|---|
| int | ||
ContactsCount describes how many parts are currently in contact with each other, such that one of the two parts are being physically simulated, and thus can be recognized by the BasePart:GetTouchingParts() method.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 4
- 553 Change Default of ContactsCount from to
- 486 Change ThreadSafety of ContactsCount from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ContactsCount from to ReadOnly
- 305 Add ContactsCount
DataReceiveKbps
| Type | Default | |
|---|---|---|
| float | ||
In a networked game, DataReceiveKbps describes roughly how many kilobytes of data are being received by the current instance, per second. If from the server's perspective, this represents the total amount of data being received from the clients connected to the server.If from a client's perspective, this represents the total amount of data being received from the server.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 4
- 553 Change Default of DataReceiveKbps from to
- 486 Change ThreadSafety of DataReceiveKbps from ReadOnly to ReadSafe
- 462 Change ThreadSafety of DataReceiveKbps from to ReadOnly
- 305 Add DataReceiveKbps
DataSendKbps
| Type | Default | |
|---|---|---|
| float | ||
In a networked game, DataSendKbps describes roughly how many kilobytes of data are being sent by the current instance, per second. If from the server's perspective, this represents the total amount of data being sent to the clients connected to the server.If from a client's perspective, this represents the total amount of data being sent to the server.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 4
- 553 Change Default of DataSendKbps from to
- 486 Change ThreadSafety of DataSendKbps from ReadOnly to ReadSafe
- 462 Change ThreadSafety of DataSendKbps from to ReadOnly
- 305 Add DataSendKbps
FrameTime
| Type | Default | |
|---|---|---|
| float | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
GetBrowserTrackerId
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| string | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of GetBrowserTrackerId from to Unsafe
- 385 Add GetBrowserTrackerId
GetMemoryUsageMbForTag
| Parameters (1) | ||
|---|---|---|
| tag | DeveloperMemoryTag | |
| Returns (1) | ||
| float | ||
Returns the number of megabytes that are being consumed in the specified DeveloperMemoryTag category.
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetMemoryUsageMbForTag from to Unsafe
- 305 Add GetMemoryUsageMbForTag
GetPaginatedMemoryByTexture
| Parameters (3) | ||
|---|---|---|
| queryType | TextureQueryType | |
| pageIndex | int | |
| pageSize | int | |
| Returns (1) | ||
| Dictionary | ||
This function yields. It will block the calling thread until completion.
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 4
- 462 Change ThreadSafety of GetPaginatedMemoryByTexture from to Unsafe
- 281 Change Tags of GetPaginatedMemoryByTexture from [] to [Yields]
- 281 Change Parameters of GetPaginatedMemoryByTexture from (pageIndex: int, pageSize: int) to (queryType: TextureQueryType, pageIndex: int, pageSize: int)
- 280 Add GetPaginatedMemoryByTexture
GetTotalMemoryUsageMb
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| float | ||
Returns the total amount of memory being consumed by the current game session, in megabytes.
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetTotalMemoryUsageMb from to Unsafe
- 325 Add GetTotalMemoryUsageMb
HeartbeatTime
| Type | Default | |
|---|---|---|
| float | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 1
- 649 Add HeartbeatTime
HeartbeatTimeMs
| Type | Default | |
|---|---|---|
| float | ||
The HeartbeatTimeMs property is a measurement of the total amount of time it takes long it takes for Roblox to update all of its Task Scheduler jobs, in milliseconds. If this value is high, then it means one of the tasks are hogging up a lot of resources.
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 5
- 649 Change Tags of HeartbeatTimeMs from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
- 553 Change Default of HeartbeatTimeMs from to
- 486 Change ThreadSafety of HeartbeatTimeMs from ReadOnly to ReadSafe
- 462 Change ThreadSafety of HeartbeatTimeMs from to ReadOnly
- 305 Add HeartbeatTimeMs
InstanceCount
| Type | Default | |
|---|---|---|
| int | ||
InstanceCount is a read-only measurement of how many Instance are currently in memory. This includes the DataModel, its descendants, as well as any object created with Instance.new() which is still present in memory.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 4
- 553 Change Default of InstanceCount from to
- 486 Change ThreadSafety of InstanceCount from ReadOnly to ReadSafe
- 462 Change ThreadSafety of InstanceCount from to ReadOnly
- 305 Add InstanceCount
MovingPrimitivesCount
| Type | Default | |
|---|---|---|
| int | ||
A measurement of how many physically simulated components are currently moving in the game world.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 4
- 553 Change Default of MovingPrimitivesCount from to
- 486 Change ThreadSafety of MovingPrimitivesCount from ReadOnly to ReadSafe
- 462 Change ThreadSafety of MovingPrimitivesCount from to ReadOnly
- 305 Add MovingPrimitivesCount
PhysicsReceiveKbps
| Type | Default | |
|---|---|---|
| float | ||
PhysicsReceiveKbps is a measurement of roughly how many kilobytes of physics data are being received by the current instance, per second.If from the server's perspective, this represents the total amount of physics data being received from the clients connected to the server.If from a client's perspective, this represents the total amount of physics data being received from the server.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 4
- 553 Change Default of PhysicsReceiveKbps from to
- 486 Change ThreadSafety of PhysicsReceiveKbps from ReadOnly to ReadSafe
- 462 Change ThreadSafety of PhysicsReceiveKbps from to ReadOnly
- 305 Add PhysicsReceiveKbps
PhysicsSendKbps
| Type | Default | |
|---|---|---|
| float | ||
PhysicsSendKbps describes roughly how many kilobytes of physics data are being sent by the current instance, per second.If from the server's perspective, this represents the total amount of physics data being sent to the clients connected to the server.If from a client's perspective, this represents the total amount of physics data being sent to the server.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 4
- 553 Change Default of PhysicsSendKbps from to
- 486 Change ThreadSafety of PhysicsSendKbps from ReadOnly to ReadSafe
- 462 Change ThreadSafety of PhysicsSendKbps from to ReadOnly
- 305 Add PhysicsSendKbps
PhysicsStepTime
| Type | Default | |
|---|---|---|
| float | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 1
- 649 Add PhysicsStepTime
PhysicsStepTimeMs
| Type | Default | |
|---|---|---|
| float | ||
A measurement of how long it takes for the physics engine to update its current state, in milliseconds. If this value is high, then it means the game instance is under stress from the physics simulations taking place.
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 5
- 649 Change Tags of PhysicsStepTimeMs from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
- 553 Change Default of PhysicsStepTimeMs from to
- 486 Change ThreadSafety of PhysicsStepTimeMs from ReadOnly to ReadSafe
- 462 Change ThreadSafety of PhysicsStepTimeMs from to ReadOnly
- 305 Add PhysicsStepTimeMs
PrimitivesCount
| Type | Default | |
|---|---|---|
| int | ||
A measurement of how many physically simulated components currently exist in the game world.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 4
- 553 Change Default of PrimitivesCount from to
- 486 Change ThreadSafety of PrimitivesCount from ReadOnly to ReadSafe
- 462 Change ThreadSafety of PrimitivesCount from to ReadOnly
- 305 Add PrimitivesCount
RenderCPUFrameTime
| Type | Default | |
|---|---|---|
| float | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 1
RenderGPUFrameTime
| Type | Default | |
|---|---|---|
| float | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 1
SceneDrawcallCount
| Type | Default | |
|---|---|---|
| int | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 1
SceneTriangleCount
| Type | Default | |
|---|---|---|
| int | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 1
ShadowsDrawcallCount
| Type | Default | |
|---|---|---|
| int | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 1
ShadowsTriangleCount
| Type | Default | |
|---|---|---|
| int | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 1
UI2DDrawcallCount
| Type | Default | |
|---|---|---|
| int | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 1
- 649 Add UI2DDrawcallCount
UI2DTriangleCount
| Type | Default | |
|---|---|---|
| int | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 1
- 649 Add UI2DTriangleCount
UI3DDrawcallCount
| Type | Default | |
|---|---|---|
| int | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 1
- 649 Add UI3DDrawcallCount
UI3DTriangleCount
| Type | Default | |
|---|---|---|
| int | ||
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
History 1
- 649 Add UI3DTriangleCount
Removed members 7
GetTotalUsedMemory
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| float | ||
History 2
- 325 Remove GetTotalUsedMemory
- 323 Add GetTotalUsedMemory
MinReportInterval
| Type | Default | |
|---|---|---|
| double | ||
| Security | RobloxScriptSecurity |
|---|---|
| Category | |
| Loaded/Saved | false |
History 2
- 310 Remove MinReportInterval
- 48 Add MinReportInterval
Report
| Parameters (2) | ||
|---|---|---|
| category | string | |
| data | Dictionary | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
ReportJobsStepWindow
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 310 Remove ReportJobsStepWindow
- 49 Add ReportJobsStepWindow
ReportTaskScheduler
| Parameters (1) | Default | |
|---|---|---|
| includeJobs | bool | false |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 310 Remove ReportTaskScheduler
- 48 Add ReportTaskScheduler
ReporterType
| Type | Default | |
|---|---|---|
| string | ||
| Security | RobloxScriptSecurity |
|---|---|
| Category | |
| Loaded/Saved | false |
History 2
- 310 Remove ReporterType
- 48 Add ReporterType
SetReportUrl
| Parameters (1) | ||
|---|---|---|
| url | string | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 310 Remove SetReportUrl
- 48 Add SetReportUrl