Web Statistics Module

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
m (→‎Feature Requests)
(→‎Introduction: alter accesed by internal web prowser to provided by internal web server)
 
(19 intermediate revisions by 8 users not shown)
Line 1: Line 1:
−
Web Statistics Module provides region statistics information. The data is provided as AJAX html page which can be embedded to web site. The page is accessing the data over JSON interface.
+
{{Quicklinks}}
 +
 
 +
= Introduction =
 +
 
 +
The Web Statistics Module provides region statistics information. The data is provided as an AJAX html page which automatically updates over time. The page is provided by the internal OpenSimulator web server. The module also stores historical data which is displayed on these web pages.
  
 
== Enabling Web Statistics ==
 
== Enabling Web Statistics ==
  
−
Edit OpenSim.exe.ini:
+
Edit OpenSim.ini:
  
 
<pre>
 
<pre>
Line 12: Line 16:
 
== Accessing Web Statistics ==
 
== Accessing Web Statistics ==
  
−
You can form url for region web statistics as follows:
+
You can access region web statistics pages by pointing your browser at:
  
 
<pre>
 
<pre>
Line 18: Line 22:
 
</pre>
 
</pre>
  
−
== Live Demo ==
+
For example, if you are running a standalone OpenSimulator at 192.168.1.2:9000, you would go to the URL
  
−
A live demo of the statistics module can be viewed here for OSGrid Wright Plaza: http://osgrid02.sytes.net:9101/SStats/
+
<pre>
 +
http://192.168.1.2:9000/SStats/
 +
</pre>
 +
 
 +
Please note that the trailing / is essential right now.
 +
 
 +
== Viewing recorded statistics ==
 +
 
 +
The Web Statistics module also records viewer stats data uploaded by viewers. This is sent on login and thereafter every 5 minutes and just before logout.  The client may choose not to send this information.
 +
 
 +
This data is stored in an sqlite3 database at bin/LocalUserStatistics.db.
 +
 
 +
Columns are as follows.  Some of the meanings are unclear since they are taken directly from the client data packet rather than generated by OpenSimulator itself.
 +
 
 +
{| border = "1"
 +
! Column              !! Description                                               
 +
|-
 +
| session_id          || Client session id                                         
 +
|-
 +
| agent_id            || User ID                                                   
 +
|-
 +
| region_id          || ID of the region the user was on                           
 +
|-
 +
| last_updated        || Probably a unix timestamp of the time this update was sent.
 +
|-
 +
| remote_ip          || Client IP                                                 
 +
|-
 +
| name_f              || First name of user                                         
 +
|-
 +
| name_l              || Last name of user                                         
 +
|-
 +
| avg_agents_in_view  || Average number of other users in the view of this user     
 +
|-
 +
| min_agents_in_view  || Minimum users that have been in the view of this user     
 +
|-
 +
| max_agents_in_view  || Maximum users that have been in this user's view           
 +
|-
 +
| mode_agents_in_view || Numeric mode of users that have been in view               
 +
|-
 +
| avg_fps            || Average fps of this user                                   
 +
|-
 +
| min_fps            || Min fps of this user                                       
 +
|-
 +
| max_fps            || Max fps of this user                                       
 +
|-
 +
| mode_fps            || Mode fps of this user                                     
 +
|-
 +
| a_language          || Unknown, probably language client is set to               
 +
|-
 +
| mem_use            || Memory user of client                                     
 +
|-
 +
| meters_traveled    || Meters travelled by user                                   
 +
|-
 +
| avg_ping            || Average ping of client to servers                         
 +
|-
 +
| min_ping            || Minimum ping of client to servers                         
 +
|-
 +
| max_ping            || Maximum ping of client to servers                         
 +
|-
 +
| mode_ping          || Mode of ping from client to servers                       
 +
|-
 +
| regions_visited    || Number of regions that this client has visited             
 +
|-
 +
| run_time            || Run time of client                                         
 +
|-
 +
| avg_sim_fps        || Average simulator fps of simulators the client has been on 
 +
|-
 +
| min_sim_fps        || Min simulator fps of simulators the client has been on     
 +
|-
 +
| max_sim_fps        || Max simulator fps of simulators the client has been on     
 +
|-
 +
| mode_sim_fps        || Mode simulator fps of simulators the client has been on   
 +
|-
 +
| start_time          || Time at which client was started                           
 +
|-
 +
| client_version      || Client version                                             
 +
|-
 +
| s_cpu              || CPU of machine running client                             
 +
|-
 +
| s_gpu              || GPU of machine running client                             
 +
|-
 +
| s_os                || Operating system of the machine running the client         
 +
|-
 +
| s_ram              || RAM of the machine running the client                     
 +
|-
 +
| d_object_kb        || Memory used by scene objects in the client                 
 +
|-
 +
| d_texture_kb        || Memory used by textures in the client                     
 +
|-
 +
| d_world_kb          || Memory used by the world in the client                     
 +
|-
 +
| n_in_kb            || kb received by client from servers                         
 +
|-
 +
| n_in_pk            || Packets received by client from servers                   
 +
|-
 +
| n_out_kb            || kb send by client to servers                               
 +
|-
 +
| n_out_pk            || Packets sent by client to servers                         
 +
|-
 +
| f_dropped          || Packets dropped (inbound?)                                 
 +
|-
 +
| f_failed_resends    || Packets requested but not resent by servers (?)           
 +
|-
 +
| f_invalid          || Invalid packets received                                   
 +
|-
 +
| f_off_circuit      || Packets received not associated with any known circuit     
 +
|-
 +
| f_resent            || Packets resent to simulator due to no ack                 
 +
|-
 +
| f_send_packets      || Unknown                                                   
 +
|-
 +
| session_key        || Same as session_id (?!)                                   
 +
|-
 +
| agent_key          || Same as agent_id (?!)                                     
 +
|-
 +
| region_key          || Same as region_id (?!)                                     
 +
|}
  
 
== Feature Requests ==
 
