BILLmanager 6

Logging in BILLmanager

BILLmanager saves information about the platform in log files. The data from the log files can be used to diagnose the operation of the platform.

Logging configuration

The level of logging determines the extent of detail for the information displayed in the logs. The higher the value, the more detailed information recorded in the log.

Logging levels:

  • 1 — notes;
  • 2 — critical errors;
  • 3 — errors;
  • 4 — warnings;
  • 5 — information about requests;
  • 6 — extended information;
  • 7 — messages from remote services;
  • 8 — code tracing;
  • 9 — debugging information.
Note
Detailed logs take up more disk space. After completing the diagnostics, we recommend that you reset the logging level to the default value.

Enter Settings → Logging settings → select the modules → click:

  • Edit, to configure the logging level for the selected modules;
  • Default, to delete the logging settings from the config file for the selected modules. The * All modules value of the module's logging level will be used;
  • Maximum, to set the maximum logging level for the selected modules.

Editing the logging level for * All modules will result in a level change for all modules with the "Default logging configuration" status.

Changing the logging level via configuration file

Changing the logging level via the web interface is not available for all log files, as they may not be listed in the Logging setup section. You can change the logging level by adding an entry to the /usr/local/mgr5/etc/debug.conf file.

To change the logging level:

  1. Connect to the server with the platform via SSH. For more information about connecting via SSH, see Workstation setup.
  2. Add a line to the /usr/local/mgr5/etc/debug.conf file with the module name and the required logging level. For example, the entry for the pmvmmgr6.log module log file:

    pmvmmgr6.* 9


Changing the logging level for the platform's main /usr/local/mgr5/etc/billmgr.log will require a restart of the platform:

killall core

Changing the logging level for /usr/local/mgr5/etc/ihttpd.log will require a restart of the ihttpd web server:

systemctl restart ihttpd

To return the logging level to the default value, remove the added lines from the /usr/local/mgr5/etc/debug.conf file.

List of log files

The log files are stored in the directory /usr/local/mgr5/var/.

The archive log files are stored in /usr/local/mgr5/var/logs.

Main log files

File name

Contents

billmgr.log

operations of BILLmanager

billmaintain.log

log file of the sbin/billmaintain utility, which performs scheduled operations

billmgr.auth.log

BILLmanager authentication log

billmgr.long.log

log of long requests to the BILLmanager panel. By default, the log records operations that have exceeded five minutes

billfix.log

log of operations, which record data errors in BILLmanager

globalindex.log

log of the sbin/globalindex utility, which performs DB entries indexation for the Global search operation

ihttpd.log

ihttpd web server log

licctl.log

software license check and activation

longtask.log

background task processing

mgrctl.log

log file of the mgrctl utility, which interacts with BILLmanager

mysql.log

log of the sbin/mysql-billmgr, utility, which provides interactive connection to BILLmanager DB

mysqlstat.log

DBMS operation statistics

ntemail.log

emailing log

ntinternal.log

messaging to the Notifications module of BILLmanager

ntmessenger.log

messaging to messengers

ntsms.log

SMS messaging

pkgcheck.log

log of the etc/scripts/pkgcheck.sh utility, which records problems with software packages

pkg.log

managing BILLmanager software packages in the system using the OS package manager (debian/rhel)

qrcode.log

log of the cgi/qrcode utility for generation of a QR code during configuration of the Two-step authentication

remotetaskctl.log

log of the Task proxying module

usagestat.log

statistics collection log

xmlinstall.log

caching of xml-files to speed up the platform

Message gateways

Related articles:

File name

Module

gwclickatell.log 

Clickatel SMS gateway

gwdevinotele.log

Devino Telecom SMS gateway

gwgreensms.log

GREENSMS SMS gateway

gwmobilmoney.log

MobilMoney SMS gateway

gwqtelecom.log

QuickTelecom SMS gateway

gwsmsc.log

SMS-center SMS gateway

gwsmscustom.log

http-SMS SMS gateway

gwsmstraffic.log

SMS Traffic SMS gateway

gwturbosms.log

TurboSMS SMS gateway

gwlocalmail.log

Clickatel SMS gateway

gwremotemail.log

interacting third-party mail services (gmail, yandex, mail, etc.) via POP3, IMAP, SMTP

gwtelegram.log

Telegram gateway

telegram_webhook.log

log of the Telegram callback processing module 

Phone verification

Related articles:

File name

Module

fgsmsc.log

SMS-center (call)

fgtelesign.log

TeleSign

fgsmsgate.log

other SMS gateways

Service processing

Related articles:

File nameName of service processing module

pmauto.log

