The Telemetry class lets an application profile Haxe code and register handlers for commands
Static variables
Static methods
staticregisterCommandHandler(commandName:String, handler:Dynamic):Bool
Register a function that can be called by issuing a command over a socket
Returns true if the registration is successful. If registration fails, there is
already a handler registered for the command used (or the command name starts with
'.', which is reserved for player internal use) Already registered handlers may be
unregistered using unregisterCommandHandler before registering another handler.
The handler function's return value is sent as the result of the command
(tlm-response.result). The handler function can throw Error, if it wants to send
an error response. In this case, Error.message and Error.id are sent as
tlm-response.tlm-error.message and tlm-response.tlm-error.code, respectively.
(tlm-response.result and tlm-response.tlm-error.data are sent as null)
@returns
Parameters:
commandName | String specifying a unique name (The command over the socket should specify this string as the method name). The guideline is to follow reverse DNS notation, which helps to avoid namespace collisions. Additionally, and names starting with . are reserved for native use. |
|---|---|
handler | Function to be called when a command is received by Telemetry over
the socket with the method name, as specified in |
staticsendMetric(metric:String, value:Dynamic):Void
Requests a custom metric from Telemetry. The metric name and object are sent as per the Telemetry protocol format.
The guideline for custom metric namespaces is to follow reverse DNS notation, which helps to avoid namespace collisions.
Parameters:
metric | Metric name |
|---|---|
value | Any primitive value/object containing the metric details |
Throws:
ArgumentError | If metric uses reserved namespaces like flash native namespace (for example, if the metric name starts with '.') |
|---|
staticsendSpanMetric(metric:String, startSpanMarker:Float, ?value:Dynamic):Void
Requests a custom span metric from Telemetry
Use Telemetry.spanMarker to get a marker at the start of function to be profiled
and call Telemetry.sendSpanMetric at the end of function with the marker.
Telemetry sends the name, starting marker, and duration of the function plus the
optional value as per the Telemetry protocol.
The guideline for custom metric namespaces is to follow reverse DNS notation, which helps to avoid namespace collisions.
Span metrics for durations less than a specified threshold, which could be controlled from the Telemetry Server using Telemetry Protocol, would be ignored by Telemetry (will not be sent to Telemetry Server).
Parameters:
metric | Metric name |
|---|---|
startSpanMarker | Start marker. |
value | Optional parameter. Any primitive value/object to be sent along with name, marker and duration |
Throws:
ArgumentError | If metric uses reserved namespaces like flash native namespace (i.e. if metric name starts with '.') |
|---|