Files
UnrealEngineUWP/Engine/Source/Programs/Horde/Docs/Config/Analytics.md
ben marsh ee57bc3ab7 Horde: Documentation updates.
[CL 31171810 by ben marsh in ue5-main branch]
2024-02-05 09:21:43 -05:00

1.6 KiB

Horde > Configuration > Analytics

Analytics

Horde implements HTTP endpoints to allow collecting telemetry data sent by the Unreal Editor. This data can provide insights into bottlenecks and workflow issues that a team, and the Horde dashboard can aggregate and chart it to highlight improvements and regressions over time.

Configuring the Editor

To configure the editor to send analytics data to Horde, add the following lines to the {{ PROJECT_DIR }}/Config/DefaultEngine.ini file, and submit it to source control.

[StudioTelemetry.Horde]
Name=HordeStudioAnalytics
ProviderType=FAnalyticsProviderET
UsageType=EditorAndClient
APIKeyET=HordeAnalytics.Dev
APIServerET="{{ HORDE_SERVER_URL }}"
APIEndpointET="api/v1/telemetry"

Telemetry Sinks

Horde can both collect telemetry data in its own database, and forward it on to other telemetry sinks.

Telemetry sinks can be configured through the Telemetry property in the server's Server.json file.

Metrics and Aggregation

To allow efficient aggregation of analytics data over large time periods, Horde aggregates telemetry events into running metrics for each time interval. This aggregation is performed according to rules specified in the Telemetry.Metrics section of the globals.json file (see MetricConfig).

Charting

The Horde dashboard can render charts showing aggregated metrics collected on the server. These views are configured using the Dashboard.Analytics section of the globals.json file (see TelemetryViewConfig).