Difference between revisions of "Reports"
Revision as of 17:36, 8 February 2016
|File:Reports 128x128.png Reports||
- 1 About Untangle Reports
- 2 Settings
- 3 Report Viewer
- 3.1 Conditions
- 3.2 Related Topics
- 3.3 Reports FAQs
- 3.3.1 What is the difference between Reports and Events?
- 3.3.2 Why is Reports taking up all of my server's resources?
- 3.3.3 Why am I not receiving an email with my Reports?
- 3.3.4 I just upgraded my NG Firewall and my reports are missing. Why?
- 3.3.5 What is the "others" column when looking at the charts in Reports?
- 3.3.6 The spam and phishing stats don't seem to add up. Why?
- 3.3.7 Why is the timestamp column not displayed properly in Excel when I open the CSV?
- 3.3.8 Can reports users change their password?
About Untangle Reports
Reports provides users with detailed statistics of the traffic on your network. These reports can be automatically emailed, viewed online, or broken down into CSVs for archival. The email reports are a simple overview of traffic with a breakdown in HTML format, while more granular viewing of the data can be done through a web browser.
This section reviews the different settings and configuration options available for Reports.
On this tab you can click View Reports to open up Reports in a new browser tab.
In version 11.2, the "old" reports functionality and the buttons below are still available. This will be removed in version 12.0.
Click View Old Reports to access the old reports interface or click Generate Today's Reports to partially generate report data up until the point you click the button. As noted, manually generating reports will take up resources on the Untangle box, possibly slowing down your network until it is finished.
- Daily Reports: Daily reports will be generated on the checked days of the week.
- Weekly Reports: Weekly (7-day) reports will be generated on the checked days of the week.
- Monthly Reports: If checked, A report covering the previous month will be created on the 1st of every month.
- Generation Time: This allows you to specific the time Reports are generated.
- Data Retention: This value controls how much time report data is kept on disk, which is used to generate per-host, user and email reports on the fly. Please note that increasing the number increases the amount of disk space that is needed for data storage, and could have negative effects - we recommend leaving this at 7 days. If you'd like to archive full traffic data, please see the Attach Detailed Report Logs feature mentioned above.
- Please note your Retention Data setting should be at least 7 or 30 days to get full Weekly or Monthly reports.
You can use the Add button to add users who want access to Reports. Email Reports will send them an HTML summary of the reports, whereas Online Reports will give them access to the online reports.
- Attach Detailed Report Logs: This checkbox enables the sending of CSVs in a zip file attached to the emailed summary reports. Online reports have CSVs (comma separated value spreadsheets) which contains all the data used for generating the tables and graphs in the reports. The CSVs enable admins to perform further analysis on the traffic patterns.
- Attachment size: This field limits the size of the CSVs attached to the email. The CSVs zip file can be large and email servers will not usually accept very large attachments. Set this field to the largest attachment size that your mail server(s) will accept. If the zip file is larger than this setting the zip file will not be attached and a warning will be appended to the email.
Reports supports the sending of all events via syslog messages. To use syslog simply install a syslog receiver on another server, then enable syslog and configure as necessary.. Some syslog products are easier to set up than others. Kiwi, a third-party syslog daemon, is a favorite of many Untanglers using Windows, while those on *nix can use rsyslog.
- Host: The host name or IP address of the Syslog daemon that is authorized to receive syslog messages from the Untangle Server. Do not set the Host to the Untangle box itself - this will result in the hard drive filling up very quickly and most likely crashing the box.
- Port: The UDP port to send syslog messages to the syslog daemon. 514 is the default as this is the default syslog port.
- Protocol: The protocol to use to send syslog messages. The default is UDP.
You can use the Name Map to replace IPs with names in the reports.
Note: Untangle often can automatically determine the hostname for the IP automatically via DHCP or other methods. You can view the current names for currently active hosts in the Host Viewer
However, when Untangle is unable to automatically determine a hostname for an IP the Name Map provides a way to manually name them. You can manually set Hostname > IP mapping in Reports.
Here you can manage the reports that are displayed in each application. Each report is broken out by category and listed in the same display order you will find on the corresponding reports tab.
With the Enabled check box, you can remove reports from the display within each app. This will remove reports from the Reports tab without deleting the report, useful for unused reports.
View can be used to bring up any report without leaving the Reports app. This is useful for easily viewing and comparing reports across different apps.
Edit is a very powerful tool, allowing you to manipulate nearly every aspect of a report.
You can also use the Edit button to copy a report as well. This allows you to keep the original report while also having a customized version to meet your needs. Click Edit, then Copy Report. Update the report title and other fields as necessary.
For custom reports, the Delete button can be used to permanently delete a report. Note that Untangle pre-defined reports can not be deleted from the system.
Alert rules are evaluated on all events logged in the database and will log and/or alert the administrator when interesting or noteworthy events occur.
Each logged event is represented by a JSON object. As each event is logged to the database the alert rules are evaluated. The Event Logging page details all of the logging events. If an alert rule matches the logged event the action(s) configured in the alert rule is performed.
Log Alert logs the event to the Alert Event Log
Send Alert sends an email to all administrators' emails describing the event.
Limit Send Frequency limits the number of times a rule can send an alert email To once per the configured amount of minutes. For some cases, like a low disk space alert, this is useful to limit the number of alerts sent so that an alert is not sent every minute.
Adding Alert Rules
Since alerts are created on the raw messages passed through the system before logging, adding alerts can be a bit tricky. An example is helpful to describe how alert rules are created.
One of the included alert rules is the "WAN is offline" alert. This triggers whenever a WAN interface has been disconnected.
In the conditions, you can see we are looking for two Field conditions. All conditions for alert rules will be field conditions, which simply means an entry in the logged event represented by a JSON object (there are no other choices in the drop down). In nearly all cases you will have a field condition with a class, which represents an application or system process responsible for logging and one or more additional conditions to alert.
Going back to our example, you can see the alert rule is monitoring the class FailDEvent which is created by WAN Failover. Within that class we are looking for any log event object that contains an action = DISCONNECTED. In this case that means a WAN was found to be disconnected by WAN Failover and an alert is triggered.
You can view the Event Logging page for various classes and conditions that can be monitored for alert events.
If you are having problems adding a specific alert, or have common alert rules you would like added to the default rules, let us know on the forums or through the support team.
If a user is set up to receive email reports, they only need to view or download the HTML attachment to see an overview report. If they need more information or would like to drill down to specific users or machines, they can use the link in the email, which will open Reports on the Untangle if it is accessible from their location. Administrators can use the View Reports button in Reports settings to open the Reports.
To access Reports directly from a browser, you have two options:
- Outside the Untangle's network: Browse to the IP of the Untangle /reports using HTTPs, such as https://192.0.2.1/reports.
- Inside the Untangle's network: Browse to the IP of the Untangle /reports, such as http://192.168.1.1/reports.
Please note that to view Reports from outside the network you'll need to check Allow HTTPS on WANs at Config > Network > Advanced > Filter Rules. If you have changed the External HTTPS Port, you'll need to use the proper HTTPS port when connecting from the outside.
Reports provide a graphical view of the network traffic and actions of your NG Firewall. Various reports are available within applications and base system components. The reports can be manipulated to drill down, customize, and export data in many ways using the Report Viewer.
There are a few panels in the Report Viewer:
- The top panel: This top panel (just below the navigation menu) allow you specify which data is viewed. By default, there is just a timeframe and no conditions, so reports will show all data for the specified timeframe. Conditions can be viewed to view more specific data, such as a specific host, user, domain, application, web category, etc.
- The left panel: This allows you to choose the report you wish to view. At the bottom you can use the search box to quickly find reports with the specified string in the title. You can also import and create new reports using the "Add/Import" button.
- The chart panel: This panel shows you the specified report. It also includes several action buttons at the top.
- The data panel: The data panel, hidden by default, can be displayed by clicking on the "Data View" button in the chart panel. This will show the raw data used to generate the chart and allow the user to export the data by clicking the "Export Data" button at the bottom.
The Conditions panel appears at the top panel and can be used to filter data displayed in reports. For example, to view a "specific" host's report, you can add a condition for Client = "192.168.1.100" and then all reports available will only show data where the client is 192.168.1.100. Multiple conditions can be added to drill down and inspect data. Conditions can also be added quickly by clicking on slices in pie charts.
The Add Condition dropdown contains many commonly used conditions, or the full list of all tables and columns can be browsed by clicking on the "More" button to add conditions for any database column.
Note: Conditions will not apply to all reports. For example, If viewing a specific users report by adding a condition where Username = foobar - many reports will be greyed out and unviewable. This is because the data used to generate those reports is not relevent to the specific user (it does not contain a username column). For example, the CPU usage report is a system report that is not relevant to a specific network user and so there is no way to filter that data by user.
The second field in the condition is the logical operator that will be used in evaluating the condition value defined in the last field. In most use cases the default "=" operator is what you want to use. However, there are several other operators available that make the reports and alerts a whole lot more powerful.
A detailed outline of each operator is on the Operators page.
Conditions Example - Rack by Policy ID
In many cases, you may just want to see the traffic related to a specific policy within policy manager. This can be accomplished very easily by adding a condition using the Quick Add feature.
- In the Conditions panel, select Add.
- Choose Policy ID and specify equals and the policy ID in question.
- The conditions is applied and will remain applied as you switch between reports.
Conditions Example - Web Filter Categories
From pie charts, you can quickly add a condition from the Current Data window. This can be handy for use with the Web Filter category selection which we'll use for this example. Once the condition is applied, we can then use other reports to drill down to find out more information about the traffic such as which user might be responsible.
- Open Report Viewer or the Web Filter Reports tab.
- Select the Top Categories report (by size or requests). In our example, you can see Games was at the top.
- Click on the Games pie slice, and when prompted to add a condition click Yes.
- All Reports can now be viewed for Games only traffic.
- For example, the Top Clients (by request) will show the clients that visited the most gaming sites.
- For exmaple, the Web Usage (scanned) will show "Gaming" web usage throughout the day of the network.
What is the difference between Reports and Events?
Events and Reports are now the same. They provide real-time data for each individual application. The Events view will show the individual events that make up the reports, while reports will show a graphical interpretation of summarized events.
Why is Reports taking up all of my server's resources?
Check your Data Retention setting - if it's too high it will cause a lot of issues. Try setting it to the default of 7 to see if that helps.
Why am I not receiving an email with my Reports?
If NG Firewall is set to email you and you're not receiving the emails, try the Email Test at Config > Email - if you get the test mail successfully, you should also get the email from Reports. If not, you can check /var/log/exim4/mainlog and look for the error, or contact Support.
I just upgraded my NG Firewall and my reports are missing. Why?
An update may have changed how Reports stores data - the next time scheduled reports are run the report index will be rebuilt, which will allow you to access the older data. Please allow one complete reporting cycle (Daily, Weekly or Monthly) if you only run that type of report.
What is the "others" column when looking at the charts in Reports?
When looking at the Top 10 of a Reports chart, others is made up of everything else not listed. You can see the Top 9 sites visited by users in a day, while others is there to give us a baseline, for example if we saw one or two users with a larger percentage than others, we'd probably want to do some investigating as to why that user is pushing more web traffic than a large portion of the organization (relative to total organization size).
The spam and phishing stats don't seem to add up. Why?
You may notice that Reports contains a certain number of phish or spam email, however the Event Logs/CSVs show a different number. This is because the graphs show the actual number of emails while the Event Logs/CSVs treat each recipient as an individual email so per-user/host reports are correct. An example is a single spam email sent to two users - it will only be counted as one (email) in the Reports, but two (delivered emails) in the Event Logs/CSVs.
Why is the timestamp column not displayed properly in Excel when I open the CSV?
To solve this please change the format of the first column to the Date format.
Can reports users change their password?
Reports users cannot change their own password. They must contact the administrator to update the password on their behalf.