tools/metrics/structured/structured.xml

<structured-metrics>

<project name="Hindsight">
  <owner>charleszhao@chromium.org</owner>
  <owner>tby@chromium.org</owner>
  <id>per-project</id>
  <summary>
    Project for recording CrOSActions.
  </summary>

  <event name="CrOSActionEvent.FileOpened">
    <summary>
      Records whenever a file is opened in the File App on ChromeOS.
    </summary>
    <metric name="Filename" type="hmac-string">
      <summary>
        The absolute path of the file.
      </summary>
    </metric>
    <metric name="OpenType" type="int">
      <summary>
        The type of file open, defined in FileTaskObserver::OpenType.
      </summary>
    </metric>
    <metric name="SequenceId" type="int">
      <summary>
        Sequence of this action across all CrOSActionEvent.
      </summary>
    </metric>
    <metric name="TimeSinceLastAction" type="int">
      <summary>
        Time in milliseconds since last CrOSActionLogging.
      </summary>
    </metric>
  </event>

  <event name="CrOSActionEvent.SearchResultLaunched">
    <summary>
      Records information about the launch of an item from ChromeOS launcher.
    </summary>
    <metric name="Query" type="hmac-string">
      <summary>
        The search query associated with this launch.
      </summary>
    </metric>
    <metric name="ResultType" type="int">
      <summary>
        Which type of search provider the launched result was created by.
      </summary>
    </metric>
    <metric name="SearchResultId" type="hmac-string">
      <summary>
        The ID of the launched result result. For example, the app ID for app
        results, or the URL for omnibox results.
      </summary>
    </metric>
    <metric name="SequenceId" type="int">
      <summary>
        Sequence of this action across all CrOSActionEvent.
      </summary>
    </metric>
    <metric name="TimeSinceLastAction" type="int">
      <summary>
        Time in milliseconds since last CrOSActionLogging.
      </summary>
    </metric>
  </event>

  <event name="CrOSActionEvent.SettingChanged">
    <summary>
      Records when a setting is changed; only records quick settings for now.
    </summary>
    <metric name="CurrentValue" type="int">
      <summary>
        Value of the setting after the change.
      </summary>
    </metric>
    <metric name="PreviousValue" type="int">
      <summary>
        Value of the setting before the change.
      </summary>
    </metric>
    <metric name="SequenceId" type="int">
      <summary>
        Sequence of this action across all CrOSActionEvent.
      </summary>
    </metric>
    <metric name="SettingId" type="int">
      <summary>
        The setting id (in ash::ml::UserSettingsEvent::Event::SettingId) that
        represents the type of the changed setting.
      </summary>
    </metric>
    <metric name="SettingType" type="int">
      <summary>
        Enum that represents where the settings event originated from (in
        ash::ml::UserSettingsEvent::Event::SettingType).
      </summary>
    </metric>
    <metric name="TimeSinceLastAction" type="int">
      <summary>
        Time in milliseconds since last CrOSActionLogging.
      </summary>
    </metric>
  </event>

  <event name="CrOSActionEvent.TabEvent.TabNavigated">
    <summary>
      Records a tab activity of navigating to a new url.
    </summary>
    <metric name="PageTransition" type="int">
      <summary>
        The types of transition between pages. See more on ui::PageTransition.
      </summary>
    </metric>
    <metric name="SequenceId" type="int">
      <summary>
        Sequence of this action across all CrOSActionEvent.
      </summary>
    </metric>
    <metric name="TimeSinceLastAction" type="int">
      <summary>
        Time in milliseconds since last CrOSActionLogging.
      </summary>
    </metric>
    <metric name="URL" type="hmac-string">
      <summary>
        The URL of the current event.
      </summary>
    </metric>
    <metric name="Visibility" type="int">
      <summary>
        The visibility of this url, see more on content::Visibility.
      </summary>
    </metric>
  </event>

  <event name="CrOSActionEvent.TabEvent.TabOpened">
    <summary>
      Records a tab activity of opening a new url with ctrl+click.
    </summary>
    <metric name="SequenceId" type="int">
      <summary>
        Sequence of this action across all CrOSActionEvent.
      </summary>
    </metric>
    <metric name="TimeSinceLastAction" type="int">
      <summary>
        Time in milliseconds since last CrOSActionLogging.
      </summary>
    </metric>
    <metric name="URL" type="hmac-string">
      <summary>
        The URL of the current event.
      </summary>
    </metric>
    <metric name="URLOpened" type="hmac-string">
      <summary>
        The URL that is opened from the current url.
      </summary>
    </metric>
    <metric name="WindowOpenDisposition" type="int">
      <summary>
        Enum that indicates where the new tab is opened, see more on
        WindowOpenDisposition.
      </summary>
    </metric>
  </event>

  <event name="CrOSActionEvent.TabEvent.TabReactivated">
    <summary>
      Records a tab activity of reactivating an existing tab.
    </summary>
    <metric name="SequenceId" type="int">
      <summary>
        Sequence of this action across all CrOSActionEvent.
      </summary>
    </metric>
    <metric name="TimeSinceLastAction" type="int">
      <summary>
        Time in milliseconds since last CrOSActionLogging.
      </summary>
    </metric>
    <metric name="URL" type="hmac-string">
      <summary>
        The URL of the current event.
      </summary>
    </metric>
  </event>
