Ingen beskrivning
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Analytics.Api.Output.xml 9.4KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Analytics.Api.Output</name>
  5. </assembly>
  6. <members>
  7. <member name="P:Analytics.Api.Output.BuildAnalyticsCollectionEvent.message">
  8. <summary>
  9. Human readable message describing the error encountered while collecting the player build analytics.
  10. </summary>
  11. </member>
  12. <member name="P:Analytics.Api.Output.BuildAnalyticsCollectionEvent.code">
  13. <summary>
  14. Enum value for the error encountered while collecting the player build analytics.
  15. </summary>
  16. </member>
  17. <member name="T:Analytics.Api.Output.BuildAnalyticsCollectionInfo">
  18. <summary>
  19. Analytics data for the collection of player build analytics. This table records the performance and any errors encountered when running Analytics.exe after a Bee build.
  20. </summary>
  21. </member>
  22. <member name="P:Analytics.Api.Output.BuildAnalyticsCollectionInfo.build_guid">
  23. <summary>
  24. buildGUID is a random GUID. Editor generates the GUID and sends that buildGUID to EditorAnalytics with (cloudProjectId and buildGUID) in BuildInfoEvent. Editor will also bake the buildGUID part of the build for Runtime. Runtime will use the baked buildGUID and send events to CDP/UCA with cloudProjectId and buildGUID
  25. </summary>
  26. </member>
  27. <member name="P:Analytics.Api.Output.BuildAnalyticsCollectionInfo.build_event_id">
  28. <summary>
  29. A random GUID generated from the editor passed to the Analytics.exe. All table rows generated by Analytics.exe must also contain this GUID to allow the events to be joined across tables.
  30. </summary>
  31. </member>
  32. <member name="P:Analytics.Api.Output.BuildAnalyticsCollectionInfo.errors">
  33. <summary>
  34. Array of errors encountered while collecting the player build analytics.
  35. </summary>
  36. </member>
  37. <member name="P:Analytics.Api.Output.BuildAnalyticsCollectionInfo.summary_collector_exit_code">
  38. <summary>
  39. Exit code of the Analytics.exe process (sub process launched to parse the build output directory and collect analytics info)
  40. </summary>
  41. </member>
  42. <member name="P:Analytics.Api.Output.BuildAnalyticsCollectionInfo.time_to_run_summary_collector">
  43. <summary>
  44. (milliseconds) Time taken to run the Analytics.exe process (sub process launched to parse the build output directory and collect analytics info)
  45. </summary>
  46. </member>
  47. <member name="T:Analytics.Api.Output.BuildAnalyticsErrorCodes">
  48. <summary>
  49. Should be kept in sync with
  50. https://github.cds.internal.unity3d.com/unity/unity/blob/trunk/Modules/UnityEditorAnalyticsEditor/Events/BuildAnalyticsCollectionEvent.h#L15-L32
  51. </summary>
  52. </member>
  53. <member name="F:Analytics.Api.Output.BuildAnalyticsErrorCodes.UnknownError">
  54. <summary>
  55. Unknown Error
  56. </summary>
  57. </member>
  58. <member name="F:Analytics.Api.Output.BuildAnalyticsErrorCodes.JsonParseGenericError">
  59. <summary>
  60. Failed parsing json document.
  61. </summary>
  62. </member>
  63. <member name="F:Analytics.Api.Output.BuildAnalyticsErrorCodes.JsonParseNoRootError">
  64. <summary>
  65. Unable to find root node 'player_build_data.
  66. </summary>
  67. </member>
  68. <member name="F:Analytics.Api.Output.BuildAnalyticsErrorCodes.JsonParseInvalidRootError">
  69. <summary>
  70. Invalid root node encountered.
  71. </summary>
  72. </member>
  73. <member name="F:Analytics.Api.Output.BuildAnalyticsErrorCodes.JsonParseEventNotAnObjectError">
  74. <summary>
  75. Invalid event found. Event not formatted as an object.
  76. </summary>
  77. </member>
  78. <member name="F:Analytics.Api.Output.BuildAnalyticsErrorCodes.JsonParseTableNameNotFoundError">
  79. <summary>
  80. Event name not found.
  81. </summary>
  82. </member>
  83. <member name="F:Analytics.Api.Output.BuildAnalyticsErrorCodes.JsonParseInvalidTableNameError">
  84. <summary>
  85. Invalid event name encountered.
  86. </summary>
  87. </member>
  88. <member name="F:Analytics.Api.Output.BuildAnalyticsErrorCodes.JsonParseEventMissingMemberError">
  89. <summary>
  90. Missing required member in event.
  91. </summary>
  92. </member>
  93. <member name="F:Analytics.Api.Output.BuildAnalyticsErrorCodes.JsonParseEventUnknownMemberError">
  94. <summary>
  95. Unknown member encountered in event.
  96. </summary>
  97. </member>
  98. <member name="F:Analytics.Api.Output.BuildAnalyticsErrorCodes.JsonParseEventMessageNotAnObjectError">
  99. <summary>
  100. Invalid event message found. Message not formatted as an object.
  101. </summary>
  102. </member>
  103. <member name="F:Analytics.Api.Output.BuildAnalyticsErrorCodes.JsonParseEventMessageEmptyError">
  104. <summary>
  105. Empty message found in event.
  106. </summary>
  107. </member>
  108. <member name="F:Analytics.Api.Output.BuildAnalyticsErrorCodes.JsonParseEventMessageMissingBuildEventId">
  109. <summary>
  110. Missing required 'build_event_id' member in event.
  111. </summary>
  112. </member>
  113. <member name="F:Analytics.Api.Output.BuildAnalyticsErrorCodes.JsonParseEventMessageMismatchedBuildEventId">
  114. <summary>
  115. Build event id found in event does not match the expected value.
  116. </summary>
  117. </member>
  118. <member name="F:Analytics.Api.Output.BuildAnalyticsErrorCodes.SummaryCollectorProcessFailedToLaunch">
  119. <summary>
  120. The Build Analytics Build Summary failed to launch.
  121. </summary>
  122. </member>
  123. <member name="F:Analytics.Api.Output.BuildAnalyticsErrorCodes.SummaryCollectorProcessTimeout">
  124. <summary>
  125. The Build Analytics Build Summary process timed out.
  126. </summary>
  127. </member>
  128. <member name="F:Analytics.Api.Output.BuildAnalyticsErrorCodes.JsonParseTableVersionNotInt">
  129. <summary>
  130. Table version number can not be parsed as an int..
  131. </summary>
  132. </member>
  133. <member name="F:Analytics.Api.Output.BuildAnalyticsErrorCodes.SummaryCollectorNonZeroExit">
  134. <summary>
  135. The Build Analytics Build Summary failed with non-zero exit code.
  136. </summary>
  137. </member>
  138. <member name="P:Analytics.Api.Output.NodeTimingData.name">
  139. <summary>
  140. The name of the tool node
  141. </summary>
  142. </member>
  143. <member name="P:Analytics.Api.Output.NodeTimingData.duration">
  144. <summary>
  145. (milliseconds) The amount of time it took for the tool to complete
  146. </summary>
  147. </member>
  148. <member name="T:Analytics.Api.Output.PlayerBuildTimingData">
  149. <summary>
  150. Analytics for stages of the player build
  151. </summary>
  152. </member>
  153. <member name="P:Analytics.Api.Output.PlayerBuildTimingData.build_event_id">
  154. <summary>
  155. The build_event_id from the Editor
  156. </summary>
  157. </member>
  158. <member name="P:Analytics.Api.Output.PlayerBuildTimingData.build_player">
  159. <summary>
  160. (milliseconds) The total player build time
  161. #details
  162. Should always appear unless the duration is under tiny profilers minimum duration threshold
  163. </summary>
  164. </member>
  165. <member name="P:Analytics.Api.Output.PlayerBuildTimingData.preprocess_player">
  166. <summary>
  167. (milliseconds) The time it took to complete the pre process built player section
  168. #details
  169. Should always appear unless the duration is under tiny profilers minimum duration threshold
  170. </summary>
  171. </member>
  172. <member name="P:Analytics.Api.Output.PlayerBuildTimingData.produce_player_script_assemblies">
  173. <summary>
  174. (milliseconds) The total time it took to produce the script assemblies
  175. #details
  176. Should always appear unless the duration is under tiny profilers minimum duration threshold
  177. </summary>
  178. </member>
  179. <member name="P:Analytics.Api.Output.PlayerBuildTimingData.build_scripts_dlls">
  180. <summary>
  181. (milliseconds) The time it took to build the script assemblies
  182. </summary>
  183. </member>
  184. <member name="P:Analytics.Api.Output.PlayerBuildTimingData.writing_asset_files">
  185. <summary>
  186. (milliseconds) The total time it took to write all asset files
  187. May not appear during no change builds
  188. </summary>
  189. </member>
  190. <member name="P:Analytics.Api.Output.PlayerBuildTimingData.postprocess_built_player">
  191. <summary>
  192. (milliseconds) The time it took to complete the post process built player section
  193. #details
  194. Should always appear unless the duration is under tiny profilers minimum duration threshold
  195. </summary>
  196. </member>
  197. <member name="P:Analytics.Api.Output.PlayerBuildTimingData.node_summary_table">
  198. <summary>
  199. Timing data for nodes in the player build graph
  200. </summary>
  201. </member>
  202. </members>
  203. </doc>