Step 7 Select OK to return to the Domain Manager window or Cancel to quit.
When logging is enabled and the desired logging intervals are set, TrafficDirector automatically initiates logging. Logging continues until you disable it from the Install Domain or Deinstall Domain window, regardless of whether reports are generated. When you generate reports, you create them from information that was previously logged and stored.
Understanding Log Files
Logs are stored in log files in subdirectories under $NSHOME/db. The program dvlogd creates all subdirectories as required.
Each log file is an independent snapshot of certain network statistics. Log files have a binary format. The reporting program reads and processes log files to produce reports.
The pathname for each log file is:
$NSHOME/db/agentname/domainname/YYMMDDHH.mmT
where:
YY = year (95, 96,...)
MM = month (01 - 12)
DD = day of month (01 - 31)
HH = hour of day (00 - 23)
mm = minute (00 - 59)
T = statistics type:
- E = Ethernet segment statistics
T = Token Ring segment statistics
H = Host statistics
C = Conversation statistics
For example, log file $NSHOME/db/agent101/TCP/95013016.15E is the log of Ethernet segment statistics for agent agent101, domain TCP, taken at 4:15 PM, January 30, 1995.
Logging Status Messages
The logging daemon (dvlogd) also writes status messages to the file $NSHOME/usr/dvlog.log. You can examine this file periodically to ensure that the daemon is functioning properly.
A sample excerpt from a status log (dvlog.log) is:
The Logging Control FileL
The file $NSHOME/usr/dvlog.ctl serves as a keep-alive control file shared by dvlogd and tdir. It ensures that exactly one logging daemon is active at each logging interval.
Creating Reports
TrafficDirector's Report Generator lets you create reports interactively based on a wide variety of statistical and other information gathered by SwitchProbes and IOS RMON agents. In order to generate reports, you must first use the log function to gather historical information from the agents, and store that information in log files. The report function obtains information from the log files, formats it, and provides either display, printed, or file output.
You can also create reports from the command line. This is described in the section "Creating Reports from the Command Line" later in this chapter.
You can view and print graphical representations of four types of reports directly from the Report Generator main window. The reports that you can graph are:
- Segment Statistics
- Segment Details
- Conversations
- Host
Creating a Report Using Report Generator
This section provides an overview of how to set up, configure, and generate a report. Instructions for specific reports are covered in the sections that follow.
To generate a report:
Step 1 Select Domain Manager from the TrafficDirector Main window. The Domain Manager main window appears.
Step 2 Select the agent and domain combination for which you want to generate a report.
Step 3 Verify that logging is enabled for the domain you selected (see "Enabling Logging").
Step 4 Wait a minimum of two logging intervals after you enable logging, to ensure that you have valid data. For example, if you enable Statistics logging with a 15-minute logging interval you have to wait at least 30 minutes before you generate a report that requires Statistics information.
Step 5 On the Tools menu, select Report Generator. The Report Generator main window appears.
- The Report Generator window contains a File menu, which lets you exit the Report Generator, and two selection buttons:
- Configure lets you configure your report as described in the next section. When you configure a report, you modify the default format parameters you specified when you created the configuration file. You can configure all the reports except the Segment-Statistics and Segment-Details reports.
- Generate generates the report. It is stored in the file you specify in the file name field under Output.
Step 6 Fill in the fields in the Report Generator window as appropriate for the report you want to generate.
- These fields are:
| Start Time/End Time |
Specifies the starting and ending times for the report, in DD MMM YY HH:mm format. For example, 11:00 PM, January 14, 1995 is represented as 14 Jan 95 23:00. Both start and end time are mandatory. |
|
You can pop up a selection list showing available times by clicking on the ellipsis button (indicated by ...) following the entry field. Click on one of the times in the selection box. |
|
The actual time base for the report corresponds to the logs taken on or after the starting time you specify. |
| Lines Per Page |
For paginated reports, this specifies the number of lines on each page, including headers and footers, if any. The default is 66. If you specify the value 0, the report is not paginated. There is no upper limit. |
| Header/Footer |
Lets you specify a customized header or footer for the report. No defaults are provided. You can use any characters and make the header or footer as long as you like, or you can omit them entirely. |
| Output |
Directs the report to be output to a file, a printer, or to an e-mail address. |
|
The File Name parameter beneath the output selections can specify the name of a file to contain ASCII or comma-separated values (CSV) output. For example, you could specify the file my_report.txt, to be created in the $NSHOME/reports s directory. If you direct the output to a printer or to an e-mail address, you must use the correct format in the output file name, as shown in the examples below. If the output parameter value is enclosed in square brackets, for example, "[lpr -Dprinter2 %]", it is interpreted as a hard-copy command that operates on a temporary file. The character % stands for the name of the temporary file. Note that the command need not actually result in a printed hard copy. Examples of output specifications: "[lpr %]" -- print on default printer "[cat % | rsh somehost enscript]" -- convert to PostScript on remote host and print. "[mail -s Monday-Report someone < %]" -- Enclose the report in a mail message to someone. |
| Report Type |
Select the type of report to be generated. Each report type is described in Table 14-1. The report types are: |
|
Segment-Statistics Segment Details Conversation Host Host-Verbose Host-Outbound Multi-Domain Billing |
| Report Format |
Select the format in which you want the report: |
|
ASCII. Generates the report in standard ASCII format. CSV. Generates the report in comma-separated format. Use this format if you want to import the report into a spreadsheet such as Excel. This procedure is described in the section "Creating Charts of Reports in Microsoft Excel" later in this chapter. GRAPH. Generates a graphical view of the report data. Available only for Segment Statistics, Segment Details, Converstions and Host reports. |
|
The Segment Statistics and Billing reports can be generated only in ASCII format, and the Segment-Details report can be generated only in CSV format. All other reports can be generated in either format. The only delimiter available for CSV-format reports is the comma. |
Step 7 Click on Generate to generate the report.
Configuring Your Report
All reports except the Segment Statistics report use a Report Configuration file. You can accept the default configuration parameters contained in the report configuration file, or you can modify them.
To modify the default configuration of these reports:
Step 1 Bring up the Report Generator window as described in the previous section.
Step 2 Select the Report Type that you want to configure. The current configuration for the Report Type you've selected appears.
Step 3 From the Report Generator window, click on Configure. The Report Configuration window appears.
- The Report Configuration Window consists of four subwindows:
| Sort Hosts |
This subwindow is available for Host (summary), Host-Verbose, and Host-Outbound report configuration. Determines the field on which host data is sorted in the report. The default is Outbound Utilization. |
|
The selections are: · MAC Address Order. Sorts hosts in order of their MAC addresses. · Discovery Order. Sorts by the time that each host was discovered. · Outbound Packets. Sorts by total (absolute) outbound packets from each host. · Inbound Packets. Sorts by total (absolute) inbound packets to each host. · Inbound Utilization. Sorts by the percent of inbound bandwidth (10 Mbits/sec) to each host. · Outbound Utilization. Sorts by the percent of outbound bandwidth (10 Mbits/sec) to each host. · Outbound Bcasts. Sorts by the number of outbound broadcasts from each host. · Outbound Errors. Sorts by the total (absolute) number of errors outbound from each host. · Top N Hosts. Sorts in the order of Top N hosts. The entry box following this field lets you enter the number of hosts to include in the report's statistics. The default value is 20. |
| Sort Conversations |
This subwindow is available for Conversations report configuration. Determines the field on which host conversation data is sorted in the report. The default is Total Utilization. |
|
The selections are: · MAC Address Order. Sorts conversations in order of each host's MAC address. · Total Packets. Sorts conversations by the absolute number of packets for a conversation interval. · Total Bytes. Sorts conversations by the absolute number of bytes for a conversation interval. · Total Utilization. Sorts conversations by the total percent of bandwidth (10 Mbits/sec) for a conversation interval. · Total Errors. Sorts conversations by the total number of errors for a conversion interval. · Top N Hosts. Sorts in the order of Top N hosts. The entry box following this field lets you enter the number of hosts to include in the report's statistics. The default value is 20. |
| Segment Details |
Specifies the interval at which report data is presented. For example, if you select an interval of 30 minutes, the report will present data collected at 30-minute intervals. The default is 15 minutes. This subwindow is available only for the Segment Details report configuration. |
| Files |
Specifies the file names containing information needed for Multi-Domain and Billing reports. This subwindow is available only for those two reports. |
|
The fields are: · Distance File. Default is distance.act. · Location File. Default is iploc. · Tariff File. Default is tariff.act. · Tree File. Default is tree.cfg. The first three fields are active only for the Billing report type. They specify data used in calculating billing statistics. The Tree file is active only for the Multi-Domain report. It describes the hierarchy of domains for the specified agent. These files are described in detail in the sections that describe these reports. Each of these fields is mandatory for its respective report type. |
Note Only the subwindows relevant to the report type you specified in the Report Generation window are active in the Report Configuration Window. The others are grayed out.
Step 4 When you have completed your selections and entries on the Report Configuration Window, click on OK to confirm your choices or Cancel to revoke them. In either case, you return to the Report Generation window.
Step 5 Select Generate to generate your report using the configuration you specified.
The following sections describe each of the report types and list the report configuration parameters specific to the report type.
Creating a Graphical Report
You can view a graphical version of the Segment Statistics report, the Segment Details report, the Conversations Report, and the Host (summary) report.
To view a graphical report:
Step 1 Select GRAPH in the Report Format subwindow of the Report Generator window.
Step 2 Click on View in the Report Generator window. The graphical report appears.
Selecting Graph Properties
You can customize your graph using the Properties menu. Not all properties are available for all graph types. See the sections on the individual graph types for details on the selections available for each graph type. The selections are:
| Bar Chart |
Presents the report in the form of a bar chart. This is the default for the Segment Statistics report, the Conversations report, and the Host report. |
| Plot Chart |
Presents the report in the form of a plot chart. This is the default for the Segment Details report. |
| Stack Bar Chart |
Presents the report in the form of a stacked bar chart. |
| Pie Chart |
Presents the report in the form of a pie chart. |
| Transpose |
Transposes the variables for the type of chart you selected. The default is off (non-transposed). |
| Invert |
Inverts the axes for bar chart graphs. The default is off (non-inverted). |
| 3D |
Presents bar chart graphs in 3-D format. The default is off (2-D representation). |
Selecting Graphed Parameters
For all reports except Segment Statistics, you can use the View menu to select the parameters to be displayed in the graph. Not all parameters are available for all graph types. See the sections on the individual graph types for details on the selections available for each graph type. The selections are:
| Utilization |
Graphs percent utilization. This is the default for all reports. |
| Packets |
Graphs the total number of each type of packet sent. The packet types are represented in two graphs. The packet types displayed depend on the type of report. |
| Packet Size |
Graphs the total number of each size packet. This is available only for the Segment Details report. |
Generating a Segment Statistics Report
The Segment Statistics report provides a summary of segment traffic for the selected agent and domain during the report period. An example of this report is:
To generate a Segment Statistics report, follow these steps:
Step 1 From the TrafficDirector Main window, select Domain Manager. The Domain Manager window appears.
Step 2 Click on Install to verify that logging is enabled for this report. (See "Enabling Logging".)
Step 3 Wait a minimum of two logging intervals after you enable logging to ensure that you have valid data. For example, if you enable Statistics logging with a 15-minute logging interval, you have to wait at least 30 minutes after enabling logging before generating a report that requires Statistics information.
Step 4 On the Domain Manager window, select the agent and domain for which you want a report.
Step 5 From the Tools menu on the Domain Manager window, select Report Generator. The Report Generator window appears.
Step 6 Fill in or change the fields needed for this report:
- In the Report Type subwindow, select Segment Statistics.
- Fill in the Start Time and End Time fields. You can either enter a start and end time manually or pop up a selection window by clicking on the ellipsis (...) at the end of the field entry box.
- If you want your report to be paginated, fill in the number of lines per page, including header and footer, if any. The default is 66. If you want an un-paginated report, enter 0.
- If you want a header or footer, enter the text you want in the Header and Footer fields. The default is no header or footer.
- In the Output subwindow, select the device to which you want the output sent:
- File. Send the report to the file name you specify.
- Printer. Send the report to your default printer.
- Mail to. Mail the report to the user you specify.
- The entry field following these selections initially shows the default file name, printer, or e-mail address to which the output will be sent. Either accept this value or supply a new one. Examples of the formats for each type of output are presented in the section "Creating a Report Using Report Generator" earlier in this chapter.
Caution If you are capturing several intervals of logging data to a file, be sure to change the file name for each interval; otherwise, you will overwrite the previous file with the same name.
- In the Report Format subwindow, select one of the following:
- ASCII. Generates the report in standard ASCII format.
- CSV. Generates the report in comma-separated format. Use this format if you want to import the report into a spreadsheet such as Excel.
- GRAPH. Creates a graphical report. See the next section.
Step 7 If you selected either ASCII or CSV, click on Generate. TrafficDirector generates your report.
- If you selected GRAPH, click on View to display the graphical report.
Creating a Graphical Segment Statistics Report
You can view a graphical version of the Segment Statistics report.
To view a graphical Segment Statistics report, follow the steps to generate:
Step 1 Select GRAPH in the Report Format subwindow in the Report Generator window.
Step 2 Click on View in the Report Generator window. The graphical report appears.
Segment Statistics Graph Properties
You can customize your Segment Statistics graph using the Properties menu. (The View menu is not available in the Segment Statistics graph). The selections available for a Segment Statistics graph are:
| Bar Chart |
Presents the report in the form of a bar chart. This is the default. |
| Stack Bar Chart |
Presents the report in the form of a stacked bar chart. |
| Pie Chart |
Presents the report in the form of a pie chart. |
| Transpose |
Transposes the variables for the type of chart you selected. The default is off (non-transposed). |
| Invert |
Inverts the axes for bar chart graphs. The default is off (non-inverted). |
| 3D |
Presents bar chart graphs in 3-D format. The default is off (2-D representation). |
Generating a Segment Details Report
The Segment Details report provides more information than does the Segment Statistics report. This report is in comma-separated form (CSV) so you can use it as input to a spreadsheet, database, or word-processing program.
The following is an example of a Segment Details report.
The first several lines of this report are headings for the data that follows. Each data record (which may extend over more than one line) begins with the date and time of the logged record.
To create a Segment Details report, follow these steps:
Step 1 From the TrafficDirector Main window, select Domain Manager. The Domain Manager window appears.
Step 2 Verify that logging is enabled for this report. (See "Enabling Logging".)
Step 3 Wait a minimum of two logging intervals after you enable logging to ensure that you have valid data. For example, if you enable Statistics logging with a 15-minute logging interval, you have to wait at least 30 minutes after enabling logging before generating a report that requires Statistics information.
Step 4 From the Domain Manager window, select the agent and domain for which you want a report.
Step 5 From the Tools menu on the Domain Manager window, select Report Generator. The Report Generator window appears.
Step 6 In the Report Generator Main Window, fill in the fields as appropriate for this report.
- In the Report Type subwindow, select Segment Details.
- Fill in the Start Time and End Time fields. You can either enter a start and end time manually or pop up a selection window by clicking on the ellipsis (...) at the end of the field entry box.
- In the Output subwindow, select the device to which you want the output sent:
- File. Send the report to the file name you specify.
- Printer. Send the report to your default printer.
- Mail to. Mail the report to the user you specify.
- The entry field following these selections initially shows the default file name, printer, or e-mail address to which the output will be sent. Either accept this value or supply a new one. Examples of the formats for each type of output are presented in the section "Creating a Report Using Report Generator" earlier in this chapter.
Caution If you are capturing several intervals of logging data to a file, be sure to change the file name for each interval; otherwise, you will overwrite the previous file with the same name.
- In the Report Format subwindow, select one of the following:
- CSV. Generates the report in comma-separated format. Use this format if you want to import the report into a spreadsheet such as Excel.
- GRAPH. Creates a graphical report. See the next section.
Note Since Segment-Details reports are not paginated, the lines per page, header, and footer fields are grayed out. All Segment-Details reports are in CSV format, so the ASCII selection in the Report Format subwindow is also grayed out.
Step 7 If you want to change the interval at which report data is presented, select the Configure button. The Configuration window appears. The available intervals are:
- 15 minutes (the default)
- 30 minutes
- 1 hour
- 2 hours
- 4 hours
- 8 hours
- 1 day
Step 8 Click on OK to change the report interval to the value you've selected, or Cancel to leave the Report Configuration window without changing the interval. You return to the Report Generator window.
Step 9 From the Report Generator window, select Generate. TrafficDirector generates your report.
- If you selected GRAPH, click on View to display the graphical report.
Creating a Graphical Segment-Details Report
You can view a graphical version of the Segment-Details report.
To view a graphical Segment-Details report:
Step 1 Select GRAPH in the Report Format subwindow in the Report Generator window.
Step 2 Click on View in the Report Generator window. The graphical report appears.
Segment Details Graph Properties and Parameters
You can customize your graph using the Properties menu. The selections available for a Segment Details Graph are:
| Plot Chart |
Presents the report in the form of a plot chart. This is the default. |
| Bar Chart |
Presents the report in the form of a bar chart. |
| 3D |
Presents bar chart graphs in 3-D format. The default is off (2-D representation). |
You use the View menu to select the parameters to be displayed in the Segment Details graph. The selections are:
| Utilization |
Graphs percent utilization in the segment. This is the default. |
| Packets |
Graphs the total number of each type of packet sent. The packet types are represented in two graphs. The packet types are: |
|
· Graph 1:PacketsUnicastMulticastBroadcast |
|
· Graph 2:CRC Alignment ErrorsFragmentsUndersizeJabbersOversizeCollisions |
| Packet Size |
Graphs the total number of each size packet. The sizes graphed are: 64, 65, 128, 256, 512, and 1024 bytes. |
Generating a Conversation Statistics Report
The Conversation Statistics report provides a summary of traffic between hosts for the selected agent and domain during the report period. Each pair of hosts that have talked during the period is included. The list is sorted according to the sort metric you specified. You can elect to include all conversations, or only the top N conversations according to the sort metric.
The list provided by this report is collated, with statistics for both halves of each conversation listed together.
For the Conversation report, you can specify one of the following as the field to use as the Sort metric:
- Total packets (the default)
- MAC address order
- Total utilization
- Total bytes
- Total errors
- Top N. The number of top conversations to be included in the report, for example, 10 or 50, to be sorted according to the sort metric you select. If this field is blank, TrafficDirector lists all conversations.
You specify the sort metric from the Report Configuration window.
Note If you specify the sort metric MAC Address Order, each conversation is listed twice so that it can be located by either host.
Each conversation is listed in this format:
The first line shows traffic from Host A to Host B; the second line shows traffic from Host B to Host A. The Total line shows total traffic in both directions.
The following example shows an actual Conversation report in CSV format for all domains associated with the agent probe206, for the period from 4:00 P.M. on 12/16/94 through 4:00 P.M. on 01/06/95, sorted by Utilization percentage.
To create a Conversation Statistics report, follow these steps:
Step 1 From the TrafficDirector Main window, select Domain Manager. The Domain Manager window appears.
Step 2 Verify that logging is enabled for this report. (See "Enabling Logging".)
Step 3 Wait a minimum of two logging intervals after you enable logging to ensure that you have valid data. For example, if you enable Conversation logging with an 8-hour logging interval, you have to wait at least 16 hours after enabling logging before generating a report that requires Conversation information.
Step 4 From the Domain Manager window, select the agent and domain for which you want a report.
Step 5 From the Tools menu on the Domain Manager window, select Report Generator. The Report Generator window appears.
Step 6 Fill in or change the fields needed for this report:
- In the Report Type subwindow, select Conversation.
- Fill in the Start Time and End Time fields. You can either enter a start and end time manually or pop up a selection window by clicking on the ellipsis (...) at the end of the field entry box.
- If you want your report to be paginated, fill in the number of lines per page, including header and footer, if any. The default is 66. If you want an un-paginated report, enter 0.
- If you want a header or footer, enter the text you want in the Header and Footer fields. The default is no header or footer.
- In the Output subwindow, select the output device:
- File. Send the report to the file name you specify.
- Printer. Send the report to your default printer.
- Mail to. Mail the report to the user you specify.
- The entry field following these selections initially shows the default file name, printer, or e-mail address to which the output will be sent. Accept this value or supply a new one. Examples of the formats for each type of output are presented in the section "Creating a Report Using Report Generator" earlier in this chapter.
Caution If you are capturing several intervals of logging data to a file, be sure to change the file name for each interval. If you don't, you will overwrite the previous file with the same name.
- In the Report Format subwindow, select one of the following:
- ASCII. Generates the report in standard ASCII format.
- CSV. Generates the report in comma-separated format. Use this format if you want to import the report into a spreadsheet such as Excel.
- GRAPH. Creates a graphical report. See the next section.
Step 7 To specify the method of sorting for your report, select Configure. The Report Configuration Window appears.
Step 8 Select the sort metric for your report. You can also select the number of conversations to include in the report. The default is the top 20 conversations. If you leave this field blank the report includes all conversations in the specified time period.
Step 9 Click on OK to update the configuration, or Cancel to quit without changing the existing values. You return to the Report Generator window.
Step 10 If you selected either ASCII or CSV, click on Generate. TrafficDirector generates your report.
- If you selected GRAPH, click on View to display the graphical report.
Creating a Graphical Conversation Statistics Report
You can view a graphical version of the Conversation Statistics report.
To view a graphical Conversation Statistics report:
Step 1 Select GRAPH in the Report Format subwindow in the Report Generator window.
Step 2 Click on View in the Report Generator window. The graphical report appears.
Conversation Graph Properties and Parameters
You can customize your Conversation graph using the Properties menu. The selections available for a Conversation graph are:
| Bar Chart |
Presents the report in the form of a bar chart. This is the default. |
| Stack Bar Chart |
Presents the report in the form of a stacked bar chart. |
| Pie Chart |
Presents the report in the form of a pie chart. |
| Transpose |
Transposes the variables for the type of chart you selected. The default is "off" (non-transposed). |
| 3D |
Presents bar chart graphs in 3-D format. The default is "off" (2-D representation). |
You can select the parameters to be displayed in the Conversation Statistics graph using the View menu. The selections are:
| Utilization |
Graphs percent utilization in the segment. This is the default. |
| Packets |
Graphs the total number of each type of packet sent. The packet types are represented in two graphs. The packet types are: |
|
· Graph 1:PacketsUnicastMulticastBroadcast |
|
· Graph 2:CRC Alignment ErrorsFragmentsUndersizeJabbersOversizeCollisions |
Generating a Host Summary Report
The Host report provides a summary of host traffic for the selected agent and domain during the report period, sorted according to the sort metric you specify. You can include all hosts, or only the top N hosts. Hosts are listed one per line. The Sort metric can be one of the following:
- MAC address order
- Outbound packets
- Inbound packets
- Inbound utilization
- Outbound utilization (the default)
- Outbound multicasts
- Outbound broadcasts
- Outbound errors
- Top N. The number of top hosts to be included in the report; for example, 10 or 50, sorted according to the sort metric.The default is to include all hosts.
You specify the sort metric from the Report Configuration window.
The following example shows a Host summary report in ASCII format.
The next example shows a Host summary report in CSV format.
To create a Host report, follow these steps:
Step 1 From the TrafficDirector Main window, select Domain Manager. The Domain Manager window appears.
Step 2 Verify that logging is enabled for this report. (See "Enabling Logging".)
Step 3 Wait a minimum of two logging intervals after you enable logging to ensure that you have valid data. For example, if you enable Host logging with a 2-hour logging interval, you have to wait at least 4 hours after enabling logging before generating a report that requires Host information.
Step 4 From the Domain Manager window, select the agent and domain for which you want a report.
Step 5 From the Tools menu on the Domain Manager window, select Report Generator. The Report Generator window appears.
Step 6 Fill in or change the fields needed for this report:
- In the Report Type subwindow, select Host.
- Fill in the Start Time and End Time fields. You can either enter a start and end time manually or pop up a selection window by clicking on the ellipsis (...) at the end of the field entry box.
- If you want your report to be paginated, fill in the number of lines per page, including header and footer, if any. The default is 66. If you want an un-paginated report, enter 0.
- If you want a header or footer, enter the text you want in the Header and Footer fields. The default is no header or footer.
- In the Output subwindow, select the output device:
- File. Send the report to the file name you specify.
- Printer. Send the report to your default printer.
- Mail to. Mail the report to the user you specify.
- The entry field following these selections initially shows the default file name, printer, or e-mail address to which the output will be sent. Accept this value or supply a new one. Examples of the formats for each type of output are presented in the section "Creating a Report Using Report Generator" earlier in this chapter.
Caution If you are capturing several intervals of logging data to a file, be sure to change the file name for each interval. If you don't, you will overwrite the previous file with the same name.
- In the Report Format subwindow, select one of the following:
- ASCII. Generates the report in standard ASCII format.
- CSV. Generates the report in comma-separated format. Use this format if you want to import the report into a spreadsheet such as Excel.
- GRAPH. Creates a graphical report. See the next section.
Step 7 To specify the method of sorting for your report, select Configure. The Report Configuration Window appears.
Step 8 In the Sort Hosts subwindow select the parameter you want to use to sort your report. The default is Outbound Utilization. You can also select the number of hosts (Top N Hosts) to include in the report. If the Top N field is blank, the report will include all hosts.
Step 9 Click on OK to update the configuration, or Cancel to quit without changing the existing values. You return to the Report Generator window.
Step 10 If you selected either ASCII or CSV, click on Generate. TrafficDirector generates your report.
- If you selected GRAPH, click on View to display the graphical report.
Creating a Graphical Host-Statistics Report
You can view a graphical version of the Host Statistics report.
To view a graphical Host Statistics report:
Step 1 Select GRAPH in the Report Format subwindow in the Report Generator window.
Step 2 Click on View in the Report Generator window. The graphical report appears.
Host Statistics Graph Properties and Parameters
You can customize your graph using the Properties menu. The selections are:
| Bar Chart |
Presents the report in the form of a bar chart. This is the default. |
| Stack Bar Chart |
Presents the report in the form of a stacked bar chart. |
| Pie Chart |
Presents the report in the form of a pie chart. |
| Transpose |
Transposes the variables for the type of chart you selected. The default is "off" (non-transposed). |
| 3D |
Presents bar chart graphs in 3-D format. The default is "off" (2-D representation). |
You can select the parameters to be displayed in the Conversation Statistics graph using the View menu. The selections are:
| Utilization |
Graphs percent utilization for each host. This is the default. |
| Packets |
Graphs the total number of each type of packet sent for each host. The packet types are represented in two graphs. The packet types are:
- Packets in
- Packets out
- Broadcasts in
- Broadcasts out
- Errors out
- Multicasts out
|
Generating a Host-Verbose Report
Like the Host Statistics report, the Host-Verbose report lists the host traffic for the selected agent and domain during the report period. These are sorted according to the sort metric you specify. The Host-Verbose report provides more information, using multiple report lines per host. The report is in tabular form.
You can include all hosts, or only the top N hosts. Hosts are listed one per line. The Sort metric can be one of the following:
- MAC address order
- Outbound packets
- Inbound packets
- Inbound utilization
- Outbound utilization (the default)
- Outbound multicasts
- Outbound broadcasts
- Outbound errors
- Top N. The number of top hosts to be included in the report; for example, 10 or 50, sorted according to the sort metric.The default is to include all hosts.
Figure 14-1 : Logging and ReportinThe following example shows a Host-Verbose report in ASCII format.
The next example is the same Host-Verbose report in CSV format.
To create a Host-Verbose report, follow these steps:
Step 1 From the TrafficDirector Main window, select Domain Manager. The Domain Manager window appears.
Step 2 Verify that logging is enabled for this report. (See "Enabling Logging.)
Step 3 Wait a minimum of two logging intervals after you enable logging to ensure that you have valid data. For example, if you enable Host logging with a 2-hour logging interval, you have to wait at least 4 hours after enabling logging before generating a report that requires Host information.
Step 4 From the Domain Manager window, select the agent and domain for which you want a report.
Step 5 From the Tools menu on the Domain Manager window, select Report Generator. The Report Generator window appears.
Step 6 Fill in or change the fields needed for this report:
- In the Report Type subwindow, select Host-Verbose.
- Fill in the Start Time and End Time fields. You can either enter a start and end time manually or pop up a selection window by clicking on the ellipsis (...) at the end of the field entry box.
- If you want your report to be paginated, fill in the number of lines per page, including header and footer, if any. The default is 66. If you want an un-paginated report, enter 0.
- If you want a header or footer, enter the text you want in the Header and Footer fields. The default is no header or footer.
- In the Output subwindow, select the output device:
- File. Send the report to the file name you specify.
- Printer. Send the report to your default printer.
- Mail to. Mail the report to the user you specify.
The entry field following these selections initially shows the default file name, printer, or e-mail address to which the output will be sent. Accept this value or supply a new one. Examples of the formats for each type of output are presented in the section "Creating a Report Using Report Generator" earlier in this chapter.
Caution If you are capturing several intervals of logging data to a file, be sure to change the file name for each interval. If you don't, you will overwrite the previous file with the same name.
- In the Report Format subwindow, select one of the following:
- ASCII. Generates the report in standard ASCII format.
- CSV. Generates the report in comma-separated format. Use this format if you want to import the report into a spreadsheet such as Excel.
Step 7 To specify the sort metric (method of sorting hosts) for your report, select Configure. The Report Configuration window appears.
Step 8 In the Sort Hosts subwindow select the parameter you want to use to sort your report. The default is the outbound utilization. You can also select the number of hosts (Top N Hosts) to include in the report. If the Top N field is blank, the report will include all hosts.
Step 9 Click on OK to update the configuration, or Cancel to quit without changing the existing values. You return to the Report Generator window.
Step 10 Click on Generate. TrafficDirector generates your report.
Generating a Host-Outbound Report
The Host-Outbound report lists the outbound host traffic for the selected agent and domain during the report period, sorted according to the sort metric you specify. You can elect to include all hosts, or only the top N hosts. Hosts are listed one per line. The Sort metric can be one of the following (the default is Outbound Utilization):
- MAC address order
- Outbound packets
- Inbound packets
- Inbound utilization
- Outbound utilization (the default)
- Outbound multicasts
- Outbound broadcasts
- Outbound errors
- Top N. The number of top hosts to be included in the report; for example, 10 or 50, sorted according to the sort metric.The default is to include all hosts.
The following example shows a Host-Outbound report in ASCII format.
The next example is the same Host-Outbound report in CSV format.
To generate a Host-Outbound report, follow these steps:
Step 1 In the TrafficDirector Main window, select Domain Manager. The Domain Manager window appears.
Step 2 Verify that logging is enabled for this report. (See "Enabling Logging".)
Step 3 Wait a minimum of two logging intervals after you enable logging to ensure that you have valid data. For example, if you enable Host logging with a 2-hour logging interval, you have to wait at least 4 hours after enabling logging before generating a report that requires Host information.
Step 4 From the Domain Manager window, select the agent and domain for which you want a report.
Step 5 From the Tools menu on the Domain Manager window, select Report Generator. The Report Generator window appears.
Step 6 Fill in or change the fields needed for this report:
- In the Report Type subwindow, select Host-Outbound.
- Fill in the Start Time and End Time fields. You can either enter a start and end time manually or pop up a selection window by clicking on the ellipsis (...) at the end of the field entry box.
- If you want your report to be paginated, fill in the number of lines per page, including header and footer, if any. The default is 66. If you want an un-paginated report, enter 0.
- If you want a header or footer, enter the text you want in the Header and Footer fields. The default is no header or footer.
- In the Output subwindow, select the output device:
- File. Send the report to the file name you specify.
- Printer. Send the report to your default printer.
- Mail to. Mail the report to the user you specify.
- The entry field following these selections initially shows the default file name, printer, or e-mail address to which the output will be sent. Accept this value or supply a new one. Examples of the formats for each type of output are presented in the section "Creating a Report Using Report Generator" earlier in this chapter.
Caution If you are capturing several intervals of logging data to a file, be sure to change the file name for each interval. If you don't, you will overwrite the previous file with the same name.
- In the Report Format subwindow, select one of the following:
- ASCII. Generates the report in standard ASCII format.
- CSV. Generates the report in comma-separated format. Use this format if you want to import the report into a spreadsheet such as Excel.
Step 7 To specify the sort metric (method of sorting hosts) for your report, select Configure. The Report Configuration window appears.
Step 8 In the Sort Hosts subwindow select the parameter you want to use to sort your report. The default is the outbound utilization. You can also select the number of hosts (Top N Hosts) to include in the report. If the Top N field is blank, the report will include all hosts.
Step 9 Click on OK to update the configuration or Cancel to quit without changing the existing values. You return to the Report Generator window.
Step 10 Click on Generate. TrafficDirector generates your report.
Generating a Multi-Domain Report
The Multi-Domain report lets you compare segment statistics for a hierarchy of domains for a specified agent, based on a user-specified tree of domains. Because domains typically correspond to protocol layers, you can use this report to provide a Protocol Distribution showing proportional traffic at multiple protocol layers.
The domain ALL is always considered the root of the domain tree. Log files for domain ALL must exist in order to generate a Multi-Domain report. The log files for the other domains to be included in the report must be available for the same time period (within the same start/end times) as the log files for the ALL domain.
The Report Generator gets the user-specified tree of domains from the "Tree file." This file specifies the tree structure to be used in the report. You must create this file, and provide its name to the Report Generator before you can generate any Multi-Domain reports.
The following example shows a complete Multi-Domain report in ASCII format. The analysis that follows the complete report looks at individual areas of the report.
The following is an example of a Multi-Domain report.
.
To generate a Multi-Domain report, follow these steps:
Step 1 Use a text editor to create a Tree file if you have not previously done so. You must set up a Tree file before you can generate any Multi-Domain reports. To create a Tree file, see "Creating a Tree File" following this procedure.
Step 1 In the TrafficDirector Main window, select Domain Manager. The Domain Manager window appears.
Step 2 Verify that logging is enabled for this report. (See "Enabling Logging".)
Step 3 Wait a minimum of two logging intervals after you enable logging to ensure that you have valid data. For example, if you enable Host logging with a 2-hour logging interval, you have to wait at least 4 hours after enabling logging before generating a report that requires Host information.
Step 4 From the Domain Manager window, select the agent and domain for which you want a report.
Step 5 From the Tools menu on the Domain Manager window, select Report Generator. The Report Generator window appears.
Step 6 Fill in or change the fields needed for this report:
- In the Report Type subwindow, select Multi-Domain.
- Fill in the Start Time and End Time fields. You can either enter a start and end time manually or pop up a selection window by clicking on the ellipsis (...) at the end of the field entry box.
- If you want your report to be paginated, fill in the number of lines per page, including header and footer, if any. The default is 66. If you want an un-paginated report, enter 0.
- If you want a header or footer, enter the text you want in the Header and Footer fields. The default is no header or footer.
- In the Output subwindow, select the output device:
- File. Send the report to the file name you specify.
- Printer. Send the report to your default printer.
- Mail to. Mail the report to the user you specify.
- The entry field following these selections initially shows the default file name, printer, or e-mail address to which the output will be sent. Accept this value or supply a new one. Examples of the formats for each type of output are presented in the section "Creating a Report Using Report Generator" earlier in this chapter.
Caution If you are capturing several intervals of logging data to a file, be sure to change the file name for each interval. If you don't, you will overwrite the previous file with the same name.
- In the Report Format subwindow, select one of the following:
- ASCII. Generates the report in standard ASCII format.
- CSV. Generates the report in comma-separated format. Use this format if you want to import the report into a spreadsheet such as Excel.
Step 7 To specify the Tree configuration file for your report, select Configure. The Report Configuration window appears.
Step 8 In the Tree File field of the Files subwindow, enter the name of the ASCII file that contains the tree configuration description. This file must reside in the $NSHOME/usr/ directory. It is described below. This field is required for this report.
Step 9 Click on OK to update the configuration, or Cancel to quit without changing the existing values. You return to the Report Generator window.
Step 10 Click on Generate. TrafficDirector generates your report.
Creating a Tree File
Before you can generate a Multi-Domain report, you must create a Tree file. You then enter the name of this file in the Report Configuration window so that TrafficDirector knows the desired domain tree structure for the report. The name of the file can be anything, but it must end with a .cfg extension.
The tree configuration file specifies a hierarchy of domains. Each line of the file has the format:
parent-domain:child-domain1 child-domain2 child-domain3...
where each of the child domains is a subset of the parent domain, and the child domains do not overlap.
A sample tree configuration file is:
Note that:
- For each parent domain included in the report, an "Other" category is used to categorize traffic that does not fit in any of the child domains.
- The parent domain ALL is always considered the root of the domain tree. A report can only be produced if log files for the ALL domain are present.
- For each parent domain, the Report Generator looks for log files corresponding to each of the listed child domains, and produces a report section such as the following:
A domain that is a child at one level of the domain tree may itself also be a parent to other domains. Report Generator produces a report section for every domain that is listed as a parent, even if it is a child of a higher-level domain. For example, domain IP is a child of ALL, but also a parent of UDP, TCP, and ICMP, so the Report Generator produces a report section as follows:
This process is repeated recursively until the entire tree of domains is traversed.
Note A domain is included in this report only if it is installed on the specified agent, and if logging is enabled for the domain's segment statistics. Any domains in the tree that do not meet these conditions are not included in the report. To install a domain see Chapter 6, "Installing, Deinstalling, and Monitoring Domains Using Domain Manager."
Statistics for a child domain are included in the report only if log files are available for the same start and end times as for the ALL domain. This is necessary to provide proper alignment of statistics.
In the example above, note that the NOVELL domain is not reported as a child of ALL, even though it is listed as such in the tree file. This can be for one of the following reasons:
- Domain NOVELL is not installed at the agent.
- NOVELL is installed, but is not enabled for logging.
- NOVELL is being logged, but log files time-aligned with ALL are not available.
Note Any NOVELL traffic is included in the Other category.
Generating a Billing Report
The Billing report generates reports on the amount of inter-subnet traffic over a LAN or WAN segment. You can use the Billing report to determine:
- The amount of inter-subnet traffic on the LAN/WAN.
- The amount of WAN link utilization by different subnets.
- The amount of traffic between the network server and different hosts.
- The different protocols generating the router traffic.
To implement the Billing report, you must first provide necessary network parameters such as the location of each subnet, the distance between subnets, and a proxy tariff for sending 1KB of data for a distance of one user-definable distance unit. You can define the distance between any two nodes as one unit. You define these parameters in three files, the Distance, Location, and Tariff files.
Billing is calculated as a multiple of the number of units. This gives you greater flexibility to adapt to local tariff and metric differences. For example, if you typically send a large volume of data over a dedicated line between a node in Boston and one in New York, you can define that distance as one unit, and calculate accordingly. Alternatively, you can define one unit as one mile, if that metric better suited your network traffic.
The Billing report is generated through the normal Report Generator function. However, you must create the Distance, Location, and Tariff files prior to creating the report.
Note To use the Billing report you must first install the domain with SUBNET mode, with the Hosts and conversations groups enabled. To install a domain, see Chapter 6, "Installing, Deinstalling, and Monitoring Domains Using Domain Manager."
The following is a typical Billing report:
.
To create a Billing report, follow these steps:
Step 1 If you have not done so previously, use a text editor to create three separate ASCII files in the directory $NSHOME/usr/:
- Distance file
- Location file
- Tariff file
- For details on creating these files, see the section "Creating the Files for a Billing Report" following this section.
Step 2 In the TrafficDirector Main window, select Domain Manager. The Domain Manager window appears.
Step 3 Verify that logging is enabled for this report. (See "Enabling Logging".) In addition, verify that the subject domain has been installed in SUBNET mode, with the Hosts and Conversations groups enabled.
Step 4 Wait a minimum of two logging intervals after you enable logging to ensure that you have valid data. For example, if you enable Statistics logging with a 1-hour logging interval you have to wait at least 2 hours after enabling logging before you generate a report that requires Host information.
Step 5 From the Domain Manager window, select the agents and domains for which you want a report.
Step 6 From the Tools menu in the Domain Manager window, click on Report Generator. The Report Generator window appears.
Step 7 Fill in or change the fields needed for this report:
- In the Report Type subwindow, select Billing.
- Fill in the Start Time and End Time fields. You can either enter a start and end time manually or pop up a selection window by clicking on the ellipsis (...) at the end of the field entry box.
- If you want your report to be paginated, fill in the number of lines per page, including header and footer, if any. The default is 66. If you want an un-paginated report, enter 0.
- If you want a header or footer, enter the text you want in the Header and Footer fields. The default is no header or footer.
- In the Output subwindow, select the output device:
- File. Send the report to the file name you specify.
- Printer. Send the report to your default printer.
- Mail to. Mail the report to the user you specify.
- The entry field following these selections initially shows the default file name, printer, or e-mail address to which the output will be sent. Accept this value or supply a new one. Examples of the formats for each type of output are presented in the section "Creating a Report Using Report Generator" earlier in this chapter.
Caution If you are capturing several intervals of logging data to a file, be sure to change the file name for each interval. If you don't, you will overwrite the previous file with the same name.
Note The Billing report is available only in ASCII format.
Step 8 Click on Configure. The Report Configuration Window appears.
Step 9 In the Files subwindow, enter the names of the ASCII files that contain the appropriate Distance, Location, and Tariff information, respectively. The files must reside in the $NSHOME/usr/ directory. These fields are required for this report.
- If you have multiple location files for different subnet types (for example, iploc.ip, iploc.ipx, and iploc.dec) enter the common portion of their names (iploc) into the Location File field.
Step 10 Click on OK to continue, or Cancel to quit without changing the configuration values. You return to the Report Generation Window.
Step 11 Click on OK. TrafficDirector generates the report.
Creating the Files for a Billing Report
Before you can generate a Billing report you have to create three types of files:
- Distance file. Specifies the distance between two sets of locations for which you want billing information.
- Location files. Uniquely identify each billing location.
- Tariff file. Contains the rate, in U.S. dollars, to send 1 KB of data over 1 mile for different daily time periods.
Creating a Distance File
You must create the Distance file in the directory $NSHOME/usr/. This file specifies the distance between each two sets of locations for which billing information is required. This information you enter in this file is not case-sensitive. You then enter the name of the Distance file into the Distance File field of the Report Configuration window when you create a Billing report.
In the example Distance file below, notice that the names of cities that include spaces must be enclosed in quotes:
TrafficDirector includes a sample distance file, distance.act, in the directory $NSHOME/usr/.
Creating Location Files
You must create one or more location files in the directory $NSHOME/usr/. These files must include the following three identifiers so that each billing location can be uniquely identified:
- The subnet IP address.
- A user-defined location identifier.
- A user-defined department name.
You may have to create multiple location files for different types of subnets present in your network. Currently, TrafficDirector supports the following subnets:
You create all the files with the same basic name, adding an appropriate extension to identify the subnet type, as illustrated below.
To create the location files needed for your Billing report:
Step 1 If a network under consideration contains one or more TCP/IP subnets, create a location file with the extension ip (for example, iploc.ip) to provide the locations of the TCI/IP subnet(s), as follows:
- The numbers in the first column give the four-octet IP addresses for different TCP/IP subnets. They are in the form xxx.xx.xxx.xxx, where xxx is a 3-digit decimal number in the range 0 through 255.
- Names that include spaces, such as New York, must be enclosed in quotes.
Step 2 If the network contains one or more Novell subnets, create a location file for these subnets with the .ipx extension (for example, iploc.ipx), as follows:
- The numbers in the first column are four octets representing the subnet IPX addresses (the network numbers that identify the subnets). The addresses are in the form xxxxxxxx, where each xx pair represents a hexadecimal number in the range 00 through ff.
Step 3 If the network contains one or more DECNET subnets, create a location file for the subnets with the extension .dec (for example, iploc.dec), as follows:
- The numbers in the first column are 16-bit DECNET Internet addresses for subnets. These addresses are in the form xx.0, where xx is a 2-digit decimal number in the range 0 through 63. The node address always 0.
Step 4 You specify these location files in the Report Configuration window by entering the common portion of their names (for example, iploc) into the Location File field of the Files subwindow.
You can create multiple location files for different application requirements. Enter the name of the appropriate location file before creating the report file.
Creating a Tariff File
You must create a tariff file which contains the rate, in US dollars, to send 1KB of data over 1 mile for different daily time periods. You can subdivide the daily 24-hour period into any set of contiguous sub-periods to reflect a differing cost structure between business hours and other periods. The time periods must cover the complete 24 hours. A sample tariff file is provided in $NSHOME/usr/tariff.act.
For example:
The name of the tariff file is entered into the Tariff File field in the Report Configuration window in order to generate a Billing report.
Creating Reports from the Command Line
TrafficDirector gives you the option of creating reports either interactively or from the command line. In this section you'll learn how to create reports directly from the command line.
The Report Configuration File
If you create your report from the command line, you must provide a report configuration file that contains your particular specifications for your report. The report program, dvreport, uses this configuration file to format your report. See "Creating a Report Configuration File" later in this chapter for details on using a text editor to create the appropriate report configuration files.
Note You must create a Report configuration file in order to run a report from the command line. If you create a report interactively, using the Report Generator, TrafficDirector creates the report configuration file automatically. However, the configuration information used by the Report Generator is not saved permanently, and is deleted as soon as the interactive report has been run.
Enabling Logging from the Command Line
You initiate logging from the command line by invoking a daemon (background) process, dvlogd. When you initiate TrafficDirector (tdir), it starts the logging daemon. You can also start it manually using the command:
% $NSHOME/bin/dvlogd &
Generating a Segment Statistics Report from the Command Line
To create a Segment Statistics report from the command line:
Step 1 Make sure the logging configuration file dvlog.cfg exists in the directory $NSHOME/usr. This file is normally created when you enable logging in the Domain Manager.
- If necessary, create the file as described in the section "Creating the Logging Configuration File" later in this chapter, and initiate logging by entering the command:
$NSHOME/bin/dvlogd &
Step 2 Wait a minimum of two logging intervals so TrafficDirector can collect sufficient data for a report.
Step 3 If one does not already exist, use a text editor to create an ASCII report configuration file in the directory $NSHOME/usr. Give the file a name that will remind you of its contents, and use the suffix .cfg (for example, seg_stat.cfg). See the section "Creating a Report Configuration File" for detailed instructions on setting up this file.