UXSimStatus

From OpenSimulator

Revision as of 16:18, 22 July 2021 by Ubit (Talk | contribs)

Jump to: navigation, search

As of OpenSimulator svn 9529 the xtended stats reporting will return a jsonp callback to allow popular javascript toolkits to use the returned data to create ajax monitoring applications in the browser. This is an advantage because after the page is loaded, the browser will interact directly with the region, eliminating traffic through the website (polling the region and servicing the browser). It also allows the creation of mashups to create mini-monitor apps in other pages.

To enable your stats reporting, set the following in your OpenSim.ini...

   ; Simulator Stats URI
   ; Enable JSON simulator data by setting a URI name (case sensitive)
   Stats_URI = "jsonSimStats"

The URI can be anything you want, and is case sensitive. You can query the URI directly to return a json string to use in php, python, java, etc. or you may use one of the popular javascript toolkits to have OpenSimulator generate a callback for jsonp.

The json serialization did carry the following data.

{"AssetsInCache":5.0,"TimeAfterCacheMiss":0.0,"BlockedMissingTextureRequests":0.0,"AssetServiceRequestFailures":0.0,
"abnormalClientThreadTerminations":0.0,"InventoryServiceRetrievalFailures":0.0,"Dilatn":0.967380821704865,"SimFPS":55.0,
"PhyFPS":47.1628913879395,"AgntUp":0.0,"RootAg":0.0,"ChldAg":0.0,"Prims":0.0,"AtvPrm":0.0,"AtvScr":0.0,"ScrLPS":0.0,
"PktsIn":0.0,"PktOut":0.0,"PendDl":0.0,"PendUl":0.0,"UnackB":0.0,"TotlFt":0.0,"NetFt":0.0,"PhysFt":0.0,"OthrFt":0.0,
"AgntFt":0.0,"ImgsFt":0.0,"Memory":"8","Uptime":"05:12:19.0365590","Version":"OpenSimulator Server  0.6.4.9533 "}


this data may change, for example 0.9.2 may return

{"Dilatn":"1","SimFPS":"55","PhyFPS":"55","AgntUp":"0","RootAg":"0","ChldAg":"0","Prims":"2042","AtvPrm":"1","AtvScr":"131",
"ScrLPS":"0","ScrEPS":"1","PktsIn":"18","PktOut":"1","PendDl":"0","PendUl":"0","UnackB":"0","TotlFt":"18.18","NetFt":"0",
"PhysFt":"0.02","OthrFt":"0.01","AgntFt":"0","ImgsFt":"0","FrameDilatn":"1","Logging in Users":"0","GeoPrims":"1579",
"Mesh Objects":"463","Script Engine Thread Count":"0","Util Thread Count":"0","System Thread Count":"39",
"System Thread Active":"0","ProcMem":"253572","Memory":"68","Uptime":"01:00:04.7184410",
"Version":"OpenSim 0.9.2.0 Yeti Dev d9d8dce","RegionName":"ubittest"}


If the Opensimulator instance was running more than one region, until 0.9.2 the region used for the stats was in fact not clear and not the same on each request. With 0.9.2 the region used will be the first that did create stats. Now the URI can now include the query ?region=regionName or ?region=regionUUID to select a region, example:

http://mysimhost:itsPort/jsonSimStats?region=MyPrettyHOmeRegion


<source lang="html4strict">
<!DOCTYPE HTML>
<html>
<head>
<title>JSON Test</title>
<script src="https://code.jquery.com/jquery-3.3.1.min.js"></script>
<script src="http://www.google.com/jsapi"></script>
<script>
SimFPS = 0;
PhyFPS = 0;
Memory = 0;
RootAg = 0;
ChldAg = 0;
Uptime = "";
Version = "";
var url = "http://<IP_OR_DOMAIN>:<PORT>/jsonSimStats/?callback=?";
 
setInterval(function() {$.getJSON(url, function(data) {
    SimFPS = Math.round(data.SimFPS);
    PhyFPS = Math.round(data.PhyFPS);
    Memory = Math.round(data.Memory);
    ChldAg = data.ChldAg;
    RootAg = data.RootAg;
    Uptime = data.Uptime;
    Version = data.Version;
    drawChart();
    setTags();
})}, 3000);
 
google.load("visualization", "1.0", {packages:["gauge"]});
google.setOnLoadCallback(drawChart);
 
function drawChart() {
    var cdata = new google.visualization.DataTable();
    cdata.addColumn('string', 'Label');
    cdata.addColumn('number', 'Value');
    cdata.addRows(3);
    cdata.setValue(0, 0, 'SimFPS');
    cdata.setValue(0, 1, SimFPS);
    cdata.setValue(1, 0, 'PhyFPS');
    cdata.setValue(1, 1, PhyFPS);
    cdata.setValue(2, 0, 'Memory');
    cdata.setValue(2, 1, Memory);
    var chart = new google.visualization.Gauge(document.getElementById('chart_div'));
    var options = {width: 400, height: 120, redFrom: 90, redTo: 100, yellowFrom:75, yellowTo: 90, minorTicks: 5};
    chart.draw(cdata, options);
}
 
function setTags() {
    $("#par-uptime").text("Uptime: "  + Uptime);
    $("#par-ragent").text("Root Agent: " + RootAg);
    $("#par-version").text("Version: " + Version);
    $("#par-cagent").text("Child Agent: " + ChldAg);
}
</script>
</head>
<body>
= BlueWall Development Region =
<table>
    <tr>
        <td><div id="par-version">Version:</div></td>
        <td><div id="par-ragent">Root Agent:</div></td>
    </tr>
    <tr>
        <td><div id="par-uptime">Uptime:</div></td>
        <td><div id="par-cagent">Child Agent:</div></td>
    </tr>
</table>
<div id="chart_div"></div>
</body>
</html>

Note: If you are having problems with cross-origin, you can try this script UXSimStatus_Aternatif.

JSON Grid Simstats

Python example to gain the region data from a grid service

- should work but this version not tested -
        *reference material* 
import hashlib
 import urllib2
 
 ''' value shown is an example, get this from your grid database each time - regions.regionSecret '''
 regionsecret = 'fe21314b-6267-44f7-aa1e-6047e1c3f94a'
 
 ''' My region host '''
 hostName =  myregion.host.net
 
 ''' My region port '''
 hostPort = 9000
 
 ''' create an *UPPERCASE* SHA1 hash from the regionSecret '''
 resourceName = str(hashlib.sha1(regionsecret).hexdigest()).upper()
 
 regionuri = hostName + ":" + hostPort + "/" + resourceName + "/"
 
 ''' data includes TimeZoneName , TimeZoneOffs, UxTime, Memory, Version and OSStatsURI '''
 regiondata = simplejson.load(urllib2.urlopen(regionuri))
 
 ''' OSStatsURI is the uri to query the OpenSimulator instance. return same data as the user set uri '''
 simuri = regiondata['OSStatsURI']
 
 simdata = simplejson.load(urllib2.urlopen(simuri))

See too SSL in OpenSim

Personal tools
General
About This Wiki