UnrealEngine/Engine/Source/Programs/Horde/Docs/Config/Schema/Telemetry.md

Horde > Configuration > *.telemetry.json

*.telemetry.json

Config for metrics

Name	Description
id	string Identifier for this store
acl	AclConfig Permissions for this store
metrics	MetricConfig[] Metrics to aggregate on the Horde server
views	TelemetryViewConfig[] Configuration for telemetry views
include	ConfigInclude[] Includes for other configuration files
macros	ConfigMacro[] Macros within this configuration

AclConfig

Parameters to update an ACL

Name	Description
entries	AclEntryConfig[] Entries to replace the existing ACL
profiles	AclProfileConfig[] Defines profiles which allow grouping sets of actions into named collections
inherit	boolean Whether to inherit permissions from the parent ACL
exceptions	string[] List of exceptions to the inherited setting

AclEntryConfig

Individual entry in an ACL

Name	Description
claim	AclClaimConfig Name of the user or group
actions	string[] Array of actions to allow
profiles	string[] List of profiles to grant

AclClaimConfig

New claim to create

Name	Description
type	string The claim type
value	string The claim value

AclProfileConfig

Configuration for an ACL profile. This defines a preset group of actions which can be given to a user via an ACL entry.

Name	Description
id	string Identifier for this profile
actions	string[] Actions to include
excludeActions	string[] Actions to exclude from the inherited actions
extends	string[] Other profiles to extend from

MetricConfig

Configures a metric to aggregate on the server

Name	Description
id	string Identifier for this metric
filter	string Filter expression to evaluate to determine which events to include. This query is evaluated against an array.
property	string Property to aggregate
groupBy	string Property to group by. Specified as a comma-separated list of JSON path expressions.
function	AggregationFunction How to aggregate samples for this metric
percentile	integer For the percentile function, specifies the percentile to measure
topN	integer TopN aggregation
bottomN	integer BottomN aggregation
interval	string Interval for each metric. Supports times such as "2d", "1h", "1h30m", "20s".

AggregationFunction (Enum)

Method for aggregating samples into a metric

Name	Description
Count	Count the number of matching elements
Min	Take the minimum value of all samples
Max	Take the maximum value of all samples
Sum	Sum all the reported values
Average	Average all the samples
Percentile	Estimates the value at a certain percentile

TelemetryViewConfig

A telemetry view of related metrics, divided into categofies

Name	Description
id	string Identifier for the view
name	string The name of the view
telemetryStoreId	string The telemetry store this view uses
variables	TelemetryVariableConfig[] The variables used to filter the view data
categories	TelemetryCategoryConfig[] The categories contained within the view

TelemetryVariableConfig

A telemetry view variable used for filtering the charting data

Name	Description
name	string The name of the variable for display purposes
group	string The associated data group attached to the variable
defaults	string[] The default values to select

TelemetryCategoryConfig

A chart categody, will be displayed on the dashbord under an associated pivot

Name	Description
name	string The name of the category
charts	TelemetryChartConfig[] The charts contained within the category

TelemetryChartConfig

Telemetry chart configuraton

Name	Description
name	string The name of the chart, will be displayed on the dashboard
display	TelemetryMetricUnitType The unit to display
graph	TelemetryMetricGraphType The graph type
metrics	TelemetryChartMetricConfig[] List of configured metrics
min	integer The min unit value for clamping chart
max	integer The max unit value for clamping chart

TelemetryMetricUnitType (Enum)

The units used to present the telemetry

Name	Description
Time	Time duration
Ratio	Ratio 0-100%
Value	Artbitrary numeric value

TelemetryMetricGraphType (Enum)

The type of

Name	Description
Line	A line graph
Indicator	Key performance indicator (KPI) chart with thrasholds

TelemetryChartMetricConfig

Metric attached to a telemetry chart

Name	Description
id	string Associated metric id
threshold	integer The threshold for KPI values
alias	string The metric alias for display purposes

ConfigInclude

Directive to merge config data from another source

Name	Description
path	string Path to the config data to be included. May be relative to the including file's location.

ConfigMacro

Declares a config macro

Name	Description
name	string Name of the macro property
value	string Value for the macro property