1
0
mirror of https://gitlab.xiph.org/xiph/icecast-server.git synced 2024-11-03 04:17:17 -05:00
icecast-server/doc/icecast2_stats.html

91 lines
3.0 KiB
HTML

<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.x Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
<div class="boxtest">
<h1>Icecast 2 Server Statistics</h1>
<hr id='titlebar' />
<br />
<br />
<br />
<h2>Overview</h2>
<p>This section contains information about the server statistics available from icecast. An example stats XML tree will be shown and each element will be described. The following example stats tree will be used:</p>
<pre>
&lt;?xml version="1.0"?&gt;
&lt;icestats&gt;
&lt;client_connections&gt;13&lt;/client_connections&gt;
&lt;connections&gt;14&lt;/connections&gt;
&lt;source_connections&gt;1&lt;/source_connections&gt;
&lt;sources&gt;1&lt;/sources&gt;
&lt;source mount="/test.ogg"&gt;
&lt;artist&gt;&lt;/artist&gt;
&lt;audio_info&gt;ice-samplerate=32000;ice-bitrate=Quality -1;ice-channels=1&lt;/audio_info&gt;
&lt;ice-bitrate&gt;Quality -1&lt;/ice-bitrate&gt;
&lt;ice-channels&gt;1&lt;/ice-channels&gt;
&lt;ice-samplerate&gt;32000&lt;/ice-samplerate&gt;
&lt;listeners&gt;0&lt;/listeners&gt;
&lt;public&gt;0&lt;/public&gt;
&lt;title&gt;&lt;/title&gt;
&lt;type&gt;Ogg Vorbis&lt;/type&gt;
&lt;/source&gt;
&lt;/icestats&gt;
</pre>
<h3>General Statistics</h3>
<h4>client-connections</h4>
<div class="indentedbox">
Client connections are basically anything that is not a source connection. These include listeners (not concurrent, but cumulative), any admin function accesses, and any static content (file serving) accesses.
</div>
<h4>source-connections</h4>
<div class="indentedbox">
Source connections are the number of times (cumulative not currently connected) a source has connected to icecast.
</div>
<h4>connections</h4>
<div class="indentedbox">
The total of client + source connections.
</div>
<h4>sources</h4>
<div class="indentedbox">
The total of currently connected sources (mountpoints).
</div>
<h3>Source-specific Statistics</h3>
<h4>artist</h4>
<div class="indentedbox">
Artist of the current song (metadata set by source client).
</div>
<h4>title</h4>
<div class="indentedbox">
Title of the current song (metadata set by source client).
</div>
<h4>audio-info</h4>
<div class="indentedbox">
Information about the bitrate/samplerate/quality of the stream (set by source client). Also used for YP entries.
</div>
<h4>ice-bitrate</h4>
<h4>ice-samplerate</h4>
<h4>ice-channels</h4>
<div class="indentedbox">
Information about the bitrate/samplerate/quality of the stream (set by source client).
</div>
<h4>listeners</h4>
<div class="indentedbox">
The number of currently connected listeners.
</div>
<h4>public</h4>
<div class="indentedbox">
Flag that indicates whether this mount is being listed on a YP (sey by source client).
</div>
<h4>type</h4>
<div class="indentedbox">
Media type of the stream.
</div>
<br />
<br />
<br />
</div>
</body>
</html>