User Tools

Site Tools


manual:tools

Tools

Bandwidth report

The bandwidth report module displays real-time bandwidth usage. You can specify the desired network port and whether you wish to view the download / upload, respectively incoming or outgoing traffic from the perspective of the HSMX gateway.

Connection test

Download log

The download log module is allows you to download the log archives (generated on a daily basis). It's recommended to configure automatic logfile upload to an external storage server.

  • Syslog
  • LAN Syslog
  • FIAS log
  • Lawful interception
  • Credit card
  • URL log
  • DNS log

Interface status

This graph displays the status of the interfaces in the system based on the link status and monitoring configured in network settings. Specify the date of the report, and press show. By default without extra configuration the displayed status is based on the carrier sense data of the interface. It triggers on (un)plugged network cables. If you configure the connectivity monitor the status will depend on the ICMP availability of the testing target.

Tip: When you go over the graph with your mouse it zooms in on that hour.

Logging

Here you can view all the system log files. The logging facilities are very useful for troubleshooting and debugging problematic subscribers. You can filter the entries based on date/hour, facility and urgency level you wish to view. You can also search a specific value in the log files. You can use regular expressions employ in the search field. To configure logging, read log settings.

There are several logs sources on the HSMX:

  • Syslog: Global log of the HSMX including portal events.
  • LAN Syslog: Logging of the individual subscriber networks
  • XML log: XML log is the communication log between an authentication system (or UMS) and the HSMX.
  • FIAS log: FIAS log is the communication log between the HSMX and the PMS system. It is also possible to download the FIAS log of the current date. If you have multiple systems configured use the drop-down element at the left-side bottom to select the correct PMS service.
  • Payment log: Payment log is a list of all payments that have occurred (PMS / credit card). If you have multiple payment providers use the drop-down at the bottom of the log-viewer to select the payment type.
  • Lawful interception: Lawful interception will show all connections of a user for legal reasons.
  • URL logging: URL log is a list of the visited websites.

Note:

  • When filtering on a severity level, it will show messages of the selected severity or higher.

Packet capturing

Portal debug

Portal debug is an advanced debugging feature of the portal page sessions. Since the portal debug generates so much data it is important you only enable it when you are debugging a specific issue that is guest related. The log shows you the exact user input and all the variables that are active at the time a guest is logging on.

Tips

  • % is the wildcard symbol in the search-fields.
    • Search on subscriber MAC address: %00112233EEFF% (without MAC grouping separators) in Session or GET variables.
    • Search on subscriber MAC address: %172.20.0.14% in Session or GET variables for a specific subscriber IP-address.

Reports

Task manager

The task manager lists the HSMX most critical services and background scripts. By using the action link on the right side of the service you can (re)start or stop the service.The task manager also gives a clear picture of memory and CPU usage of the system. Decrease the refresh rate if you are stuck on a blank page.

Description

Services

  • HSMX Core: Main service that should always be running responsible for managing the other services.
  • Syslog: The component responsible for logging. Should always be running.
  • Apache: The HSMX web-server that runs the web-management interface and the captive portals. Should always be running.
  • Database: The database should always be running and is responsible for storing transactional data.
  • FTP: The FTP server only runs when a custom captive portal is configured for FTP access.
  • Print daemon: Should be running when the Printing service is enabled.
  • DNS: This component allows subscribers to resolve their domainnames. Should always be running.
  • FIAS daemon: This component is responsible for maintaining the PMS or FIAS connection used for authentication and authorization.
  • Proxy server: The proxy server should always be running, this is a separate process from content-filtering. If any content-filters are configured they will be added to the list of processes with their configured name.

Scripts

  • Main script: The main script is started once upon boot and should run continuously
  • System health: This script is responsible for the status indicator in the top right corner of the web-interface. It should be run every minute and it should complete within seconds.
  • Health widget: The health widget data is collected, processed and stored every minute by this process.
  • System backup: This script is responsible for creating and managing backups.
  • System restore: Active when the system is being restored from backup.
  • Log handling: Collects, processes and stores log and performance data.
  • Log backup: Transports backups towards remote FTP locations on a regular interval if configured.
  • Packet capturing: Active when utilizing the packet capture facility.
  • Database optimize: This process cleans up the database and is scheduled to run daily, it's responsible for maintaining a coherent database state. Execution can take up to a few minutes.
  • Database optimize full: This process should only be started during scheduled maintenance since it deteriorates performance significantly. Overtime the database allocates resources to itself and over-consumes, running this script will keep the database service resource consumption in check. Be aware this script can take up to several hours to finish.
  • Lawful interception: Collects subscriber traffic data and processes it into log-files per subscriber.
  • Generating reports: Script responsible for generating reports.
  • Subscribers cleanup: This script expires subscribers.
  • Send mail/invoices: Sends out health alerts.
  • HSMX update: Active when executing an update to another HSMX release.
  • License check: Responsible for online authorization of the HSMX software license.
manual/tools.txt · Last modified: 2015/05/20 09:42 by ewald