SimStatsReporter.cs 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSimulator Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using System;
  28. //using System.Collections.Generic;
  29. using System.Timers;
  30. using OpenMetaverse.Packets;
  31. using OpenSim.Framework;
  32. using OpenSim.Framework.Statistics;
  33. using OpenSim.Region.Framework.Interfaces;
  34. namespace OpenSim.Region.Framework.Scenes
  35. {
  36. public class SimStatsReporter
  37. {
  38. public delegate void SendStatResult(SimStats stats);
  39. public delegate void YourStatsAreWrong();
  40. public event SendStatResult OnSendStatsResult;
  41. public event YourStatsAreWrong OnStatsIncorrect;
  42. private SendStatResult handlerSendStatResult = null;
  43. private YourStatsAreWrong handlerStatsIncorrect = null;
  44. private enum Stats : uint
  45. {
  46. TimeDilation = 0,
  47. SimFPS = 1,
  48. PhysicsFPS = 2,
  49. AgentUpdates = 3,
  50. FrameMS = 4,
  51. NetMS = 5,
  52. OtherMS = 6,
  53. PhysicsMS = 7,
  54. AgentMS = 8,
  55. ImageMS = 9,
  56. ScriptMS = 10,
  57. TotalPrim = 11,
  58. ActivePrim = 12,
  59. Agents = 13,
  60. ChildAgents = 14,
  61. ActiveScripts = 15,
  62. ScriptLinesPerSecond = 16,
  63. InPacketsPerSecond = 17,
  64. OutPacketsPerSecond = 18,
  65. PendingDownloads = 19,
  66. PendingUploads = 20,
  67. UnAckedBytes = 24,
  68. }
  69. // Sending a stats update every 3 seconds
  70. private int statsUpdatesEveryMS = 3000;
  71. private float statsUpdateFactor = 0;
  72. private float m_timeDilation = 0;
  73. private int m_fps = 0;
  74. // saved last reported value so there is something available for llGetRegionFPS
  75. private float lastReportedSimFPS = 0;
  76. private float m_pfps = 0;
  77. private int m_agentUpdates = 0;
  78. private int m_frameMS = 0;
  79. private int m_netMS = 0;
  80. private int m_agentMS = 0;
  81. private int m_physicsMS = 0;
  82. private int m_imageMS = 0;
  83. private int m_otherMS = 0;
  84. //Ckrinke: (3-21-08) Comment out to remove a compiler warning. Bring back into play when needed.
  85. //Ckrinke private int m_scriptMS = 0;
  86. private int m_rootAgents = 0;
  87. private int m_childAgents = 0;
  88. private int m_numPrim = 0;
  89. private int m_inPacketsPerSecond = 0;
  90. private int m_outPacketsPerSecond = 0;
  91. private int m_activePrim = 0;
  92. private int m_unAckedBytes = 0;
  93. private int m_pendingDownloads = 0;
  94. private int m_pendingUploads = 0;
  95. private int m_activeScripts = 0;
  96. private int m_scriptLinesPerSecond = 0;
  97. private int objectCapacity = 45000;
  98. private Scene m_scene;
  99. private RegionInfo ReportingRegion;
  100. private Timer m_report = new Timer();
  101. private IEstateModule estateModule;
  102. public SimStatsReporter(Scene scene)
  103. {
  104. statsUpdateFactor = (float)(statsUpdatesEveryMS / 1000);
  105. m_scene = scene;
  106. ReportingRegion = scene.RegionInfo;
  107. m_report.AutoReset = true;
  108. m_report.Interval = statsUpdatesEveryMS;
  109. m_report.Elapsed += new ElapsedEventHandler(statsHeartBeat);
  110. m_report.Enabled = true;
  111. if (StatsManager.SimExtraStats != null)
  112. OnSendStatsResult += StatsManager.SimExtraStats.ReceiveClassicSimStatsPacket;
  113. }
  114. public void SetUpdateMS(int ms)
  115. {
  116. statsUpdatesEveryMS = ms;
  117. statsUpdateFactor = (float)(statsUpdatesEveryMS / 1000);
  118. m_report.Interval = statsUpdatesEveryMS;
  119. }
  120. private void statsHeartBeat(object sender, EventArgs e)
  121. {
  122. SimStatsPacket.StatBlock[] sb = new SimStatsPacket.StatBlock[21];
  123. SimStatsPacket.RegionBlock rb = new SimStatsPacket.RegionBlock();
  124. // Know what's not thread safe in Mono... modifying timers.
  125. // m_log.Debug("Firing Stats Heart Beat");
  126. lock (m_report)
  127. {
  128. uint regionFlags = 0;
  129. try
  130. {
  131. if (estateModule == null)
  132. estateModule = m_scene.RequestModuleInterface<IEstateModule>();
  133. regionFlags = estateModule != null ? estateModule.GetRegionFlags() : (uint) 0;
  134. }
  135. catch (Exception)
  136. {
  137. // leave region flags at 0
  138. }
  139. #region various statistic googly moogly
  140. // Our FPS is actually 10fps, so multiplying by 5 to get the amount that people expect there
  141. // 0-50 is pretty close to 0-45
  142. float simfps = (int) ((m_fps * 5));
  143. // save the reported value so there is something available for llGetRegionFPS
  144. lastReportedSimFPS = (float)simfps / statsUpdateFactor;
  145. //if (simfps > 45)
  146. //simfps = simfps - (simfps - 45);
  147. //if (simfps < 0)
  148. //simfps = 0;
  149. //
  150. float physfps = ((m_pfps / 1000));
  151. //if (physfps > 600)
  152. //physfps = physfps - (physfps - 600);
  153. if (physfps < 0)
  154. physfps = 0;
  155. #endregion
  156. //Our time dilation is 0.91 when we're running a full speed,
  157. // therefore to make sure we get an appropriate range,
  158. // we have to factor in our error. (0.10f * statsUpdateFactor)
  159. // multiplies the fix for the error times the amount of times it'll occur a second
  160. // / 10 divides the value by the number of times the sim heartbeat runs (10fps)
  161. // Then we divide the whole amount by the amount of seconds pass in between stats updates.
  162. for (int i = 0; i<21;i++)
  163. {
  164. sb[i] = new SimStatsPacket.StatBlock();
  165. }
  166. sb[0].StatID = (uint) Stats.TimeDilation;
  167. sb[0].StatValue = (Single.IsNaN(m_timeDilation)) ? 0.1f : m_timeDilation ; //((((m_timeDilation + (0.10f * statsUpdateFactor)) /10) / statsUpdateFactor));
  168. sb[1].StatID = (uint) Stats.SimFPS;
  169. sb[1].StatValue = simfps/statsUpdateFactor;
  170. sb[2].StatID = (uint) Stats.PhysicsFPS;
  171. sb[2].StatValue = physfps / statsUpdateFactor;
  172. sb[3].StatID = (uint) Stats.AgentUpdates;
  173. sb[3].StatValue = (m_agentUpdates / statsUpdateFactor);
  174. sb[4].StatID = (uint) Stats.Agents;
  175. sb[4].StatValue = m_rootAgents;
  176. sb[5].StatID = (uint) Stats.ChildAgents;
  177. sb[5].StatValue = m_childAgents;
  178. sb[6].StatID = (uint) Stats.TotalPrim;
  179. sb[6].StatValue = m_numPrim;
  180. sb[7].StatID = (uint) Stats.ActivePrim;
  181. sb[7].StatValue = m_activePrim;
  182. sb[8].StatID = (uint)Stats.FrameMS;
  183. sb[8].StatValue = m_frameMS / statsUpdateFactor;
  184. sb[9].StatID = (uint)Stats.NetMS;
  185. sb[9].StatValue = m_netMS / statsUpdateFactor;
  186. sb[10].StatID = (uint)Stats.PhysicsMS;
  187. sb[10].StatValue = m_physicsMS / statsUpdateFactor;
  188. sb[11].StatID = (uint)Stats.ImageMS ;
  189. sb[11].StatValue = m_imageMS / statsUpdateFactor;
  190. sb[12].StatID = (uint)Stats.OtherMS;
  191. sb[12].StatValue = m_otherMS / statsUpdateFactor;
  192. sb[13].StatID = (uint)Stats.InPacketsPerSecond;
  193. sb[13].StatValue = (m_inPacketsPerSecond);
  194. sb[14].StatID = (uint)Stats.OutPacketsPerSecond;
  195. sb[14].StatValue = (m_outPacketsPerSecond / statsUpdateFactor);
  196. sb[15].StatID = (uint)Stats.UnAckedBytes;
  197. sb[15].StatValue = m_unAckedBytes;
  198. sb[16].StatID = (uint)Stats.AgentMS;
  199. sb[16].StatValue = m_agentMS / statsUpdateFactor;
  200. sb[17].StatID = (uint)Stats.PendingDownloads;
  201. sb[17].StatValue = m_pendingDownloads;
  202. sb[18].StatID = (uint)Stats.PendingUploads;
  203. sb[18].StatValue = m_pendingUploads;
  204. sb[19].StatID = (uint)Stats.ActiveScripts;
  205. sb[19].StatValue = m_activeScripts;
  206. sb[20].StatID = (uint)Stats.ScriptLinesPerSecond;
  207. sb[20].StatValue = m_scriptLinesPerSecond / statsUpdateFactor;
  208. SimStats simStats
  209. = new SimStats(
  210. ReportingRegion.RegionLocX, ReportingRegion.RegionLocY, regionFlags, (uint)objectCapacity, rb, sb, m_scene.RegionInfo.originRegionID);
  211. handlerSendStatResult = OnSendStatsResult;
  212. if (handlerSendStatResult != null)
  213. {
  214. handlerSendStatResult(simStats);
  215. }
  216. resetvalues();
  217. }
  218. }
  219. private void resetvalues()
  220. {
  221. m_timeDilation = 0;
  222. m_fps = 0;
  223. m_pfps = 0;
  224. m_agentUpdates = 0;
  225. m_inPacketsPerSecond = 0;
  226. m_outPacketsPerSecond = 0;
  227. m_unAckedBytes = 0;
  228. m_scriptLinesPerSecond = 0;
  229. m_frameMS = 0;
  230. m_agentMS = 0;
  231. m_netMS = 0;
  232. m_physicsMS = 0;
  233. m_imageMS = 0;
  234. m_otherMS = 0;
  235. //Ckrinke This variable is not used, so comment to remove compiler warning until it is used.
  236. //Ckrinke m_scriptMS = 0;
  237. }
  238. # region methods called from Scene
  239. // The majority of these functions are additive
  240. // so that you can easily change the amount of
  241. // seconds in between sim stats updates
  242. public void AddTimeDilation(float td)
  243. {
  244. //float tdsetting = td;
  245. //if (tdsetting > 1.0f)
  246. //tdsetting = (tdsetting - (tdsetting - 0.91f));
  247. //if (tdsetting < 0)
  248. //tdsetting = 0.0f;
  249. m_timeDilation = td;
  250. }
  251. public void SetRootAgents(int rootAgents)
  252. {
  253. m_rootAgents = rootAgents;
  254. CheckStatSanity();
  255. }
  256. internal void CheckStatSanity()
  257. {
  258. if (m_rootAgents < 0 || m_childAgents < 0)
  259. {
  260. handlerStatsIncorrect = OnStatsIncorrect;
  261. if (handlerStatsIncorrect != null)
  262. {
  263. handlerStatsIncorrect();
  264. }
  265. }
  266. if (m_rootAgents == 0 && m_childAgents == 0)
  267. {
  268. m_unAckedBytes = 0;
  269. }
  270. }
  271. public void SetChildAgents(int childAgents)
  272. {
  273. m_childAgents = childAgents;
  274. CheckStatSanity();
  275. }
  276. public void SetObjects(int objects)
  277. {
  278. m_numPrim = objects;
  279. }
  280. public void SetActiveObjects(int objects)
  281. {
  282. m_activePrim = objects;
  283. }
  284. public void AddFPS(int frames)
  285. {
  286. m_fps += frames;
  287. }
  288. public void AddPhysicsFPS(float frames)
  289. {
  290. m_pfps += frames;
  291. }
  292. public void AddAgentUpdates(int numUpdates)
  293. {
  294. m_agentUpdates += numUpdates;
  295. }
  296. public void AddInPackets(int numPackets)
  297. {
  298. m_inPacketsPerSecond += numPackets;
  299. }
  300. public void AddOutPackets(int numPackets)
  301. {
  302. m_outPacketsPerSecond += numPackets;
  303. }
  304. public void AddunAckedBytes(int numBytes)
  305. {
  306. m_unAckedBytes += numBytes;
  307. if (m_unAckedBytes < 0) m_unAckedBytes = 0;
  308. }
  309. public void addFrameMS(int ms)
  310. {
  311. m_frameMS += ms;
  312. }
  313. public void addNetMS(int ms)
  314. {
  315. m_netMS += ms;
  316. }
  317. public void addAgentMS(int ms)
  318. {
  319. m_agentMS += ms;
  320. }
  321. public void addPhysicsMS(int ms)
  322. {
  323. m_physicsMS += ms;
  324. }
  325. public void addImageMS(int ms)
  326. {
  327. m_imageMS += ms;
  328. }
  329. public void addOtherMS(int ms)
  330. {
  331. m_otherMS += ms;
  332. }
  333. // private static readonly log4net.ILog m_log
  334. // = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
  335. public void AddPendingDownloads(int count)
  336. {
  337. m_pendingDownloads += count;
  338. if (m_pendingDownloads < 0) m_pendingDownloads = 0;
  339. //m_log.InfoFormat("[stats]: Adding {0} to pending downloads to make {1}", count, m_pendingDownloads);
  340. }
  341. public void addScriptLines(int count)
  342. {
  343. m_scriptLinesPerSecond += count;
  344. }
  345. public void SetActiveScripts(int count)
  346. {
  347. m_activeScripts = count;
  348. }
  349. public void SetObjectCapacity(int objects)
  350. {
  351. objectCapacity = objects;
  352. }
  353. /// <summary>
  354. /// This is for llGetRegionFPS
  355. /// </summary>
  356. public float getLastReportedSimFPS()
  357. {
  358. return lastReportedSimFPS;
  359. }
  360. public void AddPacketsStats(int inPackets, int outPackets, int unAckedBytes)
  361. {
  362. AddInPackets(inPackets);
  363. AddOutPackets(outPackets);
  364. AddunAckedBytes(unAckedBytes);
  365. }
  366. public void AddAgentTime(int ms)
  367. {
  368. addFrameMS(ms);
  369. addAgentMS(ms);
  370. }
  371. #endregion
  372. }
  373. }