== Feature Requests ==
  
 +
Please note that these are feature requests - these have not (yet) been implemented!
 +
 +
* XMLRPC access
 
* Public JSON API for accessing counters.
 
* Public JSON API for accessing counters.
−
* Diagnostics counters:
 
−
** Dead and stalled threads.
 
−
** Number of exceptions since last startup.
 
 
* Uptime counter.
 
* Uptime counter.
 
* Region build version.
 
* Region build version.
 
* Number of unique visitors during last hour.
 
* Number of unique visitors during last hour.
 
* Number of unique visitors during last 24 hours.
 
* Number of unique visitors during last 24 hours.
 +
* Grid based policy framework for setting it up.
 +
* Access Authorization

Latest revision as of 12:52, 8 July 2014

Languages Languages: 

En.png English   De.png Deutsch   Fr.png Français

Contents

[edit] Introduction

The Web Statistics Module provides region statistics information. The data is provided as an AJAX html page which automatically updates over time. The page is provided by the internal OpenSimulator web server. The module also stores historical data which is displayed on these web pages.

[edit] Enabling Web Statistics

Edit OpenSim.ini: 

[WebStats]
enabled=true

[edit] Accessing Web Statistics

You can access region web statistics pages by pointing your browser at: 

http://<region-server-ip>:<http-port>/SStats/

For example, if you are running a standalone OpenSimulator at 192.168.1.2:9000, you would go to the URL 

http://192.168.1.2:9000/SStats/

Please note that the trailing / is essential right now.

[edit] Viewing recorded statistics

The Web Statistics module also records viewer stats data uploaded by viewers. This is sent on login and thereafter every 5 minutes and just before logout. The client may choose not to send this information.

This data is stored in an sqlite3 database at bin/LocalUserStatistics.db.

Columns are as follows. Some of the meanings are unclear since they are taken directly from the client data packet rather than generated by OpenSimulator itself.

Column Description
session_id Client session id
agent_id User ID
region_id ID of the region the user was on
last_updated Probably a unix timestamp of the time this update was sent.
remote_ip Client IP
name_f First name of user
name_l Last name of user
avg_agents_in_view Average number of other users in the view of this user
min_agents_in_view Minimum users that have been in the view of this user
max_agents_in_view Maximum users that have been in this user's view
mode_agents_in_view Numeric mode of users that have been in view
avg_fps Average fps of this user
min_fps Min fps of this user
max_fps Max fps of this user
mode_fps Mode fps of this user
a_language Unknown, probably language client is set to
mem_use Memory user of client
meters_traveled Meters travelled by user
avg_ping Average ping of client to servers
min_ping Minimum ping of client to servers
max_ping Maximum ping of client to servers
mode_ping Mode of ping from client to servers
regions_visited Number of regions that this client has visited
run_time Run time of client
avg_sim_fps Average simulator fps of simulators the client has been on
min_sim_fps Min simulator fps of simulators the client has been on
max_sim_fps Max simulator fps of simulators the client has been on
mode_sim_fps Mode simulator fps of simulators the client has been on
start_time Time at which client was started
client_version Client version
s_cpu CPU of machine running client
s_gpu GPU of machine running client
s_os Operating system of the machine running the client
s_ram RAM of the machine running the client
d_object_kb Memory used by scene objects in the client
d_texture_kb Memory used by textures in the client
d_world_kb Memory used by the world in the client
n_in_kb kb received by client from servers
n_in_pk Packets received by client from servers
n_out_kb kb send by client to servers
n_out_pk Packets sent by client to servers
f_dropped Packets dropped (inbound?)
f_failed_resends Packets requested but not resent by servers (?)
f_invalid Invalid packets received
f_off_circuit Packets received not associated with any known circuit
f_resent Packets resent to simulator due to no ack
f_send_packets Unknown
session_key Same as session_id (?!)
agent_key Same as agent_id (?!)
region_key Same as region_id (?!)

[edit] Feature Requests

Please note that these are feature requests - these have not (yet) been implemented!

  • XMLRPC access
  • Public JSON API for accessing counters.
  • Uptime counter.
  • Region build version.
  • Number of unique visitors during last hour.
  • Number of unique visitors during last 24 hours.
  • Grid based policy framework for setting it up.
  • Access Authorization
Retrieved from "http://opensimulator.org/index.php?title=Web_Statistics_Module&oldid=39283"
Personal tools
General
About This Wiki