mirror of
https://gitlab.xiph.org/xiph/icecast-server.git
synced 2024-06-30 06:35:23 +00:00
b6b01430ef
Now validates completely as XHTML1.0 strict. Also improves rendering on mobile devices. svn path=/icecast/trunk/icecast/; revision=19099
259 lines
7.9 KiB
HTML
259 lines
7.9 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 />
|
|
<ul>
|
|
<li><a href="#overview">Overview</a></li>
|
|
<li><a href="#xslt">HTML interface, XSLT generated</a></li>
|
|
<li><a href="#xslt_advanced">Advanced machine readable data, XSLT generated</a></li>
|
|
<li><a href="#available_raw_data">Available raw data</a></li>
|
|
</ul>
|
|
|
|
<a name="overview"></a>
|
|
<h2>Overview</h2>
|
|
|
|
<a name="xslt"></a>
|
|
<h2>HTML interface, XSLT generated</h2>
|
|
|
|
<a name="xslt_advanced"></a>
|
|
<h2>Advanced machine readable data, XSLT generated</h2>
|
|
|
|
<a name="available_raw_data"></a>
|
|
<h2>Available raw data</h2>
|
|
<p>This section contains information about the raw server statistics data available inside icecast. An example stats XML tree will be shown and each element will be described. The following example stats tree will be used (it should not be considered complete nor authoritative):</p>
|
|
<pre>
|
|
<?xml version="1.0"?>
|
|
<icestats>
|
|
<admin>icemaster@example.org</admin>
|
|
<client_connections>13</client_connections>
|
|
<clients>2</clients>
|
|
<connections>14</connections>
|
|
<file_connections>1</file_connections>
|
|
<host>stream.example.org</host>
|
|
<listener_connections>7</listener_connections>
|
|
<listeners>1</listeners>
|
|
<location>Earth</location>
|
|
<server_id>Icecast 2.4.0</server_id>
|
|
<server_start>Tue, 01 Apr 2014 23:42:05 +0000</server_start>
|
|
<source_client_connections>1</source_client_connections>
|
|
<source_relay_connections>0</source_relay_connections>
|
|
<source_total_connections>1</source_total_connections>
|
|
<sources>1</sources>
|
|
<stats>0</stats>
|
|
<stats_connections>0</stats_connections>
|
|
<source mount="/test.ogg">
|
|
<artist>Test artist</artist>
|
|
<audio_bitrate>32000</audio_bitrate>
|
|
<audio_channels>2</audio_channels>
|
|
<audio_info>samplerate=32000;channels=2;quality=-1;ice-channels=1</audio_info>
|
|
<ice-bitrate>32</ice-bitrate>
|
|
<listener_peak>2</listener_peak>
|
|
<listeners>0</listeners>
|
|
<listenurl>http://stream.example.org:8000/test.ogg</listenurl>
|
|
<max_listeners>unlimited</max_listeners>
|
|
<public>0</public>
|
|
<quality>-1.00</quality>
|
|
<samplerate>32000</samplerate>
|
|
<server_description>A stream for testing ogg/vorbis.</server_description>
|
|
<server_name>TestStream</server_name>
|
|
<server_type>application/ogg</server_type>
|
|
<slow_listeners>1</slow_listeners>
|
|
<source_ip>203.0.113.42</source_ip>
|
|
<stream_start>Wed, 02 Apr 2014 13:37:42 +0000</stream_start>
|
|
<subtype>Vorbis</subtype>
|
|
<title>Test title</title>
|
|
<total_bytes_read>448632</total_bytes_read>
|
|
<total_bytes_sent>207463</total_bytes_sent>
|
|
<user_agent>IceS 2.0.1</user_agent>
|
|
</source>
|
|
</icestats>
|
|
</pre>
|
|
<h3>General Statistics</h3>
|
|
<!--
|
|
<h4></h4>
|
|
<div class="indentedbox">
|
|
|
|
</div>
|
|
-->
|
|
<h4>admin</h4>
|
|
<div class="indentedbox">
|
|
As set in the server config, this should contain contact details for getting in touch with the server administrator. Usually this will be an email address, but as this can be an arbitrary string it could also be a phone number.
|
|
</div>
|
|
<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>clients</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->
|
|
</div>
|
|
<h4>connections</h4>
|
|
<div class="indentedbox">
|
|
The total of all inbound TCP connections since start-up.
|
|
</div>
|
|
<h4>file_connections</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->
|
|
</div>
|
|
<h4>host</h4>
|
|
<div class="indentedbox">
|
|
As set in the server config,<!--FIXME-->
|
|
</div>
|
|
<h4>listener_connections</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->
|
|
</div>
|
|
<h4>listeners</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->
|
|
</div>
|
|
<h4>location</h4>
|
|
<div class="indentedbox">
|
|
As set in the server config,<!--FIXME-->
|
|
</div>
|
|
<h4>server_id</h4>
|
|
<div class="indentedbox">
|
|
Defaults to the version string of the currently running Icecast server. While not recommended it can be overriden in the server config.
|
|
</div>
|
|
<h4>server_start</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->
|
|
</div>
|
|
<h4>source_client_connections</h4>
|
|
<div class="indentedbox">
|
|
Source client connections are the number of times (cumulative since start-up, not just currently connected) a source client has connected to icecast.
|
|
</div>
|
|
<h4>source_relay_connections</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->
|
|
</div>
|
|
<h4>source_total_connections</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->
|
|
</div>
|
|
<h4>sources</h4>
|
|
<div class="indentedbox">
|
|
The total of currently connected sources (mountpoints).
|
|
</div>
|
|
<h4>stats</h4>
|
|
<div class="indentedbox">
|
|
The total of currently connected STATS clients.
|
|
</div>
|
|
<h4>stats_connections</h4>
|
|
<div class="indentedbox">
|
|
Number of times (cumulative since start-up, not just currently connected) a stats client has connected to icecast.
|
|
</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_bitrate</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->(metadata set by source client).
|
|
</div>
|
|
<h4>audio_channels</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->(metadata set by source client).
|
|
</div>
|
|
<h4>audio-info</h4>
|
|
<div class="indentedbox">
|
|
Information about the bitrate/samplerate/quality of the stream (metadata set by source client). Also used for YP entries.
|
|
</div>
|
|
<h4>ice-bitrate</h4>
|
|
<h4>samplerate</h4>
|
|
<div class="indentedbox">
|
|
Information about the bitrate/samplerate/quality of the stream (metadata set by source client).
|
|
</div>
|
|
<h4>listener_peak</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->
|
|
</div>
|
|
<h4>listeners</h4>
|
|
<div class="indentedbox">
|
|
The number of currently connected listeners.
|
|
</div>
|
|
<h4>listenurl</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->
|
|
</div>
|
|
<h4>max_listeners</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->
|
|
</div>
|
|
<h4>public</h4>
|
|
<div class="indentedbox">
|
|
Flag that indicates whether this mount is to be listed on a YP (set by source client, can be overriden by server config).
|
|
</div>
|
|
<h4>quality</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->(metadata set by source client).
|
|
</div>
|
|
<h4>samplerate</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->(metadata set by source client).
|
|
</div>
|
|
<h4>server_description</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->(metadata set by source client).
|
|
</div>
|
|
<h4>server_name</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->(metadata set by source client).
|
|
</div>
|
|
<h4>server_type</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->
|
|
</div>
|
|
<h4>slow_listeners</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->
|
|
</div>
|
|
<h4>source_ip</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->
|
|
</div>
|
|
<h4>stream_start</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->
|
|
</div>
|
|
<h4>subtype</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->
|
|
</div>
|
|
<h4>total_bytes_read</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->
|
|
</div>
|
|
<h4>total_bytes_sent</h4>
|
|
<div class="indentedbox">
|
|
<!--FIXME-->
|
|
</div>
|
|
<h4>user_agent</h4>
|
|
<div class="indentedbox">
|
|
HTTP user agent string as sent by the source client.
|
|
</div>
|
|
<br />
|
|
<br />
|
|
Additional data can be accessed through the admin interface, as every page of the admin interface has an XML equivalent.
|
|
<br />
|
|
</div>
|
|
</body>
|
|
</html>
|