</project>

<project name="LauncherUsage">
  <owner>tby@chromium.org</owner>
  <id>per-project</id>
  <summary>
    See event summary.
  </summary>

  <event name="LauncherUsage">
    <summary>
      Records information about the launch of an item (such as an app or a file)
      from the ChromeOS launcher. One event is recorded for every launch
      originating from any launcher UI component, and this is the only
      circumstance that records events.
    </summary>
    <metric name="App" type="hmac-string">
      <summary>
        App ID of the most-recently-opened app when this launch occured. This can be
        an app ID of a Chrome app, Arc++ app, or PWA.
      </summary>
    </metric>
    <metric name="Domain" type="hmac-string">
      <summary>
        The most-recently-visited domain when this launch ocurred.
      </summary>
    </metric>
    <metric name="Hour" type="int">
      <summary>
        The hour of launch. This is the user's local time rounded to the nearest
        hour, 0 to 23 inclusive.
      </summary>
    </metric>
    <metric name="ProviderType" type="int">
      <summary>
        Which type of search provider the launched result was created by. This comes
        from the RankingItemType enum.
      </summary>
    </metric>
    <metric name="Score" type="int">
      <summary>
        The relevance score of the launched result. This is a double multiplied by
        1000 and cast to an int64. Results that don't have a score report 0.
      </summary>
    </metric>
    <metric name="SearchQuery" type="hmac-string">
      <summary>
        The search query associated with this launch. Before hashing, the query is
        the empty string if there was no search query.
      </summary>
    </metric>
    <metric name="SearchQueryLength" type="int">
      <summary>
        String length of the search query associated with this launch. If there was
        no query, this is zero.
      </summary>
    </metric>
    <metric name="Target" type="hmac-string">
      <summary>
        The target item of this launch, eg. an app ID, filepath, or omnibox URL.
      </summary>
    </metric>
  </event>
</project>

<project name="TestProjectOne">
  <owner>tby@chromium.org</owner>
  <id>none</id>
  <summary>
    Project for unit testing, do not use.
  </summary>

  <event name="TestEventOne">
    <summary>
      Event for unit testing, do not use.
    </summary>
    <metric name="TestMetricOne" type="hmac-string">
      <summary>
        A per-user keyed hashed value.
      </summary>
    </metric>
    <metric name="TestMetricTwo" type="int">
      <summary>
        An unhashed value, recorded as-is.
      </summary>
    </metric>
  </event>
</project>

<project name="TestProjectTwo">
  <owner>tby@chromium.org</owner>
  <id>none</id>
  <summary>
    Project for unit testing, do not use.
  </summary>

  <event name="TestEventThree">
    <summary>
      Event for unit testing, do not use.
    </summary>
    <metric name="TestMetricFour" type="hmac-string">
      <summary>
        A per-user keyed hashed value.
      </summary>
    </metric>
  </event>

  <event name="TestEventTwo">
    <summary>
      Event for unit testing, do not use.
    </summary>
    <metric name="TestMetricThree" type="hmac-string">
      <summary>
        A per-user keyed hashed value.
      </summary>
    </metric>
  </event>
</project>

<project name="TestProjectThree">
  <owner>tby@chromium.org</owner>
  <id>uma</id>
  <summary>
    Project for unit testing, do not use.
  </summary>

  <event name="TestEventFour">
    <summary>
      Event for unit testing, do not use.
    </summary>
    <metric name="TestMetricFour" type="int">
      <summary>
        An unhashed value, recorded as-is.
      </summary>
    </metric>
  </event>
</project>

</structured-metrics>