{"id":9522,"date":"2022-06-21T09:11:26","date_gmt":"2022-06-21T09:11:26","guid":{"rendered":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/documentation\/device_management\/telemetry_2\/telemetry_2-0_report_profiles\/parameter_types\/parameter_types_event\/"},"modified":"2025-03-25T05:18:32","modified_gmt":"2025-03-25T05:18:32","slug":"parameter_types_event","status":"publish","type":"page","link":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/parameter_types\/parameter_types_event\/","title":{"rendered":"Parameter Types: event"},"content":{"rendered":"\n
\n
\n
\n
\n

“event” Parameter Properties<\/h2>

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

Example<\/h3>
\n
{ \n   \"type\": \"event\",\n   \"name\": \"XH_RSSI_1_split\",\n   \"eventName\": \"xh_rssi_3_split\",\n   \"component\": \"ccsp-wifi-agent\",\n   \"use\": \"absolute\",\n   \"reportEmpty\": \"true\"\n }<\/pre>\n<\/div><\/div><\/div>\n<\/div>\n
\n
\n
On this page:<\/strong><\/u><\/p>
 <\/div><\/div>\n<\/div>\n<\/div>\n
\n
\n
\n
Available Properties<\/h3>
 <\/colgroup>
Property<\/p><\/th>
Type<\/p><\/th>
Required<\/p><\/th><\/tr><\/thead>
type<\/a><\/td>string<\/code><\/td>Required<\/td><\/tr>
name<\/a><\/td>string<\/code><\/td>Optional<\/td><\/tr>
eventName<\/a><\/td>string<\/code><\/td>Required<\/td><\/tr>
component<\/a><\/td>string<\/code><\/td>Required<\/td><\/tr>
use<\/a><\/td>string<\/code><\/td>Optional<\/td><\/tr>
reportEmpty<\/a><\/td>boolean<\/code><\/td>Optional<\/td><\/tr><\/tbody><\/table><\/div><\/div>\n<\/div>\n<\/div>\n
\n
\n
\n
type<\/h3>
Defines an event parameter.<\/p>
type<\/code><\/p>
  • is required<\/li>
  • Type: <\/span>string<\/code><\/li><\/ul>
    type Constraints<\/h3>
    constant<\/strong>: the value of this property must be equal to:<\/p>
    \"event\"\n<\/code><\/pre>

    <\/p><\/div>\n<\/div>\n<\/div>\n
    \n
    \n
    \n
    name<\/h3>
    Optional: The key name to be used for this data in the generated report.<\/p>
    name<\/code><\/p>
    • is optional<\/li>
    • Type: <\/span>string<\/code><\/li><\/ul>

      <\/p><\/div>\n<\/div>\n<\/div>\n
      \n
      \n
      \n
      eventName<\/h3>
      The event name by which the component will report this data to Telemetry 2<\/p>
      eventName<\/code><\/p>
      • is required<\/li>
      • Type: <\/span>string<\/code><\/li>
      • cannot be null<\/li><\/ul>

        <\/p><\/div>\n<\/div>\n<\/div>\n
        \n
        \n
        \n
        component<\/h3>
        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.<\/p>
        component<\/code><\/p>
        • is required<\/li>
        • Type: <\/span>string<\/code><\/li><\/ul>

          <\/p><\/div>\n<\/div>\n<\/div>\n
          \n
          \n
          \n
          use<\/h3>
          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. <\/span>NOTE:<\/strong> <\/span>“csv” is not currently supported in Telemetry 2.0.<\/p>
          use<\/code><\/p>
          • is optional<\/li>
          • Type: <\/span>string<\/code><\/li><\/ul>
            use Constraints<\/h3>
            enum<\/strong>: the value of this property must be equal to one of the following values:<\/p>
             <\/colgroup>
            Value<\/p><\/th>
            Explanation<\/p><\/th><\/tr><\/thead>
            \"count\"<\/code><\/td>Indicates that the value to report for this parameter is the number of times it has occurred during the reporting interval.<\/td><\/tr>
            \"absolute\"<\/code><\/td>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.<\/td><\/tr>
            \"csv\"<\/code><\/td>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. <\/span>NOTE:<\/strong> <\/span>“csv” is not currently supported in Telemetry 2.0.<\/td><\/tr><\/tbody><\/table><\/div>
            use Default Value<\/h3>
            The default value is:<\/p>
            \"absolute\"\n<\/code><\/pre>

            <\/p><\/div>\n<\/div>\n<\/div>\n
            \n
            \n
            \n
            reportEmpty<\/h3>
            Should this marker name be included in the generated report even if the search string was not found in the log file?<\/p>
            reportEmpty<\/code><\/p>
            • is optional<\/li>
            • Type: <\/span>boolean<\/code><\/li><\/ul>
              reportEmpty Default Value<\/h3>
              The default value is:<\/p>
              \"false\"

              <\/code><\/pre><\/div>\n<\/div>\n<\/div>\n<\/div><\/body><\/html>\n","protected":false},"excerpt":{"rendered":"
              “event” Parameter Properties Defines an event parameter. This data comes from a component that has […]<\/p>\n","protected":false},"author":28,"featured_media":0,"parent":9518,"menu_order":1,"comment_status":"open","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-9522","page","type-page","status-publish","hentry"],"yoast_head":"\nParameter Types: event - RDK Documentation Portal | Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/parameter_types\/parameter_types_event\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Parameter Types: event - RDK Documentation Portal | Documentation\" \/>\n<meta property=\"og:description\" content=\"“event” Parameter Properties Defines an event parameter. This data comes from a component that has […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/parameter_types\/parameter_types_event\/\" \/>\n<meta property=\"og:site_name\" content=\"RDK Documentation Portal | Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-03-25T05:18:32+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/parameter_types\/parameter_types_event\/\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/parameter_types\/parameter_types_event\/\",\"name\":\"Parameter Types: event - RDK Documentation Portal | Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\"},\"datePublished\":\"2022-06-21T09:11:26+00:00\",\"dateModified\":\"2025-03-25T05:18:32+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/parameter_types\/parameter_types_event\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/parameter_types\/parameter_types_event\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/parameter_types\/parameter_types_event\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Device Management\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Xconf\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Telemetry 2.0\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/\"},{\"@type\":\"ListItem\",\"position\":6,\"name\":\"Telemetry 2.0: Report Profiles\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/\"},{\"@type\":\"ListItem\",\"position\":7,\"name\":\"Parameter Types\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/parameter_types\/\"},{\"@type\":\"ListItem\",\"position\":8,\"name\":\"Parameter Types: event\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/\",\"name\":\"RDK Documentation Portal | Documentation\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Parameter Types: event - RDK Documentation Portal | Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/parameter_types\/parameter_types_event\/","og_locale":"en_US","og_type":"article","og_title":"Parameter Types: event - RDK Documentation Portal | Documentation","og_description":"“event” Parameter Properties Defines an event parameter. This data comes from a component that has […]","og_url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/parameter_types\/parameter_types_event\/","og_site_name":"RDK Documentation Portal | Documentation","article_modified_time":"2025-03-25T05:18:32+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/parameter_types\/parameter_types_event\/","url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/parameter_types\/parameter_types_event\/","name":"Parameter Types: event - RDK Documentation Portal | Documentation","isPartOf":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website"},"datePublished":"2022-06-21T09:11:26+00:00","dateModified":"2025-03-25T05:18:32+00:00","breadcrumb":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/parameter_types\/parameter_types_event\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/parameter_types\/parameter_types_event\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/parameter_types\/parameter_types_event\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":2,"name":"Documentation","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":3,"name":"Device Management","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/"},{"@type":"ListItem","position":4,"name":"Xconf","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/"},{"@type":"ListItem","position":5,"name":"Telemetry 2.0","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/"},{"@type":"ListItem","position":6,"name":"Telemetry 2.0: Report Profiles","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/"},{"@type":"ListItem","position":7,"name":"Parameter Types","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/device_management\/xconf\/telemetry_2-0\/telemetry_2-0_report_profiles\/parameter_types\/"},{"@type":"ListItem","position":8,"name":"Parameter Types: event"}]},{"@type":"WebSite","@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website","url":"https:\/\/developer.rdkcentral.com\/documentation\/","name":"RDK Documentation Portal | Documentation","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9522","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/users\/28"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/comments?post=9522"}],"version-history":[{"count":2,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9522\/revisions"}],"predecessor-version":[{"id":9545,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9522\/revisions\/9545"}],"up":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9518"}],"wp:attachment":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/media?parent=9522"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}