hytopia 0.7.4 → 0.7.5

package/docs/server.md

@@ -445,6 +445,17 @@ A simple entity controller with basic movement functions.
 Represents the physics simulation for a world.
 
 
+</td></tr>
+<tr><td>
+
+[Telemetry](./server.telemetry.md)
+
+
+</td><td>
+
+Manages performance telemetry and error tracking through your Sentry.io account.
+
+
 </td></tr>
 <tr><td>
 
@@ -794,6 +805,17 @@ Event types a SceneUI instance can emit. See [SceneUIEventPayloads](./server.sce
 Event types a Simulation instance can emit. See [SimulationEventPayloads](./server.simulationeventpayloads.md) for the payloads.
 
 
+</td></tr>
+<tr><td>
+
+[TelemetrySpanOperation](./server.telemetryspanoperation.md)
+
+
+</td><td>
+
+Performance telemetry span operation types.
+
+
 </td></tr>
 <tr><td>
 
@@ -1899,6 +1921,17 @@ Additional mass properties for a RigidBody.
 The options for a rigid body.
 
 
+</td></tr>
+<tr><td>
+
+[TelemetrySpanOptions](./server.telemetryspanoptions.md)
+
+
+</td><td>
+
+Options for creating a telemetry span.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.telemetry.getprocessstats.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Telemetry](./server.telemetry.md) &gt; [getProcessStats](./server.telemetry.getprocessstats.md)
+
+## Telemetry.getProcessStats() method
+
+Gets current Node.js process memory and performance statistics.
+
+**Signature:**
+
+```typescript
+static getProcessStats(asMeasurement?: boolean): Record<string, any>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+asMeasurement
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether to return data in Sentry measurement format with units.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Record&lt;string, any&gt;
+
+Process statistics including heap usage, RSS memory, and capacity metrics.
+

package/docs/server.telemetry.initializesentry.md

@@ -0,0 +1,73 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Telemetry](./server.telemetry.md) &gt; [initializeSentry](./server.telemetry.initializesentry.md)
+
+## Telemetry.initializeSentry() method
+
+Initializes Sentry telemetry with the provided DSN.
+
+**Signature:**
+
+```typescript
+static initializeSentry(sentryDsn: string, tickTimeMsThreshold?: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+sentryDsn
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The Sentry Data Source Name (DSN) for your project.
+
+
+</td></tr>
+<tr><td>
+
+tickTimeMsThreshold
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The tick duration that must be exceeded to send a performance span to Sentry for a given tick. Defaults to 50ms.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+
+## Remarks
+
+This method configures Sentry for error tracking and performance monitoring. It sets up filtering to only send performance spans that exceed the provided threshold duration, reducing noise and costs. The initialization includes game-specific tags and process statistics attachment.
+

package/docs/server.telemetry.md

@@ -0,0 +1,125 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Telemetry](./server.telemetry.md)
+
+## Telemetry class
+
+Manages performance telemetry and error tracking through your Sentry.io account.
+
+**Signature:**
+
+```typescript
+export default class Telemetry 
+```
+
+## Remarks
+
+The Telemetry class provides low-overhead performance monitoring and error tracking through Sentry (https://sentry.io) integration and your provided Sentry DSN. It automatically tracks critical game loop operations like physics simulation, entity updates, network synchronization, and more. The system only sends telemetry data when errors or slow-tick performance issues are detected, minimizing bandwidth and storage costs.
+
+## Example
+
+
+```typescript
+// Initialize Sentry for production telemetry
+Telemetry.initializeSentry('MY_SENTRY_PROJECT_DSN');
+
+// Wrap performance-critical code in spans
+Telemetry.startSpan({
+  operation: TelemetrySpanOperation.CUSTOM_OPERATION,
+  attributes: { // any arbitrary attributes you want to attach to the span
+    playerCount: world.playerManager.connectedPlayers.length,
+    entityCount: world.entityManager.entityCount,
+  },
+}, () => {
+  // Your performance-critical code here
+  performExpensiveOperation();
+});
+
+// Get current process statistics
+const stats = Telemetry.getProcessStats();
+console.log(`Heap usage: ${stats.jsHeapUsagePercent * 100}%`);
+```
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getProcessStats(asMeasurement)](./server.telemetry.getprocessstats.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Gets current Node.js process memory and performance statistics.
+
+
+</td></tr>
+<tr><td>
+
+[initializeSentry(sentryDsn, tickTimeMsThreshold)](./server.telemetry.initializesentry.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Initializes Sentry telemetry with the provided DSN.
+
+
+</td></tr>
+<tr><td>
+
+[sentry()](./server.telemetry.sentry.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Gets the Sentry SDK instance for advanced telemetry operations.
+
+
+</td></tr>
+<tr><td>
+
+[startSpan(options, callback)](./server.telemetry.startspan.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Executes a callback function within a performance monitoring span.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.telemetry.sentry.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Telemetry](./server.telemetry.md) &gt; [sentry](./server.telemetry.sentry.md)
+
+## Telemetry.sentry() method
+
+Gets the Sentry SDK instance for advanced telemetry operations.
+
+**Signature:**
+
+```typescript
+static sentry(): typeof Sentry;
+```
+**Returns:**
+
+typeof Sentry
+
+The Sentry SDK instance.
+
+## Remarks
+
+This method provides direct access to the Sentry SDK for operations not covered by the Telemetry wrapper, such as custom error reporting, user context setting, or advanced span manipulation.
+

package/docs/server.telemetry.startspan.md

@@ -0,0 +1,90 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Telemetry](./server.telemetry.md) &gt; [startSpan](./server.telemetry.startspan.md)
+
+## Telemetry.startSpan() method
+
+Executes a callback function within a performance monitoring span.
+
+**Signature:**
+
+```typescript
+static startSpan<T>(options: TelemetrySpanOptions, callback: (span?: Sentry.Span) => T): T;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[TelemetrySpanOptions](./server.telemetryspanoptions.md)
+
+
+</td><td>
+
+Configuration for the telemetry span including operation type and attributes.
+
+
+</td></tr>
+<tr><td>
+
+callback
+
+
+</td><td>
+
+(span?: Sentry.Span) =&gt; T
+
+
+</td><td>
+
+The function to execute within the performance span.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+T
+
+The return value of the callback function.
+
+## Remarks
+
+This method provides zero-overhead performance monitoring in development environments. In production with Sentry enabled and `SENTRY_ENABLE_TRACING=true`<!-- -->, it creates performance spans for monitoring. The span data is only transmitted to Sentry when performance issues are detected.
+
+## Example
+
+
+```typescript
+const result = Telemetry.startSpan({
+  operation: TelemetrySpanOperation.ENTITIES_TICK,
+  attributes: {
+    entityCount: entities.length,
+    worldId: world.id,
+  },
+}, () => {
+  return processEntities(entities);
+});
+```
+

package/docs/server.telemetryspanoperation.md

@@ -0,0 +1,257 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [TelemetrySpanOperation](./server.telemetryspanoperation.md)
+
+## TelemetrySpanOperation enum
+
+Performance telemetry span operation types.
+
+**Signature:**
+
+```typescript
+export declare enum TelemetrySpanOperation 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+BUILD\_PACKETS
+
+
+</td><td>
+
+`"build_packets"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+ENTITIES\_EMIT\_UPDATES
+
+
+</td><td>
+
+`"entities_emit_updates"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+ENTITIES\_TICK
+
+
+</td><td>
+
+`"entities_tick"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+NETWORK\_SYNCHRONIZE
+
+
+</td><td>
+
+`"network_synchronize"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+NETWORK\_SYNCHRONIZE\_CLEANUP
+
+
+</td><td>
+
+`"network_synchronize_cleanup"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+PHYSICS\_CLEANUP
+
+
+</td><td>
+
+`"physics_cleanup"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+PHYSICS\_STEP
+
+
+</td><td>
+
+`"physics_step"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+RELEASE\_TICK\_ALLOCATION
+
+
+</td><td>
+
+`"release_tick_allocation"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SEND\_ALL\_PACKETS
+
+
+</td><td>
+
+`"send_all_packets"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SEND\_PACKETS
+
+
+</td><td>
+
+`"send_packets"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SERIALIZE\_FREE\_BUFFERS
+
+
+</td><td>
+
+`"serialize_free_buffers"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SERIALIZE\_PACKETS
+
+
+</td><td>
+
+`"serialize_packets"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SERIALIZE\_PACKETS\_ENCODE
+
+
+</td><td>
+
+`"serialize_packets_encode"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SIMULATION\_STEP
+
+
+</td><td>
+
+`"simulation_step"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+TICKER\_TICK
+
+
+</td><td>
+
+`"ticker_tick"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+WORLD\_TICK
+
+
+</td><td>
+
+`"world_tick"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.telemetryspanoptions.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [TelemetrySpanOptions](./server.telemetryspanoptions.md)
+
+## TelemetrySpanOptions type
+
+Options for creating a telemetry span.
+
+**Signature:**
+
+```typescript
+export type TelemetrySpanOptions = {
+    operation: TelemetrySpanOperation | string;
+    attributes?: Record<string, string | number>;
+};
+```
+**References:** [TelemetrySpanOperation](./server.telemetryspanoperation.md)
+