Mirror Plugin
and a remote telemetry system called the Mirror
. The Mirror Plugin is a StackState plugin configured to talk to the Mirror. The plugin requires the Mirror to implement the Mirror REST API. In its turn, the Mirror acts as a gateway to the target telemetry system and is implemented as a webserver.connectionDetails
is mandatory and must be present in each request. The field contains arbitrary JSON configuration for connecting to the target system. This is a flexible configuration, and it is up to the Mirror implementor to decide what configuration elements are required. For example, a target telemetry source URL, timeouts, API key, and many others.AND
.key
is of type string, and it contains the name of the variable/field/label in the remote monitoring system. The value
is a JSON object that contains the actual value of one of three types: string, double or boolean.startTime
and endTime
, each holding a timestamp in epoch milliseconds indicating the query date range.X-MIRROR-API-KEY
and the StackState Mirror Plugin should compare it with the API key configured in the StackState server.FieldNamesRequest
request type contains a FieldNamesQuery
object. The query object contains conditions
, startTime
, endTime
, and limit
acting as a filter for the result field list. These parameters help the user to do continuous refinement of available field names during configuration of a telemetry stream.fieldName
- the name of the field.fieldType
- one of three STRING
, NUMBER
, BOOLEAN
classified
- indicates that special care need to be taken when logging or displaying the values of this field.CompleteValue
, and FieldValuePattern
. The CompleteValue
indicates that the value
field contains a full value token. The FieldValuePattern
specifies the partial value that can be used as a fieldValuePrefix
in subsequent refinement requests.aggregation
object in the query
field. Besides common fields, there is a metricField
which optionally indicates the source field for metric values.points
list contains several sublists each representing one data pointdataFormat
fieldisPartial
indicates if the response has been truncated either by application of the limit
field or by the telemetry store itself. In this case, the user should take action and execute another metric request specifying the last point timestamp as request
.query
.startTime
to retrieve truncated values.aggregation
field is not empty and holds the aggregation method
and aggregation bucket size bucketSizeMillis
. The aggregation is done using the batching windowing method. See the available aggregation methods.points
sublists contain startTimestamp
and endTimestamp
fields indicating aggregated bucket start and stop time. The positions are specified in the dataFormat
format field.RemoteMirrorError
.