Руководство пользователя CNStats 3.4
Список параметров config.php
Настройки, хранимые в файле config.php:
- $STATS_CONF["cnsoftwaredomain"]
- $STATS_CONF["sqlserver"]
- $STATS_CONF["dbname"]
- $STATS_CONF["sqlprefix"]
- $STATS_CONF["sqlhost"]
- $STATS_CONF["sqluser"]
- $STATS_CONF["sqlpassword"]
- $COUNTER["savelog"]
- $COUNTER["type"]
- $COUNTER["excludeip"], $COUNTER["excludemask"]
- $COUNTER["disablepassword"]
- $STATS_CONF["adminemail"]
- $COUNTER["senderrorsbymail"]
- $COUNTER["sqlwritelog"]
- $STATS_CONF["sqlinstructions"]
- $STATS_CONF["slow_reports_memory_limit"]
- $STATS_CONF["slow_reports_time_limit"]
- $STATS_CONF["hello string"]
- $COUNTER["timeoffset"]
- $COUNTER["HTTPheaders"]
- $COUNTER["excludeurl"]
- $STATS_CONF["redirect"]
- $STATS_CONF["quiet"]
- $STATS_CONF["codegeneration"]
- $STATS_CONF["gdversion"]
- $STATS_CONF["code"]
- $STATS_CONF["cnstats_http_path"]
- Пример config.php
$STATS_CONF["cnsoftwaredomain"]="cnstats.com";
Программное обеспечение SQL сервера. На данный момент - только MySql.
Пример:
$STATS_CONF["sqlserver"]="MySql";
Имя базы данных, в которой CNStats хранит все данные. Имена таблиц CNStats имеют префикс "cns_", поэтому Вы можете использовать CNStats даже в том случае, если хостинг-провайдер предоставляет Вам только одну базу данных.
Пример:
$STATS_CONF["db_name"]="mysite_cnstats";
Префикс таблиц CNStats; используется при установке нескольких копий CNStats в одну базу данных. Значение по умолчанию - "cns_". При изменении префикса необходимо вручную изменить название всех таблиц CNStats.
Пример:
$STATS_CONF["sqlprefix"]="cns1_";
Адрес сервера баз данных. Как правило, предоставляется хостинг-провайдером.
Пример:
$STATS_CONF["sqlhost"]="localhost";
Логин для доступа к серверу баз данных. Для корректной работы CNStats Вы должны обладать правами на создание и удаление таблиц. Как правило, предоставляется хостинг-провайдером.
Пример:
$STATS_CONF["sqluser"]="root";
Пароль для доступа к серверу баз данных. Пароль может быть пустым (часто для пользователя root). Как правило, предоставляется хостинг-провайдером.
Пример:
$STATS_CONF["sqlpassword"]="";
Параметр задает период хранения полной статистики в днях. Чем дольше хранится полная статистика, тем больше места занимает база данных; как следствие - тем медленнее будут строиться отчеты.
Контролировать размер базы данных можно с помощью отчета "Размер базы данных".
Рекомендуемое значение - 40.
Пример:
$COUNTER["savelog"]=60;
Вы можете увеличить период хранения в любой момент. Не следует задавать слишком большой период хранения; как правило, для анализа достаточно 30-60 дней.
Вы можете также уменьшить период хранения в любой момент. Записи удаляются в полночь. В зависимости от настроек Вашей базы данных размер базы может не уменьшиться. Для уменьшения размера необходимо провести оптимизацию таблицы sql с помощью команды:
OPTIMIZE TABLE cns_log;
Тип счетчика.
- 0 - "GIF 1x1"
- 2 - "PHP-Include"
- 3 - "Комбинированный" ("PHP-Include" + "GIFx1x1")
Более подробно о типах счетчиков Вы можете узнать в разделе "Типы счетчиков"
Значение "1" не используется начиная с версии 3.0.
Список исключаемых IP адресов и сетей. Можно задать один или несколько диапазонов. Задавать следует попарно - адрес, затем маска.
Пример:
Для одного адреса:
$COUNTER["excludeip"]="127.0.0.1";
$COUNTER["excludemask"]="255.255.255.255";
Для одного адреса и одной сети:
$COUNTER["excludeip"][]="127.0.0.1";
$COUNTER["excludemask"][]="255.255.255.255";
$COUNTER["excludeip"][]="192.168.0.1";
$COUNTER["excludemask"][]="255.255.255.0";
Отключение авторизации CNStats ("yes" - отключить, "no" - не отключать).
При интеграции CNStats в движок сайта иногда удобнее самостоятельно организовывать авторизацию. В этом случае для предотвращения двойной авторизации можно отказаться от авторизации CNStats.
По умолчанию: "no"
Пример:
$COUNTER["disablepassword"]="yes"
E-Mail администратора. Используется в следующих моментах:
- Адрес получателя уведомлений об ошибках, возникающих при работе CNStats (при условии включенной опции $COUNTER["senderrorsbymail"]);
- Адрес, подставляемый в поля "Отправитель" и "Обратный адрес" в отчетах, посылаемых по электронной почте.
Пример:
$STATS_CONF["adminemail"]="jonh@example.com"
Если указан параметр "yes", то ошибки, возникающие при работе CNStats, отправляются на E-Mail, указанный с помощью параметра $STATS_CONF["cnsoftwarelogin"].
Если "no", то ошибки по почте не отправляются.
Пример:
$COUNTER["senderrorsbymail"]="yes";
Дополнение к SQL запросу записи в лог-таблицу. Вставляется в SQL инструкцию в чистом виде между "INSERT" и именем таблицы.
ПРИМЕЧАНИЕ: Неверно заданный параметр может повредить базу данных.
Пример:
$COUNTER["sqlwritelog"]="DELAYED";
Массив SQL инструкций, выполняемых сразу после соединения с сервером баз данных. Как правило, это опция используется для настройки локализации, если сервер баз данных по умолчанию настроен некорректно.
Пример:
$STATS_CONF["sqlinstructions"][]="SET NAMES cp1251";
$STATS_CONF["sqlinstructions"][]="SET CHARACTER SET cp1251";
Ограничение на объем используемой памяти для медленных отчетов. К таким отчетам относятся на данный момент только "Точки выхода" и "Пути по сайту".
Если используется integer, значение измеряется байтами. Вы также можете использовать сокращённую запись - K (для Килобайт) и M (для Мегабайт)
Пример:
$STATS_CONF["slow_reports_memory_limit"]="32M";
Ограничение на время выполнения (в секундах) для медленных отчетов. К таким отчетам относятся на данный момент только "Точки выхода" и "Пути по сайту".
Пример:
$STATS_CONF["slow_reports_time_limit"]=1800;
Параметр задает текстовую строку, которая выводится в диалоге ввода логина и пароля. Можно использовать HTML код. По умолчанию строка пустая.
Пример:
$STATS_CONF["hello string"]="Для просмотра статистики
используйте логин <B>guest</B> и пароль
<B>guest</B>.";
Смещение времени на сервере в секундах. Параметр задается в случае если сервер, на котором расположен Ваш сайт, находится в другом часовом поясе.
Пример:
$COUNTER["timeoffset"]=-1800;
Массив дополнительных HTTP-заголовков, отправляемых клиенту при использовании следующих типов счетчика:
- Комбинированный;
- GIF 1x1;
- PNG 88x31.
С помощью этого параметра можно установить дополнительные Cookies, язык, P3P данные и другую информацию, передаваемую через HTTP-заголовки.
Пример:
$COUNTER["HTTPheaders"]["Language"]="ru";
$COUNTER["HTTPheaders"]["P3P"]="policyref=\"/w3c/p3p.xml\", CP=\"UNI\"";
Шаблон для исключения страниц из статистики.
Пример:
$COUNTER["excludeurl"][]="PHPSESSID";
$COUNTER["excludeurl"][]="favicon.ico";
В данном примере из статистики исключены адреса, содержащие строки "PHPSESSID" и "favicon.ico".
Тип автоматического перенаправления (редирект) в интерфейсе просмотра статистики CNStats. Возможные значения:
- header (по умолчанию) - использовать HTTP-заголовок Location для автоматических перенаправлений.
- meta - использовать META-теги для автоматических перенаправлений; рекомендуется при использовании сервера IIS/5.0.
Данная опция была добавлена из-за неверной обработки Cookies во время перенаправлений сервером IIS/5.0. Более подробно об этой проблеме можно прочитать на сервере поддержки Microsoft.
Режим умолчания в SQL запросах; при включении этого режима информация о ошибках SQL сервера не выводится.
- Yes - режим включен. Рекомендуется использовать только в крайних случаях при нестабильной работе SQL сервера;
- No (по умолчанию) - режим выключен.
Пример:
$STATS_CONF["quiet"]="no";
Режим генерации кода счетчика (только при использовании комбинированного типа счетчика).
- html (по умолчанию) - генерировать и выводить JavaScript код;
- variable - генерировать JavaScript код и записывать его в переменную $CNSTATS_JAVASCRIPT_CODE;
- onlyid - генерировать только уникальный идентификатор обращения и записывать его в переменную $CNSTATS_JAVASCRIPT_CODE.
С помощью значения "variable" Вы можете вызвать PHP-часть счетчика в одном месте, а JavaScript-часть счетчика в другом месте. Например:
<?php
include "config.php";
// Вызов PHP-части кода счетчика
include "/../cnstats/cnt.php";
// Вывод HTTP-заголовка
header("Language: ".GetDocumentLanguage());
// Вывод верхней части документа
include "top.php";
// Вывод JavaScript-части
print $CNSTATS_JAVASCRIPT_CODE;
// Вывод тела документа
print DocumentBody();
// Вывод нижней части документа
include "bottom.php";
?>
С помощью значения "onlyid" Вы можете полностью изменять JavaScript-часть кода счетчика и выводить ее в любом месте. Например, Вы можете использовать JavaScript-код, совместимый с XHTML:
<?php
include "config.php";
// Вызов PHP-части кода счетчика
include "/../cnstats/cnt.php";
// Вывод HTTP-заголовка
header("Language: ".GetDocumentLanguage());
// Вывод верхней части документа
include "top.php";
?>
<a href="http://www.cnstats.com/" id="m">
<SCRIPT language="JavaScript" type="text/javascript">
cnsd=document;
cnsd.cookie='b=b';
cnsc=cnsd.cookie?1:0;
cnst=escape(cnsd.title);
cnst=cnst.replace(/\+/g,'%2B');
cnsa=navigator.appName;
cnsn=(cnsa.substring(0,2)=='Mi')?0:1;
cnss=screen;cnspx=(cnsn==0)?cnss.colorDepth:cnss.pixelDepth;
if (cnsd.getElementById)
{
var i=cnsd.createElement('img');
var iurl='/cnstats/cntc.php?i=<?php echo $CNSTATS_JAVASCRIPT_CODE;?>';
iurl+='&c='+cnsc+'&e='+cnss.width+'.'+cnss.height+'&d='+cnspx;
iurl+='&r='+escape(cnsd.referrer)+'&p='+escape(cnsd.location)+'&t='+cnst;
i.src=iurl;
i.width=1;i.height=1;i.border=0;
cnsd.getElementById("m").appendChild(i);
}
</SCRIPT>
</a>
<?php
// Вывод тела документа
print DocumentBody();
// Вывод нижней части документа
include "bottom.php";
?>
Параметр задает версию библиотеки GD:
- "0" - GD не установлена;
- "1" - Установлена GD версии 1.X;
- "2" - Установлена GD версии 2.X;
- "auto" - автоматическое определение версии GD (по умолчанию).
Пример:
$STATS_CONF["gdversion"]="auto";
Формат кода счетчика.
- "HTML" - код в формате HTML;
- "XHTML" - код в формате XHTML.
Параметр влияет на код счетчика, выдаваемый в разделе Конфигурация - Код счетчика, а также на код, генерируемый системой при использовании комбинированного типа счетчика.
Пример:
$STATS_CONF["code"]="XHTML";
Относительный путь CNStats на Вашем сайте. Путь определяется автоматически во время установки CNStats. После установки эту настройку изменять нельзя.
Пример:
$STATS_CONF["cnstats_http_path"]="/cnstats/";
<?php
// License domain. It should match the register key domain.
$STATS_CONF["cnsoftwaredomain"]="cnstats.com";
// SQL server software. So far only MySql is supported.
$STATS_CONF["sqlserver"]="MySql"
// Name of the database, where CNStats stores all data. Names of
// CNStats tables have $STATS_CONF["sqlprefix"] prefix, so it is
// possible to use CNStats even if your hosting-provider granted
// you access only to one database.
$STATS_CONF["dbname"]="my_cnstats";
// CNStats tables prefix
$STATS_CONF["sqlprefix"]="cns3_";
// Database server address. As a rule, it is granted by the
// hosting-provider.
$STATS_CONF["sqlhost"]="db12c.pair32.com";
// Database server login. You must have rights for creation and deletion
// of database tables for correct functioning of CNStats. These rights
// are usually granted by the hosting-provider.
$STATS_CONF["sqluser"]="mystats_2";
// Database server password. It may be blank (often for "root" users).
// As a rule, it is granted by the hosting-provider.
$STATS_CONF["sqlpassword"]="677conduge";
// It sets period of complete statistics storage per days. The longer the
// period, the more space is required for the database. The database size
// influences the system performance, it slows down with larger database.
// Database size can be monitored in the report "Database size".
$COUNTER["savelog"]=60;
// Counter type. (For more information, please, refer to
// http://www.cnstats.com/en/support/manual/countercodehow.php
//
// 0 - Blank GIF image
// 2 - PHP-include
// 3 - Combined (PHP-include + GIF)
$COUNTER["type"]=3;
// List of excluded IP addresses and networks. It is possible to set one
// or several ranges. It should be set in couples: IP-address first,
// than network mask.
$COUNTER["excludeip"][]="0.0.0.0";
$COUNTER["excludemask"][]="255.255.255.255";
// CNStats authorization disabling. "Yes" - authorization is disabled,
// "no" - authorization is enabled. Sometimes it is more convenient
// to use "in-house" authorization when you install CNStats into existent
// software engine. In such cases you may switch off CNStats authorization
// to avoid double authorization.
$COUNTER["disablepassword"]="no";
// E-Mail address for the system errors notifications (provided that
// $COUNTER["senderrorsbymail"] option is enabled).
$STATS_CONF["adminemail"]="admin@cnstats.com";
// If it is set to "yes", then CNStats errors will be reported to the e-mail
// set in $STATS_CONF["adminemail"] parameter.
$COUNTER["senderrorsbymail"]="yes";
// Addition to the SQL request to write in the log-table. It is inserted in
// the SQL instruction in plain format between "INSERT" and the table name.
// Note: Incorrect parameter can damage the database.
// $COUNTER["sqlwritelog"]="";
// Array of SQL-instructions, performed upon connection to the database server.
// As a rule, this option is used to configure localization in case the database
// server has incorrect settings.
// $STATS_CONF["sqlinstructions"][]="";
// Memory volume limit for slow reports. There are two of them - "Entry pages"
// and "Trace browsing". If integer is used, the value is measured in bytes.
// It is possible to use abbreviations - K (for kilobytes)
// and M (for megabytes).
$STATS_CONF["slow_reports_memory_limit"]="8M";
// Time limit for slow reports (seconds). There are two of them - "Entry pages"
// and "Trace browsing".
$STATS_CONF["slow_reports_time_limit"]="30";
// The parameter sets a text string which is displayed in the login dialogue.
// HTML code may be used. The string is blank by default.
$STATS_CONF["hello string"]="";
// The parameter sets guest login, which allows viewing statistics and using
// filters (creating, deleting). Other settings are not available for a guest.
// $STATS_CONF["HTTPheaders"]["0"]="";
// Template for pages exclusion from the statistics.
// $STATS_CONF["excludeurl"][]="";
// Automatic redirection type at the CNStats statistics interface.
// Possible values:
// - header (by default) - Location HTTP-header is used for automatic
// redirections.
// - meta - META-tags are used for automatic redirections; it is
// recommended in case IIS/5.0 server is used.
$STATS_CONF["redirect"]="meta";
// SQL requests hiding mode; when it is activated, SQL error data are not
// displayed.
// yes - the mode is enabled. It is recommended to use only in emergency
// cases, if SQL server is unstable;
// no (by default) - the mode is disabled.
$STATS_CONF["quiet"]="no";
// Counter code generation mode (only for combined counter type).
// html (by default) - JavaScript code is generated and displayed;
// variable - JavaScript code is generated and recorded to
// variable;
// onlyid - only request unique identifier is generated and
// recorded to variable.
$STATS_CONF["codegeneration"]="html";
// GD library version
// "0" - GD is not set
// "1" - GD version 1.X is set
// "2" - GD version 2.X is set
// "auto" - Automatic definition of GD version (by default)
$STATS_CONF["gdversion"]="auto";
// Counter code
// "HTML" - HTML friendly counter code
// "XHTML" - XHTML friendly counter code
$STATS_CONF["code"]="HTML";
// The catalogue, in which CNStats is installed.
$STATS_CONF["cnstats_http_path"]="/cnstats/";
?>