Parameter Types: event

Created on June 21, 2022

“event” Parameter Properties

Defines an event parameter. This data comes from a component that has been instrumented to send its telemetry data via Telemetry 2 APIs.

Example

{ 
   "type": "event",
   "name": "XH_RSSI_1_split",
   "eventName": "xh_rssi_3_split",
   "component": "ccsp-wifi-agent",
   "use": "absolute",
   "reportEmpty": "true"
 }

On this page:

Available Properties


Property

Type

Required

typestringRequired
namestringOptional
eventNamestringRequired
componentstringRequired
usestringOptional
reportEmptybooleanOptional

type


Defines an event parameter.

type

  • is required
  • Type: string

type Constraints

constant: the value of this property must be equal to:

"event"


name


Optional: The key name to be used for this data in the generated report.

name

  • is optional
  • Type: string


eventName


The event name by which the component will report this data to Telemetry 2

eventName

  • is required
  • Type: string
  • cannot be null


component


The name of the component from which this data should be expected. Telemetry 2 will use this name to register its interest with the component.

component

  • is required
  • Type: string


use


This property indicates how the data for this parameter should be gathered and reported.
•  “count”: Indicates that the value to report for this parameter is the number of times it has occurred during the reporting interval..
•  “absolute”: Indicates that the value to report for this parameter is the last actual value received, in the case of events, or found in the log file, in the case of greps.
•  “csv”: Indicates that the value to report for this parameter is a comma separated list of all the actual values received, in the case of events, or found in the log file, in the case of greps. NOTE: “csv” is not currently supported in Telemetry 2.0.

use

  • is optional
  • Type: string

use Constraints

enum: the value of this property must be equal to one of the following values:

Value

Explanation

"count"Indicates that the value to report for this parameter is the number of times it has occurred during the reporting interval.
"absolute"Indicates that the value to report for this parameter is the last actual value received, in the case of events, or found in the log file, in the case of greps.
"csv"Indicates that the value to report for this parameter is a comma separated list of all the actual values received, in the case of events, or found in the log file, in the case of greps. NOTE: “csv” is not currently supported in Telemetry 2.0.

use Default Value

The default value is:

"absolute"


reportEmpty


Should this marker name be included in the generated report even if the search string was not found in the log file?

reportEmpty

  • is optional
  • Type: boolean

reportEmpty Default Value

The default value is:

"false"

Go To Top