“Without processing”

pmazure.logMicrosoft Windows Azure Pack
pmbillmgr.logReselling via BILLmanager
pmcpanel.logcPanel
pmdcimgr6.logDCImanager 6
pmdcimgr.logDCImanager 5
pmdirecti.logResellerClub
pmdnsmgr.log DNSmanager
pmdrs.logDRS
pmenom.logEnom
pmenomssl.logEnom SSL
pmepp.logEPP-module
pmevonames.logEvoNames
pmglobalsign.logGlobalSign
pmgogetssl.log GoGetSSL
pmhostmaster.logHostMaster
pmipmgr.logIPmanager
pmispmgr4.logISPmanager 4
pmispmgr5.logISPmanager 5
pmispmgr6.logISPmanager 6
pmleadertelecom.logLeaderTelecom
pmmanual.log Manual processing
pmmastername.log.mastername
pmnamecheapdomain.logNamecheap (domain)
pmnamecheapssl.logNamecheap (SSL)
pmnaunet.logNauNet
pmnic.logRU-Center
pmnorid.logNorid
pmonlinenic.logOnlineNIC
pmopenprovider.logOpenProvider
pmopenstack.logOpenStack
pmopenstackvds.logOpenStack (VPS)
pmplesk.logPlesk
pmr01.logR01
pmregru.logREG.RU
pmresellerclub.logResellerClub
pmshellscripts.logShellScripts
pmthesslstore.logThe SSL Store
pmtucows.logTucows
pmukrnames.logUkrnames
pmvdsmgr.logVDSmanager
pmveeam.logVeeam
pmvmmgr6-iaas.logVMmanager 6 IaaS
pmvmmgr6.logVMmanager 6
pmvmmgr.logVMmanager
pmvmware.log VMware vCloud Director
pmvmwarevds.logVMware vCloud Director (VPS)
pmwebnames.logWebNames

Payment method

Log files of interaction between the billing platform and payment modules are described in the articles of the section Payment gateways.

Ticket management modules

Related articles:

File name

Contents

pmtelegram.log

log of the module for handling tickets via Telegram

telegram_support_webhook.log

log of the processing module for user messages sent via Telegram

Log management

Modules can record their events in different log files, so the name of the module in the logging settings may be different from the name of the log file.

Example of a string in the billmgr.log log file:

Mar 21 08:45:12 [2962:1] <module_name> <logging_level> Query: 'SELECT nc.* FROM notifytemplate nt JOIN notifycontent nc ON nc.notifytemplate = nt.id WHERE nt.notice = 'sitebui lderopen' AND nt.project IS NULL'
  • Mar 21 08:45:12 — date of the event in the system time of the server;
  • [2962:1] — log thread. A unique identifier, where
    • the first value is the process number in Linux. After restarting BILLmanager, the value will change;
    • the second value is the unique query number for the BILLmanager platform. Each query has its own number, so it can be tracked in the log.
  • <logging_level> — has the following levels:
    • NOTE — notes;
    • FATAL — critical errors;
    • ERROR — errors;
    • WARNING — warnings;
    • INFO — information about queries;
    • EXTINFO — extended information;
    • EXT — message from remote services;
    • TRACE — code tracing;
    • DEBUG — debugging information.

    Diagnostics

    This section gives an example of diagnostics with the main log of the billmgr.log platform. Other logs may also be required for diagnostics. For example, in case of payment problems, information about errors will be recorded in the logs of the payment module, and in case of problems with reselling services — in the log of the interaction between the selling and reselling billing systems. The list of all logs is located at /usr/local/mgr5/var/. For the names of the logs, see the corresponding section in the BILLmanager 6 documentation. For example, logs to diagnose Paymaster payment problems are listed in the PayMaster article.

    The main log of the platform billmgr.log records all the main events and errors. To check for errors in the main log, run the command:

    grep 'ERROR' /usr/local/mgr5/var/billmgr.log

    To check the logs at the moment, run the command:

    tail -f /usr/local/mgr5/var/billmgr.log

    Any problem can be diagnosed using the command to display the logs at the moment. To do this:

    1. Open the section in the BILLmanager interface where the incorrect behavior occurs.
    2. Connect to the server with the platform via SSH.
    3. Open the real-time log with the command tail -f /usr/local/mgr5/var/billmgr.log.
    4. Reproduce the incorrect behavior in the interface.

    As a result of these actions, the log will display an error and the request that precedes it. This will help identify the cause of the incorrect behavior.

    For detailed diagnostics, the above instructions can be used with any other log, such as the processing module log. 

    Useful tips

    Knowledge base articles: