Notice. Copyright. Copyright release. Terms and conditions

Transcription

1 Apex User Guide

2 Notice Every effort was made to ensure that the information in this manual was accurate at the time of printing. However, information is subject to change without notice, and Viavi reserves the right to provide an addendum to this manual with information not available at the time that this manual was created. Copyright Copyright 2016 Viavi Solutions Inc. All rights reserved. Viavi and the Viavi logo are trademarks of Viavi Solutions Inc. ( Viavi ). All other trademarks and registered trademarks are the property of their respective owners. No part of this guide may be reproduced or transmitted, electronically or otherwise, without written permission of the publisher. Copyright release Reproduction and distribution of this guide is authorized for Government purposes only. Terms and conditions Specifications, terms, and conditions are subject to change without notice. The provision of hardware, services, and/or software are subject to Viavi standard terms and conditions, available at Specifications, terms, and conditions are subject to change without notice. All trademarks and registered trademarks are the property of their respective companies. Federal Communications Commission (FCC) Notice This product was tested and found to comply with the limits for a Class A digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment. This product generates, uses, and can radiate radio frequency energy and, if not installed and used in accordance with the instruction manual, may cause harmful interference to radio communications. Operation of this product in a residential area is likely to cause harmful interference, in which case you will be required to correct the interference at your own expense. The authority to operate this product is conditioned by the requirements that no modifications be made to the equipment unless the changes or modifications are expressly approved by Viavi. Laser compliance This device is a class 1 laser product. Industry Canada Requirements This Class A digital apparatus complies with Canadian ICES-003. Cet appareil numérique de la classe A est conforme à la norme NMB-003 du Canada. WEEE and Battery Directive Compliance Viavi has established processes in compliance with the Waste Electrical and Electronic Equipment (WEEE) Directive, 2002/96/EC, and the Battery Directive, 2006/66/EC. This product, and the batteries used to power the product, should not be disposed of as unsorted municipal waste and should be collected separately and disposed of according to your national regulations. In the European Union, all equipment and batteries purchased from Viavi after can be returned for disposal at the end of its useful life. Viavi will ensure that all waste equipment and batteries returned are reused, recycled, or disposed of in an environmentally friendly manner, and in compliance with all applicable national and international waste legislation. It is the responsibility of the equipment owner to return equipment and batteries to Viavi for appropriate disposal. If the equipment or battery was imported by a reseller whose name or logo is marked on the equipment or battery, then the owner should return the equipment or battery directly to the reseller. Instructions for returning waste equipment and batteries to Viavi can be found in the Environmental section of Viavi web site at If you have questions concerning disposal of your equipment or batteries, contact Viavi WEEE Program Management team at WEEE.EMEA@viavisolutions.com. Technical Support North America GO VIAVI / Latin America EMEA APAC All Other Regions viavisolutions.com/contacts customer.care@viavisolutions.com Support hours are 7:00 A.M to 7:00 P.M. (local time for each office).

3 Table of Contents Chapter 1: Understanding Apex...6 Learn about Apex... 6 Apex vs. Apex Lite...6 Understanding the certificate trust model... 7 How to view certificates...8 How to change the trust of a certificate...8 Certificates and how they are used...9 Chapter 2: Activating and configuring Licensing How to license Apex How to modify baseline calculations...11 General and data transfer settings Chapter 3: Gather data from your products Understanding data sources...12 How to add a data source...12 How to assign a data source How to edit a data source...13 How to delete a data source...14 How to force the transfer of network trending data How to transfer older network trending data Data source settings Understanding business groups How to create a business group How to nest a business group...16 How to filter a business group...17 How to hide a business group How to halt a business group from retrieving data...17

4 Business group settings Understanding dashboards How to create a dashboard How to promote a dashboard How to let dashboards automatically refresh How to export a dashboard...22 How to import a dashboard How to filter a dashboard How to save a dashboard as P How to delete a dashboard...24 Understanding dashboard times Additional Apex dashboards Understanding thresholds...30 How to configure thresholds...30 Understanding threshold color bars in tables Understanding widgets How to create a widget How to add a widget to a dashboard...34 How to filter a widget How to edit a widget...35 How to export a widget...35 How to import a widget How to delete a widget...36 Understanding key fields...36 Widget settings Widget types and categories Understanding status widgets...38 Widget fields by data stream type and widget type Understanding an application dependency map (ADM) Visualizing the components of multi-tier applications How to create an application dependency widget How to operate an application dependency widget...60 Understanding scheduled reports How to create a scheduled report How to edit scheduled reports...63 Scheduled report options Understanding GigaStor Report drill down Overall steps needed for drill down How to prepare Observer for drill down How to prepare Apex for drill down How to drill down using Apex...70 Chapter 4: Installing and upgrading...73 How to install Apex Supported Operating Systems Ports used by Observer Platform v17 and later Table of Contents (23 Jan 2016) Archive/Non-authoritative version

5 System specifications Understanding your deployment strategy...75 Installing the Apex appliance Setting the IP address Configuring the Lights Out Management port (newer revisions) Set up Apex for the first time How to begin using Apex How to license Apex How to create a user How to configure general settings...85 How to have Apex managed by OMS How to upgrade or downgrade Apex How to retrieve a list of available Apex versions How to download a version of Apex...87 How to install a version of Apex...87 Upgrade settings Chapter 5: Troubleshooting...89 Understanding logging in Apex...89 How to view event logs How to send Syslog messages How to send SNMP traps...90 How to send alerts How to return to the default log settings...93 Understanding alarms How to create an alarm...94 How to disable an alarm Alarm settings Troubleshooting network, server, and application issues Is it the network? Is it the server? Is it the application? Summary Chapter 6: Backups and Secondary Configuring a failover or redundant Apex Defining a failover Apex Becoming a primary/secondary Apex Understanding configuration backups How to create a backup How to restore configuration settings How to schedule backups How to change where backups are stored Index Table of Contents (23 Jan 2016) Archive/Non-authoritative version 5

6 1 Chapter 1: Understanding Apex Learn about Apex Apex helps your organization create reports, called dashboards, from the data collected by Observer Platform products. These reports can assist your organization with troubleshooting, planning, performance, compliance, and more. Apex vs. Apex Lite Apex is a full-featured reporting engine for combining information from many assets while Apex Lite has limited functionality and can only be used for reports of the local asset. Table 1: Apex vs. Apex Lite Feature Apex Apex Lite System and user dashboards Import dashboards Filtering Event logging / notifications Tags Tables Graphs Charts Threshold graphs GigaStor workflow integration Site dashboards

7 Feature Apex Apex Lite Multiple data sources Business groups Status widgets Application dependency maps (ADM) Failover / Redundancy Multiple user configuration Thresholds Alarms Scheduled reports Works with Observer Analyzer (Expert and Suite) Observer GigaStor Observer (Expert and Suite) GigaStor Figure 1: Observer Platform Understanding the certificate trust model The certificate trust model allows Observer Platform products to securely communicate using TLS encryption. It is also provides resistance to man-in-themiddle attacks by requiring administrator intervention when a known certificate has changed. All product-to-product communication is encrypted by default. A web of trust between Observer Platform products is created by requiring certificates from each participating software application. The main benefit is that this Understanding the certificate trust model Chapter 1: Understanding Apex 7

8 ensures encryption of communication between all parts of the Observer Platform. Each software application owns a unique certificate. This certificate is automatically created during the first installation of an Observer Platform application. For example, Apex. The unique application certificate is labeled Local when viewed from inside that software application. Upgrading to newer software versions does not create a new certificate, so no certificate maintenance is typically needed. However, uninstalling and reinstalling (fresh installs) creates a new certificate. The new certificate will be automatically rejected by other products that had a pre-existing association with the asset ID of the reinstalled software. The first time two products communicate, each checks to see if they have the certificate for the asset ID of the other software application. If they do not, then certificates are exchanged, marked Trusted, and associated with the asset ID of the participating device. This enables the easy configuration model. After an association is made, each application will expect to see the same certificate (to remain trusted) when communicating. Note: Prior to version 17 of the Observer Platform, encryption was available but not enabled by default. This has changed to become the default out-ofthe-box behavior in Observer Platform version 17 and later, and it also uses a stronger cipher suite. Certificates are automatically rejected when trust cannot be verified. If a certificate is associated to an asset ID, and an inbound connection from that asset (determined by the asset ID) occurs using a different certificate, the administrator must inspect and manually accept the certificate because the certificate is in a Rejected state. A rejected certificate breaks the trust model, so any offending device(s) and software are banned from product-to-product communication until an administrator investigates and accepts the certificate. Certificates can be manually rejected by administrators. In the event that product-to-product communication must be immediately severed because of an imminent threat or other security risk, an administrator can manually reject certificates. How to view certificates You can view every certificate that Apex has collected. This information shows certificate trust state, certificate ID, fingerprints, last time seen, last network location, and more. To view certificates: 1. In the web interface, click Settings > Certificates. 2. (Optional) Select a certificate and click Details to view its full details. 3. (Optional) Click Prefs to configure which columns appear in the table. You successfully viewed the certificates that this installation of Apex has collected. How to change the trust of a certificate The trust of a certificate can be changed between trusted and rejected states. The certificate must remain trusted for communication to occur. 8 Understanding the certificate trust model Apex (23 Jan 2016) Archive/Non-authoritative version

9 To change the trust of a certificate: 1. In the web interface, click Settings > Certificates. 2. Click a certificate to select it. 3. Click Change State and Yes to confirm. You successfully changed the trust state of a certificate. Certificates and how they are used Certificates ensure secure communication between Observer Platform products. The certificates encrypt this communication and help you the maintain the authenticity of device communication. Certificates use public key infrastructure (PKI) to encrypt all product-to-product communication using the Transport Layer Security (TLS) cryptographic protocol. The communications that are encrypted include, but are not limited to: Probe instance redirections Capture data transfers Trending data transfers All other data transfers Note: The initial handshake between Observer Platform products is not encrypted. Understanding the certificate trust model Chapter 1: Understanding Apex 9

10 2 Chapter 2: Activating and configuring Licensing Licensing your product enables functionality and entitles you to support during your maintenance period. How to license Apex Apex is designed to be used as a server-based application. If Apex is installed along with an Observer Platform product but not licensed, you have Apex Lite. Apex Lite provides limited reporting capabilities. To license and activate Apex: 1. Install and launch the application. 2. Your default web browser will open to the following URL: localhost/oa If it does not, type the URL in the location bar of your web browser and press Enter. 3. Follow the on-screen instructions provided by your web browser to accept the self-signed security certificate. Your web browser must accept the self-signed security certificate to continue. 4. Type into the Contact/Department, Company, and License Information boxes exactly what is listed in your license document. 5. Click the License button. You successfully licensed and activated your product. If licensing and activating your product remains unsuccessful, please contact Technical Support.

11 How to modify baseline calculations Baselines help uncover how much a statistic has changed over time. You can change how much past information is used for these baseline calculations. To modify baseline calculations: 1. In the web interface, click Settings > Thresholds. 2. Click Schedule. 3. Modify the Comparison Periods and Comparison Type to suit your needs. 4. Click Accept. Now any widgets that display a baseline metric will use the values above to calculate a baseline. General and data transfer settings Field Description Apex asset name This changeable name identifies Apex to other Viavi products. Data storage location Data transferred to Apex is stored in this directory. All dashboards are populated with the data inside. The default file path is C:\Program Files\Observer Apex \Data for software-only installations and D:\DATA if a hardware appliance. Data transfer period (minutes) The collection period in minutes. Data transfer delay (minutes) Sets the minutes to wait after completion of a data source statistics collection interval before the data is transferred to Apex. This value cannot be changed. Valid Input: Valid values are Setting a delay can improve hard disk performance on the data source because data is transferred N-minutes after being written. Missing data files limit (days) Apex automatically retrieves up to this many previous days of data from data sources if any are missing. Valid Input: Valid values are This helps Apex recover 'missing' data from data sources if Apex experiences downtime, or when collecting data from a data source for the first time. How to modify baseline calculations Chapter 2: Activating and configuring 11

12 3 Chapter 3: Gather data from your products Understanding data sources A data source is any Observer Platform product that feeds data into Observer Apex. Data sources are configured in Apex, by you, and assigned to one or more business groups. Data sources must be configured. Apex must be connected to data sources for the application's core features to operate. Adding a new data source tells Apex about a new Observer Platform product from which you want to get data. For example, one Observer Analyzer analyzer can be an aggregation point that gets data from several probes like a GigaStor or Observer Suite. Data sources must be added to business groups. It is not enough to just configure a data source and have Apex automatically connect to it. To transfer the data collected by data sources to Apex, your chosen data sources must be added to a business group. Apex Lite cannot create data sources. Only a fully licensed Apex has that capability. For other differences, see Apex vs. Apex Lite. How to add a data source Adding a new data source tells Apex about the Observer Platform product you want to get data from. At least one data source is needed for Apex to fully operate. To add a data source: 1. In the web interface, click Settings > Data Sources. 2. Click New.

13 3. In the Edit pane, provide information about the data source and credentials to connect to it. 4. Click Accept. The data source is added to Apex, and Apex attempts to communicate with the data source. The Connection State indicator shows the connection status in real time; it is not necessary to refresh the web page. Note: No network trending data is transferred during this process. You must assign at least one data source to a business group to complete your configuration. This is because network trending data is only transferred to Apex after a data source is assigned to a business group. For details, see How to assign data sources. How to assign a data source Data sources must be added to business groups before their data can be transferred to Apex. Prerequisite(s): You must have a data source before you can assign it to a business group. If you need to create a data source before continuing, see How to add a data source. To assign a data source: 1. In the web interface, click Settings > Business Groups. 2. Begin editing a business group by clicking its name. 3. In the Edit pane, click the Data Sources tab. 4. Move a probe instance from Available Data Sources to Selected Data Sources using a drag-and-drop operation. You can repeat the drag-and-drop operation to assign more data sources to the business group. 5. Click Accept. Apex contacts the data source to request and retrieve its trending data. The value of Data transfer delay (minutes) at Settings > General Settings controls the number of minutes to wait after Data transfer period (minutes) finishes before retrieving the trending data. For example, if Data transfer delay (minutes) is set to 2 minutes, trending data from your assigned data source will begin transferring two minutes after the data source has finished its statistics collection interval. How to edit a data source You can make edits to an existing data source if its IP address, DNS name, or user credentials have changed. This ensures continuity of its trending data even in cases when the address had changed. To edit a data source: 1. In the web interface, click Settings > Data Sources. 2. Select one by clicking a table row. Understanding data sources Chapter 3: Gather data from your products 13

14 3. In the Edit pane, provide information about the data source and credentials to connect to it. 4. Click Accept. You successfully edited a data source. If the connection is successful, widgets and dashboards that rely on data from this data source are provided the trending data. The Connection State indicator shows the connection status in real time; it is not necessary to refresh the web page. How to delete a data source Data sources can be deleted for any reason. Deleting a data source removes it from Apex, including any trending data that it already transferred. To delete a data source: 1. In the web interface, click Settings > Data Sources. 2. Select one by clicking a table row. 3. Click Delete. 4. Click Yes to confirm. You successfully deleted a data source and its trending data. How to force the transfer of network trending data If you are unable to wait for trending data to automatically transfer, you can force its transfer. Apex frequently and automatically receives network trending data from data sources. Use this procedure if data transfer needs to be performed on-demand. To force the transfer of network trending data: 1. In the web interface, click Settings > Data Sources. 2. Select one by clicking a table row. 3. Expand the Trending Data Commands area. 4. Click Get Latest Trending Data. The network trending data begins transferring to Apex. Apex should now have the latest network trending data. How to transfer older network trending data If you need to transfer trending data into Apex that is much older that what Apex currently has, you can do so. This allows you to view dashboards against much older reporting periods that, until now, you did not have trending data for. To transfer older network trending data: 1. In the web interface, click Settings > Data Sources. 2. Select one by clicking a table row. 3. Expand the Trending Data Commands area. 4. Click either of the Time Range boxes 14 Understanding data sources Apex (23 Jan 2016) Archive/Non-authoritative version

15 5. Set your date and time range, and click OK. 6. Click Get Trending Data Range. The network trending data begins transferring to Apex. Apex should now have the network trending data that you specified. Data source settings Observer Type The Observer Platform application used as a data source must be specified. Observer Collect network trending data from a GigaStor, Observer, or Expert Probe. Name This name is configured and provided by the data source. Probe ID The unique probe ID generated during installation of Observer or Observer Infrastructure (OI), which it reported to Apex. Probe ID is not shown until the first time the asset connects. Connection State Displays the status of the network connection between Apex and this data source. This indicator always shows current information. You will not need to refresh the web page. The host address of the data source. Host Example: or- mintw028.example.net Valid Input: Valid addresses include IPv4, IPv6, or DNS name. Username This name is configured and provided by the data source. Password The password for the user name used to connect to this data source. These user names and passwords are maintained by the data source and not Apex. Understanding business groups Business groups are collections of data sources. By assembling multiple data sources into a logical grouping, you are creating a business group for that grouping. Business groups are a collection of data sources. Imagine you have 14 web servers across your network that are monitored by three different probe instances. You can create a business group that views the statistical data from those data sources the three probes instances. This allows you to view dashboards that combine the metrics from those web servers. Data sources only transfer trending data after being placed into a business group. It is not enough to add a data source to Apex and have Apex connect to it. To actually transfer data from your data sources, the data sources must be assigned to one or more business groups. This must be done for widgets and dashboards to show any data. Business groups can contain these data sources: Probe instances from Observer Suite analyzer, GigaStor, and other probes. Understanding business groups Chapter 3: Gather data from your products 15

16 Business groups can include other business groups. Business groups can be nested. This allows you the option of making smaller, more manageable business groups and still have them act as one large business group. How to create a business group Business groups can be created to organize your data sources by department, location, multi-tiered application, or for other reasons. A business group with data sources is required for widgets and dashboards to display data. To create a business group: 1. In the web interface, click Settings > Business Groups. 2. Click New. 3. Type a name for your business group. 4. Ensure Trending Enabled and Selectable are selected if you plan to have this new business group selectable and able to retrieve data from data sources. 5. (Optional) If you want to combine other business groups into this business group, use a drag-and-drop operation in the Included Business Groups tab. 6. (Optional) If you want to immediately add data sources, complete the following: a. In the Edit pane, click the Data Sources tab. b. Move a probe instance from Available Data Sources to Selected Data Sources using a drag-and-drop operation. You can repeat the drag-and-drop operation to assign more data sources to the business group. 7. Click Accept. You successfully created a business group. You assigned, or will assign in the future, one or more data sources to the business group you created. All selectable business groups appear in a list in the upper-left corner of My Dashboards. How to nest a business group A business group can be arranged so the data sources available to one business group can include those from other business groups. This is accomplished by nesting one or more business groups together. To nest one business group into another: 1. In the web interface, click Settings > Business Groups. 2. Select one by clicking a table row. The business group is now editable. 3. In the Edit pane, click the Included Business Groups tab. 4. Move a business group from Available to Included Groups using a drag-anddrop operation. You can repeat the drag-and-drop operation to nest more business groups into this business group. Your business group is now including the business groups that you specified. Data sources from those nested business groups can be brought in. 16 Understanding business groups Apex (23 Jan 2016) Archive/Non-authoritative version

17 How to filter a business group Filtering a business group helps you isolate just the objects of interest for you, such as a specific applications, IP or MAC addresses, and more. Unlike other filtering types in Apex, filtering a business group is permanent. Meaning, the filter is applied directly to the business group and is always in effect when the business group is selected. It is the highest level of filtering available in Apex, so all other filters (like filters on a dashboard) take effect after the business group filter. We recommend designing business group filters to be broad because all additional filters depend on what data remains visible. 1. In the web interface, click Settings > Business Groups. 2. Select one by clicking a table row. The business group is now editable. 3. In the Business Groups Settings tab, type a filter in the Filter box. 4. Click Accept. The business group is now filtered. All data is filtered accordingly when this business group is selected in My Dashboards. How to hide a business group Business groups can be hidden to avoid accidentally selecting them. This is useful when the purpose of one business group is to be part of another business group called nesting but it should not be directly selectable by users. A hidden business group performs all its normal functions. The only difference is that it cannot be selected from the list shown to users. There is typically no need to hide a business group unless it is nested in another business group. To hide a business group: 1. In the web interface, click Settings > Business Groups. 2. Select one by clicking a table row. The business group is now editable. 3. In the Edit pane, click the Business Group Settings tab. 4. Clear Selectable. 5. Click Accept. This business group can no longer be selected from the business group list. Presumably, the business group you hid is hidden because it is not meant to be selected directly, which may be the case if you are nesting business groups. How to halt a business group from retrieving data To stop a business group from retrieving data, you can disable the business group. While the business group is disabled, any data that was already retrieved can still be used by widgets and dashboards. To halt a business group from retrieving data: 1. In the web interface, click Settings > Business Groups. Understanding business groups Chapter 3: Gather data from your products 17

18 2. Select one by clicking a table row. The business group is now editable. 3. Under the Business Group Settings tab, clear Trending Enabled. If cleared, this business group is disabled. While disabled, no trending data is retrieved from its configured data sources. Previously transferred trending data remains usable by widgets and dashboards. 4. Click Accept. You successfully disabled a business group. Business group settings Name The name of this business group. Description Descriptions are optional and displayed in the Business Groups table. Filter Trending Enabled If cleared, this business group is disabled. While disabled, no trending data is retrieved from its configured data sources. Previously transferred trending data remains usable by widgets and dashboards. Any other enabled business group configured to use some or all of the same data sources will still retrieve data. Selectable If cleared, users cannot select this business group from the list, but the business group remains fully functional. Clearing this box is useful when this business group is included in a different business group. Understanding dashboards A dashboard is a report populated with widgets, and these widgets show the information collected by your data sources. Dashboards are reports populated with widgets. Your reports your dashboards are populated with one or many widgets. The data shown by widgets in your dashboards belongs to Observer. To make use of dashboards, Observer must be collecting network trending data and be a data source to Apex. Without trending data, Apex will not have any data for the widgets in a dashboard. 18 Understanding dashboards Apex (23 Jan 2016) Archive/Non-authoritative version

19 Figure 2: An Apex dashboard populated with five widgets System dashboards are available "out-of-the-box" for you and cannot be modified. Dashboards that are pre-made by Viavi are available to you as system dashboards. System dashboards are identical in function to dashboards you create on your own, but they cannot be modified. Additionally, system dashboards provide broad information and are useful for high-level analytics. A temporary filter can be used while viewing system dashboards, but a permanent filter cannot be added. Dashboards can be filtered. Any dashboard can have an always-on filter written into its properties. Dashboard filters force every widget in a dashboard to display only information that meets the filter. For example, you can filter a dashboard so that its widgets show statistics from a specific subnet only. Or you can filter a dashboard to search for a telephone number used in a VoIP conversation. A dashboard filter can be applied to the design of the dashboard itself (alwaysfiltered), applied during viewing of the dashboard (temporary), or applied as a combination of the two. User dashboards are only viewable by you. Each newly created dashboard is considered a user dashboard. User dashboards are unique to the user that logged in to Apex and created it, and it can only be viewed and modified by that user. To share a user dashboard with other Apex users, the creator must promote the dashboard. A promoted dashboard becomes a site dashboard that is viewable by other users. A promoted dashboard cannot be demoted. Promoting a dashboard does not simultaneously promote user widgets. This means you can promote a user dashboard to a site dashboard without promoting the underlying user widgets if any exist. This protects your personal user widgets from being altered and changed by others. If you want to share a Understanding dashboards Chapter 3: Gather data from your products 19

20 dashboard with others (by promotion) and also allow changes to those widgets, the widgets must be promoted to site widgets. How to create a dashboard You can report on metrics that matter to you and your organization. Do this by creating a dashboard and populating it with widgets. To create a dashboard and populate it with widgets: 1. In the web interface, click Libraries > Dashboard Library. 2. Click Add. The dashboard designer starts, indicated by the words "Drag and drop a widget here" and the appearance of rightmost tabs. Figure 3: The dashboard designer can be identified by its rightmost tabs 3. Click the Widgets tab to show all available widgets. 4. (Optional) Add more places to drop widgets using the Add Rows tab. 5. From the list, move a widget to the dashboard using a drag-and-drop operation. 6. Click Accept. You successfully created a dashboard and populated it with one or more widgets. If data sources are configured and business groups are set, this dashboard will show data when run in the My Dashboards page. How to promote a dashboard To share a user dashboard with other Apex users, the creator must promote the dashboard. A promoted dashboard becomes a site dashboard that is viewable by other users. A promoted dashboard cannot be demoted. User dashboards are only viewable by you. Each newly created dashboard is considered a user dashboard. User dashboards are unique to the user that logged in to and created it, and it can only be viewed and modified by that user. Site dashboards are not viewable by anyone using Apex Lite. To promote a dashboard: 1. In the web interface, click Libraries > Dashboard Library. 2. Click Promote. The dashboard is immediately promoted. 20 Understanding dashboards Apex (23 Jan 2016) Archive/Non-authoritative version

21 Note: If you accidentally promote a dashboard that you wanted to keep as a user dashboard, export the site dashboard, delete the site dashboard, then import your exported dashboard file. You successfully promoted a dashboard and it is now viewable by others. How to let dashboards automatically refresh If you want dashboards to show running changes that is, to show new data soon after it s available you can set your reporting period to use the autorefresh option. When setting the reporting period during your Apex session, dashboards show you metrics observed during that time frame. If you continue viewing a dashboard like this, without navigating elsewhere in Apex and then returning to the same dashboard (which triggers a refresh), the dashboard sits idle and shows the same data it originally fetched. However, with the auto-refresh option enabled, the dashboards you are viewing can update automatically. Caution: Viewing a dashboard while auto-refresh is enabled will suspend Enable Session Timeout for as long as it is in view. In this specific scenario, the inactive user will not be signed out of Apex. To let dashboards automatically refresh: 1. In the web interface, click My Dashboards. 2. Select a dashboard from the leftmost pane by clicking it. 3. Select Auto-Refresh in the reporting period menu. The Auto-Refresh check box is available for Week, Day, and shorter time frames. The option does not appear if Month is chosen. Figure 4: Enabling dashboard auto-refresh 4. Click Apply. With Auto-Refresh now enabled, a dashboard being viewed updates and displays new data automatically. For more information about auto-refresh operates, see Understanding dashboard auto-refresh. Understanding dashboards Chapter 3: Gather data from your products 21

22 How to export a dashboard Every dashboard can be exported to a downloadable file. The file can be used for many purposes, such as archival, back ups, or to import back into Apex. The exported dashboard contains the properties, layout, and widget selections of the dashboard you are viewing, but it does not contain the underlying report data. All widgets referenced in the dashboard are included in the exported file. An issue may arise if some of the exported widgets are user widgets and the user account importing a dashboard is a different user. Ideally, all widgets on your dashboard are site widgets so that they can be shared. This process is not related to saving your dashboard as a P. That information is located at How to save a dashboard as P. Note: The exported dashboard file may contain sensitive information. This is especially true of the dashboard name and description, which are included in clear text inside the exported file. To export a dashboard: 1. In the web interface, click Libraries > Dashboard Library. 2. Select a dashboard from the leftmost pane by clicking it. 3. Click Export. A file download begins in your web browser. The dashboard was successfully exported to a file and saved to a hard disk. How to import a dashboard Any dashboard that was previously exported can be imported into Apex. This creates a full dashboard, including its properties, layout, and widget selections, that existed when it was originally saved. To import a dashboard: 1. In the web interface, click Libraries > Dashboard Library. 2. Click Import. If you select a dashboard, this button becomes hidden. Click Discard to deselect a dashboard if this happens. A file prompt appears in your web browser. 3. Locate a dashboard file (file extension.oad) and upload it. 4. (Optional) If the Import Conflict prompt appears, you must fix these the conflicts and click Finish Import. You successfully imported a dashboard into Apex. Any widgets included in the dashboard were also imported and appear as user widgets. How to filter a dashboard Filtering a dashboard helps you isolate just the object of interest for you, such as a specific application, IP or MAC address, or telephone number in a VoIP conversation. 22 Understanding dashboards Apex (23 Jan 2016) Archive/Non-authoritative version

23 You can choose to permanently filter a dashboard or temporarily filter it using an ad hoc filter. An ad hoc filter is typed in the filter box at the top of a dashboard. It searches through the data in the widgets and displays any matching results. It remains in effect until it is cleared. Figure 5: Ad hoc filter dashboard for telephone number To permanently filter a dashboard: 1. In the web interface, click Libraries > Dashboard Library. 2. Select a dashboard from the leftmost pane by clicking it. The dashboard is now editable. 3. Click Properties in the rightmost tabs. 4. Type filter criteria into the Dashboard Filter box. For more information about filters, see Apex Filters. 5. Click Accept. The dashboard is now filtered. The permanent filter remains in effect on the dashboard at all times. How to save a dashboard as P You can save what a dashboard is currently showing you by saving it as a P. Apex has a feature for producing a P in just a few clicks. To save a dashboard as a P: 1. In the web interface, click My Dashboards. 2. Click a dashboard, from the leftmost panel, to view it. 3. Set your data source, reporting period, and apply any temporary dashboard filters (if desired). The goal is getting your dashboard to show the data you want saved in a P. 4. Click P. 5. In the dialog box that appears, configure how the P should appear. 6. Click OK. Understanding dashboards Chapter 3: Gather data from your products 23

24 The P is being generated for your dashboard. After it generates, the P becomes available for download. All time values are specified in UTC using the ISO8601 time format: " T04:06:16Z". The Z at the end of the format indicates that there is no time offset from UTC. UTC does not observe summer time (daylight savings time). It is also possible that UTC may be several hours different from your local time. The web UI client uses its local browser time, but all API requests use UTC. How to delete a dashboard You can delete a dashboard to permanently remove it from Apex. If you have authorization to delete dashboards, you can delete site dashboards and your own user dashboards. Deleting a user dashboard removes it from your user, while deleting a site dashboard removes it from all users. Note: System dashboards cannot be deleted. 1. In the web interface, click Libraries > Dashboard Library. 2. Select a dashboard from the leftmost pane by clicking it. 3. Click Delete. 4. Confirm the deletion by clicking Yes. You successfully deleted the dashboard, and it was permanently removed from Apex. If you deleted a site dashboard, no users will be able to view that dashboard. Understanding dashboard times Dashboards are very time sensitive. The data that appears on a dashboard changes or updates when the time frame changes. This can lead to different results. If your dashboard time frame is too short, your network may look better (or worse) than it actually is. A dashboard may take some time to load if you loading a longer period of time that contains a lot of data and reporting intervals. The data and reporting intervals used are determined by the time frame selected at the top of the dashboard. Data on the dashboard only changes when a new time frame is selected or when you manually reload it; it does not automatically update. Figure 6: Dashboard time frame Custom Last Allows you to create a unique time frame from minutes to years. Hour: If the current time is 11:48, then last hour is 10:00-11: Hours: If the current time is 11:48, then last twelve hours is 23:00 to 11:00. Day: If today is Wednesday, then last day is Tuesday. 24 Understanding dashboards Apex (23 Jan 2016) Archive/Non-authoritative version

25 Week: If today is Wednesday, then last week is from two Sundays ago to the most recent Saturday. Month: If this month is August, then last month is July. This Hour: If the current time is 11:48, then this hour is 11:00-11: Hours: If the current time is 11:48, then last twelve hours is 23:00 to 11:00. Day: If today is Wednesday, then last day is Tuesday. Week: If today is Wednesday, then last week is from two Sundays ago to the most recent Saturday. Month: If this month is August, then last month is July. To Date Week: If today is Wednesday, then To Date is Sunday until now on Wednesday. Month: If today is August 22, then To Date is August 1 until August 22. Trailing Hour: If the current time is 11:48, then trailing hour is 10:49-11: Hours: If the current time is 11:48, then trailing twelve hours is 23:49 to 11:48 (now). Day: If today is Wednesday at 11:48, then trailing day is from Tuesday (yesterday) at 0:00 to 11:48 Wednesday (now). Week: If today is Wednesday at 11:48, then trailing week is from last Wednesday at 0:00 to now. Month: If today is August 22, then trailing month is July 23 to August 22. Understanding dashboard auto-refresh When you select the auto-refresh option in your reporting period, dashboards automatically update. There are some factors to be aware of when auto-refresh is enabled. A primary benefit of using auto-refresh is to see current metrics at-aglance. With auto-refresh, it is feasible to have a dashboard continuously updating in a browser window while keeping that window on a separate display. In this way, you can stay informed of important networks and applications ata-glance. Another benefit of auto-refresh is to see frequent dashboard updates when it matters most, such as during scheduled maintenance period or cut-over of systems. During these times, it is important to see that you and your team are not introducing problems and that services are coming back online as expected. The refresh rate varies depending on the length of the report period. When the reporting period encompasses one hour or less, the dashboard will refresh approximately every 10 minutes. When the reporting period encompasses one hour or more, but less than 24 hours, the dashboard will refresh approximately each hour. When the reporting period is 24 hours or longer, the dashboard will refresh approximately once per day. However, if Last is chosen in the reporting period, dashboards refresh as often as the selection. Meaning, if Last covers the last five hours, dashboards refresh every five hours. Any time you navigate away from and revisit a dashboard, it resets its scheduled refresh; this is because revisiting a dashboard triggers a manual refresh (like always). Understanding dashboards Chapter 3: Gather data from your products 25

26 Viewing a dashboard while auto-refresh is enabled ignores the session timeout feature. This means that viewing a dashboard while auto-refresh is enabled will suspend Enable Session Timeout for as long as the dashboard is in view, so you can continue watching. In this specific scenario, the inactive user will not be signed out of Apex. The normal session timeout behavior (if set) continues to operate as normal when not viewing a dashboard. Auto-refresh is not always available to choose. The Auto-Refresh check box is available for Week, Day, and shorter time frames. The option does not appear if Month is chosen. Additionally, the option does not appear if the reporting interval is set to Custom, as that choice requires an absolute time frame so nothing would change even if the dashboard refreshes. Auto-refresh is available in all other selections. Under certain reporting period choices, auto-refresh will experience an additional one-minute delay before the dashboard refreshes. To ensure the best hard disk performance, Apex always takes advantage of the Data transfer delay (minutes) setting found in Settings > General Settings. Auto-refresh triggers 1-minute after this data transfer delay completes if the reporting period is set to This, To Date, or Trailing. This minimizes the chance that a dashboard will be refreshed at the same time the network trending data is writing to disk. This is a purely performance-driven design choice; viewing dashboards while Apex writes to disk in not a concern for you in your day-to-day use of Apex. However, you might have wondered why it took this extra minute. Additional Apex dashboards Use these contributed dashboards to quickly enhance how you use Apex to troubleshoot network, application, and server issues in your environment. Importing a user-contributed dashboard A dashboard s file extension is.oad. When you import a dashboard, it is a user dashboard and only viewable by you. If you want others to be able to use of the information displayed on these dashboards you must promote each one to a site dashboard. 1. Right-click any dashboard name from the table and save the.oad file to your system. 2. Import the dashboard. See How to import a dashboard. 3. (Optional) Promote the dashboard. See How to promote a dashboard. List of user-contributed dashboards Right-click the dashboard name to save the file to your system. 26 Dashboard name Description Network Performance Helps you determine if network roundtrip and latency are Understanding dashboards Apex (23 Jan 2016) Archive/Non-authoritative version Sample/ Layout Apex Lite compatible? Created in Yes

27 Dashboard name Description Apex Lite compatible? Created in Server Performance Helps you determine if a server is impacting performance and is having slow response times that are affecting users. See Is it the server? Yes Application Transaction Analysis Helps you determine if application transaction response times and application error conditions and the impact they can have on application server response times are the source of the problem affecting users. See Is it the application? Yes impacting server response time to users. It focuses on networkcentric information like network latency and delay, network roundtrip, device byte counts, retransmissions, and utilization. See Is it the network? Sample/ Layout Understanding dashboards Chapter 3: Gather data from your products 27

28 28 Dashboard name Description Device Health Analysis Apex Lite compatible? Created in Comprehensive network, server, and application information for a device, all in one dashboard. It also shows detailed application performance between a client/ server pair for in-depth analysis. Yes VoIP/UC Analysis Summaries for VoIP/ UC Analysis performance. Yes Web/HTTP Analysis Details from an HTTP perspective. Yes Forensic search table Shows data source, client and server IP and MAC addresses, IP protocol, link protocol, completed and dropped requests, observed connections, and packets sent (client and server) in a table. Yes VoIP/UC search table Shows VoIP calls by name, number, IP type, station, jitter (ms) maximum, average packet loss, codec, and data source. Yes Understanding dashboards Apex (23 Jan 2016) Archive/Non-authoritative version Sample/ Layout

29 Dashboard name Description Forensic ADM Sample/ Layout Apex Lite compatible? Created in Shows total requests between network devices in a map layout. Perfect for focused searching and troubleshooting! No Multi-tier system analysis Intended to track performance of multitiered applications using an application dependencymap at top for identification with client/ server/ applicationfocused tables below to identify application and inter-tier performance issues based on network response time, application request times, and application response times. No Traffic sent/ received by site or subnet Having both bits/sec and % util on the same dashboard you get to see the actual traffic rate and you can calculate the total bandwidth. Yes Understanding dashboards Chapter 3: Gather data from your products 29

30 Dashboard name Description Alarms 1 Alarms 2 Sample/ Layout Apex Lite compatible? Created in A dashboard showing the current status of web response times with a table of the corresponding data. Current status and entries are shown for database and SQL averages, file server and CIFS/ SMB response times, and VoIP MOS average and VoIP quality. No Another dashboard showing HTTP, SQL, file server, data center, VoIP, and application status. No Understanding thresholds Thresholds are defined values that determine if a statistic is above, below, or within a normal range on your network. Thresholds are also used when displaying colors in dashboards. Anything below the marginal threshold is green, anything between the marginal and critical threshold is yellow, and anything above the critical threshold is red. Thresholds can also be used as part of status widgets that are based on either performance or a baseline. How to configure thresholds In Apex, the default thresholds are pre-configured, so additional setup is rarely needed. If necessary, you can change them to better reflect your network conditions. To configure a threshold: 1. In the web interface, click Settings > Thresholds. 2. Select one by clicking a table row. The editing pane appears. 30 Understanding thresholds Apex (23 Jan 2016) Archive/Non-authoritative version

31 3. Edit one or more of the following choices: Threshold Type Threshold Type sets whether the threshold is crossed above or below its marginal and critical values. Marginal Value Marginal Value determines if a statistic is slightly out-of-range for your network. Based on Threshold Type, 'marginal' is either above or below this value, and widgets display a yellow color if a 'Marginal Value' is crossed. Performance based thresholds use actual values, while baseline thresholds use percentage values. Critical Value Critical Value determines if a statistic is greatly out-of-range for your network. Based on Threshold Type, 'critical' is either above or below this value, and widgets display a red color if a 'Critical Value' is crossed. Performance based thresholds use actual values, while baseline thresholds use percentage values. 4. Click Accept. You successfully configured a threshold to better reflect your network conditions. Understanding threshold color bars in tables Threshold color bars in table widgets reveal when normal, marginal, and critical values are observed during a reporting period. For example, a table with threshold color bars can display which hours today had critically poor VoIP MOS scores instead of summarizing the full day only. You can identify occurrences of poor network performance within a reporting period by using threshold color bars. A table widget can be enhanced to show increments of time when marginal and critical thresholds have been crossed. If you notice a threshold has been crossed and want to investigate, you can click a threshold color bar for more options and GigaStor drill-down. Threshold color bars are unique to table widgets. No other widget types support threshold color bars. You must edit the data fields of your table widget to enable this option, as threshold color bars are not enabled by default when creating a table widget. Threshold color bars require your table widget have its reporting interval be set to Summary. Meaning, the option is unavailable in table widgets that have By Time set as the reporting interval. If you want the summary values to also show in your table widget, consider also selecting Include Summary Column when editing the data field. This inserts another column in the table that represents the total values. Threshold color bars can only be enabled in threshold-supporting data fields. This means that only certain data fields (and never key fields) show the option. If the data field supports either baseline or performance thresholds and either of those is selected then the threshold color bars option is available while you edit the data field. Additionally, threshold color bars cannot work if you set Threshold Type to None, so the option is hidden in these cases. The color of each threshold color bar is significant. Green means normal; yellow means marginal; and red means critical. See Understanding status widgets for more details about threshold values and colors. Understanding thresholds Chapter 3: Gather data from your products 31

32 Conditions for threshold color bars to appear The option to enable threshold color bars appears only under certain conditions. These conditions only apply to the data fields in your table widget, and they are described in the following table. Table 2: Data field conditions for threshold color bars to appear Widget > Table Table Reporting Interval > Summary By Time Data field set to performance or baseline threshold Yes No Data field supports thresholds but is set to None No No Data field does not support thresholds No No Understanding widgets Widgets are tables, graphs, pie charts, and more, made to display information collected by Observer Platform products. For widgets to have any effect, they must be put into dashboards. Widgets are the building blocks of your dashboards. Every widget type is designed to help you better understand the traffic of your network. For example, the graph widget type could help you visualize traffic over time, while a chart widget type could display which protocols contributed most of the traffic during the report period. 32 Understanding widgets Apex (23 Jan 2016) Archive/Non-authoritative version

33 Figure 7: The Widget Properties tab Widgets show the data collected by other products. Widgets show the data collected by data sources. Data sources are your other Observer Platform products. This retrieved data, from data sources, is parsed by Apex and displayed in dashboards that include the widget. Without dashboards to operate inside, widgets will not show any data. System widgets are available "out-of-the-box" and cannot be modified. Widgets that were created by Viavi are available to you as system widgets. System widgets are identical in function to widgets you create on your own, but system widgets cannot be modified. As your teams become comfortable with creating their own widgets, you might develop less reliance on these. We recommend using system widgets as needed, and even exploring how the system widgets were created can aid your learning about Apex! Widgets can be filtered. The purpose of widget filtering is to narrow the scope of reported criteria, so the end result, like a graph, is specific and easily understood by viewers. Any widget can have a filter written directly into its design. Widget filters force the widget to display only information that meets the filter. For example, you can filter a widget so that it shows statistics from only specific applications or ports. The filter can be applied to the design of the widget itself, which creates always-filtered results when viewing that widget. You can combine a widget filter with other filtering techniques, such as filtering the dashboard or business group, to further filter your results. The widget retains its filter regardless of the dashboards it is placed into. Finally, filtering a widget will not displace or modify your underlying data. Understanding widgets Chapter 3: Gather data from your products 33

34 The same widget can be put into different dashboards. Widgets can be reused by any number of dashboards. For example, if a widget is placed in one dashboard, the widget can also be put into a different dashboard. Each "instance" of a widget behaves exactly the same regardless of the dashboard, or dashboards, it was placed into. There are some exceptions, however. One example is if a dashboard or business group is being filtered, the information shown by the widget is influenced by the filter. Under these circumstances, it is possible for the same widget to display different information based on the filter of its parent dashboard or business group. How to create a widget You can create a widget to track the performance of your networks. The completed widget should be added to a dashboard. To create a widget: 1. In the web interface, click Libraries > Widget Library. 2. Click Add. If you select a widget, this button becomes hidden. Click Discard to de-select the widget. 3. Use the menus and options shown to configure a widget. You can click the Next and Previous buttons to navigate through these menus, or you can click the tabs. 4. Save your widget by clicking the Edit Fields tab and clicking Finish. You successfully created a widget that can be added to a dashboard. How to add a widget to a dashboard To add a widget to a dashboard: 1. In the web interface, click Libraries > Dashboard Library. 2. Select a dashboard from the list by clicking one. 3. If there are no empty slots in the dashboard, add more by clicking Add Rows and choosing an option. An empty slot is necessary whenever adding a widget. 4. Click Widgets to display a list of available widgets. 5. Place a widget into an empty slot using a drag-and-drop operation. You successfully added a widget to a dashboard. When viewing this dashboard, the widget that was added will display its metrics. How to filter a widget You can filter individual widgets if desired. Meaning, the smallest building-blocks of your dashboards, like tables and graph widgets, can be filtered to focus on specific portions of your network, protocols, and more. The intended purpose of widget filtering is to narrow the scope of report criteria, so the end result (like a graph) is specific and easily understood by viewers. Filtering a widget does not displace or modify any underlying network trending data. 34 Understanding widgets Apex (23 Jan 2016) Archive/Non-authoritative version

35 To filter a widget: 1. In the web interface, click Libraries > Widget Library. 2. Select a widget from the leftmost pane by clicking it. The widget is now editable. 3. Ensure the Widget Properties tab is selected. 4. Type filter criteria into the Filter box. For more information about filters, see Apex Filters. 5. Click Accept. The widget now has a filter. Anywhere the widget is used any dashboard the filter remains in effect. How to edit a widget Editing a widget changes its behavior in any dashboard it is used in. You can edit a widget at any time. To edit a widget: 1. In the web interface, click Libraries > Widget Library. 2. Select a widget from the leftmost pane by clicking it. The widget is now editable. 3. Use the menus and options shown to configure a widget. You can click the Next and Previous buttons to navigate through these menus, or you can click the tabs. 4. Click Accept. The widget was successfully edited. Any dashboard the widget is used in will immediately reflect your changes. How to export a widget Every widget can be exported to a downloadable file. The file can be used for many purposes, such as archival, back ups, or to import back into Apex. The exported widget contains all the properties, fields selections, and configuration of the widget you are viewing. Note: The exported widget file may contain sensitive information. This is especially true of the widget title and customized names for fields, which are included in clear text inside the exported file. To export a widget: 1. In the web interface, click Libraries > Widget Library. 2. Select a widget from the leftmost pane by clicking it. 3. Click Export. A file download begins in your web browser. The widget was successfully exported to a file and saved to a hard disk. Understanding widgets Chapter 3: Gather data from your products 35

36 How to import a widget Any widget that was previously exported can be imported into Apex. This creates a full widget, including its properties and field selections, that existed when it was originally saved. To import a widget: 1. In the web interface, click Libraries > Dashboard Library. 2. Click Import. If you select a widget, this button becomes hidden. Click Discard to de-select the widget. A file prompt appears in your web browser. 3. Locate a widget file (file extension.oaw) and upload it. 4. (Optional) If the Import Conflict prompt appears, you must fix these the conflicts and click Finish Import. You successfully imported a widget into Apex. How to delete a widget Deleting a widget removes it from every dashboard it is used in, and it also deletes the widget entirely from Apex. Note: System widgets cannot be deleted from Apex. To delete a widget: 1. In the web interface, click Libraries > Widget Library. 2. Select a widget from the leftmost pane by clicking it. The widget is now editable. 3. Click Delete. 4. Confirm the deletion by clicking Yes. The widget was successfully deleted from Apex. Understanding key fields A key field provides context for your measurements. For example, measuring Bits Received from your web server can be helpful, but it is extra helpful to categorize those bits received by the application used. Application is a key field that makes this happen. 36 Understanding widgets Apex (23 Jan 2016) Archive/Non-authoritative version

37 Figure 8: Editing a widget - this is where you select key fields Most widgets have no context until a key field is added. Most measurements your data sources collect and pass to Apex are just numbers they are pieces of information. After you give the numbers some context, like a key field will do, you begin to create knowledge. This is the difference between knowing your average VoIP MOS score is low and determining which UC Manager is responsible for lowering the average. Generally, you can think of key fields as legends, like the legends included in a bar graph. That statement is not always true, though, because it depends on the widget type you choose to use. For example, status widgets do not even use key fields. Here are some examples of where key fields are seen: Bar graphs by summary the key fields combine to represent each bar. Line graphs by time the key fields combine to represent each line. Pie charts the key fields combine to represent each piece of pie. Tables by summary each key field is a column, and even the data fields get columns too. Adding more than one key field is acceptable. Suppose you want to see packet volume over time by application. Your data field would be Packets/ sec Total and your key field Application. But what if you want more than just packet volume over time by application? What if it is important to know the MAC address as well? Just add MAC Address - Client and/or MAC Address - Server as key fields, depending on which endpoints are important to you. If you were editing a table widget, the table would begin showing the MAC addresses. Filters will interact with your chosen key fields, and sometimes that is unwelcome. For example, having a key field of VLAN Tag ID and a dashboard or widget filter that ignores all measurements from VLAN 1, VLAN 2, and VLAN 3, can show you VLAN tag IDs from VLAN 4 or greater only. Maybe this is what you intend, but sometimes it might cause confusion or negatively influence your understanding. Widget settings Widget settings determine what your widget looks like, what type it is, how many items appear in the widget, and more. Title The name of this widget. The name shows on the widget when viewed in a dashboard. Understanding widgets Chapter 3: Gather data from your products 37

38 Widget titles are all you see when making dashboards, so be descriptive. Widget Type Build a widget from one of several base types. For details about widget types, see Widget types and categories. Reporting Interval Reporting Interval controls how data is displayed by this widget. Summary Sum of all values collected during the reporting period By Time Individual values collected during the reporting period Graph Type Sets or changes the graph type. Max Items Sets the maximum number of results drawn in the widget even if more results are available. Valid Input: Valid values are The default is 10. The types of items drawn differ between widget types and field combinations. Filter Filter strings can be added to narrow your results. For details about filter strings, see Apex filters. Hide empty columns If selected, this widget hides fields that contain no data. Fields can hide if no data was collected or no activity occurred during the reporting period. Widget types and categories Each widget type displays information differently. Table widgets report any type of data by summary or by time. Reporting Interval controls how data is displayed by this widget. Graph widgets expose trends and correlations hidden in your data. Chart widgets illustrate the distribution of a total value. Status widgets provide the best indication of current performance. ADM widgets display the observed dependencies of a multi-tier application, such as the servers involved and clients served. Understanding status widgets Status widgets show current performance or current performance relative to a known baseline. 38 Widget types and categories Apex (23 Jan 2016) Archive/Non-authoritative version

39 Figure 9: Status Dial and Arc There are important differences to be aware of when looking at a status widget. First, you must know whether you are looking at a widget showing actual current performance or a widget showing current performance relative to a baseline. Second, you must be aware of the From/To time frame for the entire dashboard because all widgets and especially baseline widgets are based on the time frame (and the number of data periods) in the time frame. Third, baseline status widgets show a numeric value, but whether that value is green, yellow, or red is determined by the percentage difference in the variance from the baseline value. Performance widgets are also green, yellow, or red, but their status is determined by whether the current value is higher or lower than threshold value for that category. Whether the widget is green, yellow, or red is based This is a subtle but important distinction between performance widgets and baseline widgets. When a status widget combines multiple data fields the status shown is for the worst-performing component. For example, consider a status widget for an application. That application is really comprised of a database, some middleware, and several servers. Each one of those components has its own status. If any one of them shows a yellow or red status, then the top-level application status will also show yellow or red based on the worst performing component. In case there are multiple statuses that are equally bad, then the top-level status shows the worst of the worst. This is so you know where to focus your attention first. When no current value is available for a status widget, the widget displays a No data message. For baseline status widgets, if there is a current value but no baseline is available, the widget appears grayed out with the current value also shown as gray. If a status widget s current value and its threshold data are zero (0), the widget will either be green or red depending on the above or below threshold setting. Widget types and categories Chapter 3: Gather data from your products 39

40 Widget fields by data stream type and widget type This table lists every data field and key field in Apex and shows the data stream it came from and in what widget type each can be used. Table 3: Widget fields and data streams Type of Data Stream APA ATA Widgets Types for Fields VoIP Summary By Time Available FieldPair IP APATrading General URLSQLFI Summary CallsServer Table Graph Chart Status ADMTable Graph Graph 1 Fields Data Subnet Multicast Threshold Type 40 Alignment Errors 1 > 2 Alignment Errors 1 <2 Alignment Errors Client > Server Alignment Errors Client <Server Alignment Errors Rx Alignment Errors Total Alignment Errors Tx Audio Bits/ Sec Audio Bytes Audio Packets Average Call Duration (seconds) Widget types and categories Apex (23 Jan 2016) Archive/Non-authoritative version

41 Type of Data Stream APA ATA Average Call Setup Duration (seconds) Widgets Types for Fields VoIP Summary By Time Bits/ sec 1 > 2 Bits/ sec 1 <2 Bits/ sec Client > Server Bits/ sec Client <Server Bits/ sec Rx Bits/ sec Total Bits/ sec Tx Broadcast Packets Tx Broadcast/ Multicast Packets Tx Total Burst % Average Burst Density % Average Widget types and categories Chapter 3: Gather data from your products 41

42 Type of Data Stream APA ATA Burst Duration Average (seconds) 42 Widgets Types for Fields VoIP Summary By Time Bytes 1 > 2 Bytes 1 <2 Bytes Client > Server Bytes Client <Server Bytes Rx Bytes Total Bytes Tx Bytes/ sec 1 > 2 Bytes/ sec 1 <2 Bytes/ sec Client > Server Bytes/ sec Client <Server Widget types and categories Apex (23 Jan 2016) Archive/Non-authoritative version

43 Type of Data Stream APA ATA Widgets Types for Fields VoIP Summary By Time Bytes/ sec Rx Bytes/ sec Total Bytes/ sec Tx CRC Errors 1 > 2 CRC Errors 1 <2 CRC Errors Client > Server CRC Errors Client <Server CRC Errors Rx CRC Errors Total CRC Errors Tx Call Count Call Phones Address List Call Start Time Call Station Widget types and categories Chapter 3: Gather data from your products 43

44 Type of Data Stream APA ATA Address List VoIP Summary By Time Calls Closed Calls Started Codec List Completed Requests Control Bits/ Sec Control Bytes Control Packets Data Bits/ Sec Data Bytes Data Packets Dropped Requests 44 Widgets Types for Fields Gap Density % Average Gap Duration Average (seconds) Goodput Bits/ sec Client > Server Goodput Bits/ sec Client <Server Goodput Bytes Client - Widget types and categories Apex (23 Jan 2016) Archive/Non-authoritative version

45 Type of Data Stream > Server APA Widgets Types for Fields ATA VoIP Summary By Time Goodput Bytes Client <Server Goodput/ Throughput % Client > Server Goodput/ Throughput % Client <Server IP ToS Maximum IP ToS Minimum Jitter (ms) Average Jitter (ms) Maximum Jitter (ms) Minimum Jitter Average Jitter Maximum Jitter Minimum Loss Rate Average MOS Audio Average MOS Audio Maximum Widget types and categories Chapter 3: Gather data from your products 45

46 Type of Data Stream APA Widgets Types for Fields ATA VoIP Summary MOS Audio Minimum MOS Video Average MOS Video Maximum MOS Video Minimum Multicast Packets Tx Network Delay Average (ms) Client > Server Network Delay Average (ms) Client <Server Network Delay Maximum (ms) Client > Server Network Delay Maximum (ms) Client <Server Network Delay Round Trip (ms) Network Speed 46 By Time Widget types and categories Apex (23 Jan 2016) Archive/Non-authoritative version

47 Type of Data Stream Bits/ sec APA Widgets Types for Fields ATA VoIP Summary By Time Network Utilization Average Network Utilization Maximum Network Utilization Minimum Observed Connections Packets 1 > 2 Packets 1 <2 Packets Client > Server Packets Client <Server Packets Lost % Average Packets Out of Order Packets Rx Packets Total Packets Tx Packets/ sec 1 > 2 Widget types and categories Chapter 3: Gather data from your products 47

48 Type of Data Stream APA 48 ATA Widgets Types for Fields VoIP Summary By Time Packets/ sec 1 <2 Packets/ sec Client > Server Packets/ sec Client <Server Packets/ sec Rx Packets/ sec Total Packets/ sec Tx Quality Bits/ Sec Quality Bytes Quality Packets R- Factor Audio Average R- Factor Audio Maximum R- Factor Audio Minimum R- Factor Video Average R- Factor Widget types and categories Apex (23 Jan 2016) Archive/Non-authoritative version

49 Type of Data Stream APA Widgets Types for Fields ATA Video Maximum VoIP R- Factor Video Minimum Summary By Time Request Bits/ sec Request Bytes Request Bytes/ sec Request Packets Response Bits/ sec Response Bytes Response Bytes/ sec Response Packets Response Time Average (ms) Response Time Average (ms) Client > Server Response Time Average (ms) Client <Server Response Time Distribution Response Time Widget types and categories Chapter 3: Gather data from your products 49

50 Type of Data Stream APA ATA Maximum (ms) 50 Widgets Types for Fields VoIP Summary By Time Response Time Maximum (ms) Client > Server Response Time Maximum (ms) Client <Server Retransmissions Client > Server Retransmissions Client <Server Retransmissions Too Fast Client > Server Retransmissions Too Fast Client <Server Runt Errors 1 > 2 Runt Errors 1 <2 Runt Errors Client Widget types and categories Apex (23 Jan 2016) Archive/Non-authoritative version

51 Type of Data Stream > Server APA ATA Widgets Types for Fields VoIP Summary By Time Runt Errors Client <Server Runt Errors Rx Runt Errors Total Runt Errors Tx Size Distribution 1 > 2 Size Distribution 1 <2 Size Distribution Client > Server Size Distribution Client <Server Size Distribution Rx Size Distribution Total Size Distribution Tx Subnet Network Speed Widget types and categories Chapter 3: Gather data from your products 51

52 Type of Data Stream Bits/ sec APA Subnet Range Address Pair ATA VoIP Summary By Time Too Big Errors 1 > 2 Too Big Errors 1 <2 Too Big Errors Client > Server Too Big Errors Client <Server Too Big Errors Rx Too Big Errors Total Too Big Errors Tx Total Requests Total Responses Trading Multicast Goodput 52 Widgets Types for Fields Widget types and categories Apex (23 Jan 2016) Archive/Non-authoritative version

53 Type of Data Stream Bits/ sec APA ATA Widgets Types for Fields VoIP Summary By Time Trading Multicast Goodput Bytes Trading Multicast Goodput Bytes/ sec Trading Multicast Goodput/ Throughput % Trading Multicast Packets Lost Trading Multicast Packets Lost % Trading Multicast Packets Out Of Order Trading Multicast Packets Out Of Order % Trading Multicast Packets Total Trading Multicast Packets/ sec Lost Trading Multicast Packets/ sec Out Widget types and categories Chapter 3: Gather data from your products 53

54 Type of Data Stream of Order 54 APA ATA Widgets Types for Fields VoIP Summary By Time Trading Multicast Packets/ sec Total Trading Multicast Throughput Bits/ sec Trading Multicast Throughput Bytes Trading Multicast Throughput Bytes/ sec Utilization 1 > 2 Utilization 1 <2 Utilization Client > Server Utilization Client <Server Utilization Rx Utilization Subnet 1 > 2 Utilization Subnet 1 <2 Widget types and categories Apex (23 Jan 2016) Archive/Non-authoritative version

55 Type of Data Stream APA ATA Widgets Types for Fields VoIP Summary Utilization Subnet Total By Time Utilization Total Utilization Tx Video Bits/ Sec Video Bytes Video Packets VoIP Bits/ Sec Total VoIP Bytes Total VoIP Packets Total Zero Windows Client > Server Zero Windows Client <Server Application KF Browser KF Browser KF Platform Browser KF Version DataKF Source Ethertype KF FI KF Order Type Request FI KF Order Widget types and categories Chapter 3: Gather data from your products 55

56 Type of Data Stream APA Type Response ATA IP KF Address IP KF Address Client IP KF Address Pair IP KF Address Server IP KF Protocol LinkKF Protocol MACKF Address MACKF Address Client MACKF Address Pair MACKF Address Server MPLS KF Label MPLS KF Label Client MPLS KF Label Pair MPLS KF Label Server NetFlow KF Autonomous System 56 Widget types and categories Apex (23 Jan 2016) Archive/Non-authoritative version Widgets Types for Fields VoIP Summary By Time

57 Type of Data Stream APA ATA Widgets Types for Fields VoIP Summary By Time NetFlow KF Autonomous System Client NetFlow KF Autonomous System Pair NetFlow KF Autonomous System Server NetFlow KF Interface Index NetFlow KF Interface Index Client NetFlow KF Interface Index Pair NetFlow KF Interface Index Server Network KF Type PortKF PortKF Client PortKF Pair PortKF Server Request KF Code Response KF Code SQL KF Statement Widget types and categories Chapter 3: Gather data from your products 57

58 Type of Data Stream APA ATA Widgets Types for Fields VoIP Summary By Time Subnet KF Range Trading KF Multicast Stream Identifier Trading KF Multicast Stream Name URLKF VLAN KF Tag ID VoIPKF Call VoIPKF Device IP VoIPKF IP Type VoIPKF Station IP 1. =data field; KF=key field Understanding an application dependency map (ADM) An application dependency map widget (ADM) allows you to discover and map the connections responsible for a functioning multi-tier application. Multi-tiered applications typically rely on multiple servers passing information. In complex network environments, it can be difficult to track or realize the dependency one server has on another server. The application dependency map element can help expose those dependencies. For example, you may have legacy equipment in your network environment. This equipment has been on your network for years, but what exactly is it responsible for? Would removing it from the network harm any existing applications and solutions? The answers may have been lost over time, but Apex can help you understand those dependencies before you act. Visualizing the components of multi-tier applications Using data from Application Performance Analysis, multi-tier applications can be automatically parsed and visualized as a diagram. Each diagram displays the observed dependencies of a multi-tier application, such as the servers involved and clients served. 58 Understanding an application dependency map (ADM) Apex (23 Jan 2016) Archive/Non-authoritative version

59 The workflow requires steps be performed from Libraries > Dashboard Library and some steps while viewing the widget from My Dashboards. These are the high-level steps required: 1. Add a application dependency map widget to a new or existing dashboard. For details, see How to create an application dependency widget. 2. Begin your discovery from the widget. For details, see How to operate an application dependency widget. The connecting lines interact with the thresholds set in Settings > Thresholds. Green lines indicate no marginal or critical threshold has been crossed. Yellow lines indicate a marginal threshold has been crossed. Red lines indicate a critical threshold has been crossed. How to create an application dependency widget An ADM widget must be created and added to a dashboard before it can be fully configured and viewed. To create an application dependency map widget: 1. In the web interface, click Libraries > Widget Library. 2. Click Add. Understanding an application dependency map (ADM) Chapter 3: Gather data from your products 59

60 3. Under Widget Type, click the ADM widget type. 4. Use the menus and options shown to create a widget. You can click the Next and Previous buttons to navigate through these menus, or you can click the tabs. 5. Save your widget by clicking the Edit Fields tab and clicking Finish. You successfully created an ADM widget. The ADM widget can be added to a dashboard and then configured to operate. How to operate an application dependency widget After adding an application dependency map widget to a dashboard, further use of the widget now occurs while viewing the dashboard. Prerequisite(s): These steps assume you have already added an application dependency map widget to your dashboard and are viewing that dashboard from My Dashboards. For details, see How to create an application dependency widget. To operate an application dependency map widget: 1. In the web interface, click My Dashboards. 2. In the leftmost panel, click any dashboard that includes an ADM widget. 3. Unlock the ADM widget by clicking the Lock icon in the upper-right corner of the ADM widget. Some new icons and functionalities now appear. 4. Click. The Discover Servers window appears, allowing you to configure the criteria for your server search. 5. Set the criteria for your server search as broad or narrow as necessary, and click OK to start the discovery. For example, to discover all stations that used LDAP or MySQL this week, type LDAP, MySQL into the Application(s) box. Then click inside the Time Range box and select This and Week from the resulting prompt and click OK. 6. Select the servers of interest from the resulting list, and click OK to add them to the ADM widget. 7. Right-click any of the servers (nodes) that appear in the ADM widget, and click Discover Connections. 8. Select the servers or clients of interest from the resulting list, and click OK to add them to the ADM widget. This process should be repeated for every server node of interest. Connecting lines appear between the original node and its servers and clients, exposing the relationships between the addresses. 9. When you are finished, click the Save icon in the upper-right corner of the ADM widget. 10. Lock the ADM widget by clicking the Lock icon in the upper-right corner of the ADM widget. 60 Understanding an application dependency map (ADM) Apex (23 Jan 2016) Archive/Non-authoritative version

61 The connecting lines interact with the thresholds set in Settings > Thresholds and the reporting interval. Each line can be clicked for additional information. After you are finished, you can rearrange the nodes on the ADM widget by clicking and dragging. The widget must be unlocked for rearrangements to be made. Understanding scheduled reports A scheduled report is a report that is sent out by at specified times. You can specify what is included; who should get the report; and how often it will be sent. Scheduled reports are static, which means they do not change even if the underlying data changes. A P attachment is sent to recipients specified in the scheduled report, and the content inside the P is a snapshot of data from your dashboard and data source. Using the Apex web interface, you can also find the data dynamically, but having Apex do so automatically is a convenient way to get information without having to search for it. It simply arrives in your inbox. The scheduled report contains data for the time frame you selected, relative to the time you set the scheduled report to execute. So when creating a scheduled report, you must specify the report schedule intervals, which are the times the report executes and a P is prepared. For most of these schedule intervals, there are Execution Frequency and Execution Period lists that must be configured to your liking. For example, if you schedule the report to execute every one hour (Execution Frequency is 1 Hour) for the last one hour (Execution Period is Last 1 Hour) from 13:00 to 15:00, it will execute at 13:00 against trending data from the time period 12:00-13:00; at 14:00 for the period 13:00-14:00; and at 15:00 for the period 14:00-15:00. The scheduled report itself will typically be sent to recipients about minutes after each execution, to allow time for the data to be transferred the wait is usually Data transfer period (minutes) plus Data transfer delay (minutes) but the data it runs against is from your specified times, always. Understanding scheduled reports Chapter 3: Gather data from your products 61

62 Figure 10: Execution times from our example Optionally, a filter can be applied to any scheduled report. The filter on your scheduled report is in addition to other applicable filters like business group filters, dashboard filters, and widget filters. The scheduled report filter takes effect after all other filters, so it is equivalent to using the ad hoc filter that looks like a search box when viewing dashboards normally. If the business group or dashboard selected in your scheduled report is deleted, the scheduled report is also deleted. For example, if you delete a business group from which three scheduled reports are using, all three scheduled reports will be deleted. These deletion events appear in the event log, but no explicit notifications of deletions are sent to the recipients. How to create a scheduled report A scheduled report is a snapshot of a dashboard that is sent out by at specified times. recipients can then view the dashboard as a P. To create a scheduled report: 1. In the web interface, click Settings > Scheduled Reports. 2. Click New. 3. Configure the options for your scheduled report. See Scheduled report options for reference. 4. Click Accept. 62 Understanding scheduled reports Apex (23 Jan 2016) Archive/Non-authoritative version

63 You successfully created a scheduled report. During each scheduled time frame, a P is created and an is sent to recipients. How to edit scheduled reports After creating a scheduled report, you may need to periodically edit it to meet your needs. To edit a scheduled report: 1. In the web interface, click Settings > Scheduled Reports. 2. Select one by clicking a table row. 3. Make any edits you need. 4. Click Accept. You successfully edited a scheduled report, and the changes take effect immediately. Scheduled report options There are several options that affect your scheduled reports. Scheduled Report Name The name of this scheduled report. Business Group The business group must be specified. Dashboard Sets which dashboard a scheduled report is made from. Filter Filter strings can be added to narrow your results. P Orientation Sets the orientation of the P output. P Layout Sets how widgets are displayed in the resulting P. addresses Scheduled reports are sent to the specified address or addresses. Example: chris@example.com -orchris@example.com;pat@example.com multiple recipients by separating each address with a semi-colon ';' or comma ','. Report Schedule Set the times and days when this scheduled report executes. Understanding GigaStor Report drill down GigaStor Report drill down refers to following data entries shown in Apex dashboards and widgets directly to packets stored in the GigaStor. This also passes any applicable Apex filters to the GigaStor Control Panel (GSCP). For GigaStor Report drill down to work, the computer system viewing Apex from a web browser must also have Observer installed within it. Without Observer installed on the same system as the one being used to view the Apex dashboard, a drill down from Apex to the GigaStor probe instance will fail because the target GigaStor probe instance would be unavailable. Understanding GigaStor Report drill down Chapter 3: Gather data from your products 63

64 Overall steps needed for drill down GigaStor Report drill down requires setup in both Observer and Apex before it can be used. The initial setup may take some time, but no further configuration is necessary unless you need to make changes. Table 4: What to do in Observer/GigaStor 64 What to have configured Purpose for doing this Observer must be installed and running on the same local system that the dashboard is being viewed from and that is attempting the GigaStor Report drill down. Apex opens the GSCP in Observer when drill down is successful. Therefore, this can only occur if Observer is installed locally. Your GigaStor probe instance(s) to drill down on must be shown as Connected (green color), which implies that this probe instance is available for use. The drill down operation will fail if your local probe instance is disconnected/unavailable or is redirected to a different Observer system than yours. The target GigaStor probe instance must be bound to the correct active instance for which the packet data is stored and written to disk. This ensures that the probe instance is able to data mine on the correct set of data written to disk. Otherwise, you run the risk of performing drill down into data that you might not care about. The correct Apex data source mapping between the data source in the business group and the GigaStor drill down probe instance(s) must be made. This enables Apex to properly make the correct connection between the dashboard data entry, shown for a given data source and the actual GigaStor probe instance which may contain the specific packet data related to that Apex data entry. The GSCP in Observer must be accessible at the time of performing a drill down operation in Apex. For example, a scheduled packet capture cannot be occurring at If the GSCP is disabled on the probe instance, the drill down operation will fail. Understanding GigaStor Report drill down Apex (23 Jan 2016) Archive/Non-authoritative version

65 What to have configured Purpose for doing this this time because it temporarily disables the GSCP. Table 5: What to do in Apex What to have configured Purpose for doing this The intended dashboard, within which GigaStor drill down is to be used, must contain a widget with the Data Source key field added to it. This enables an aspect of the relationship between the dashboard data entry and the actual GigaStor probe instance, which may contain the specific data, to be made. A probe instance that you want to drill down into must be part of the data source that is assigned to the business group for which the dashboard will be run. Assigning the data sources correctly enables the Apex dashboard to display the intended data during drill downs. How to prepare Observer for drill down The GigaStor probe instances in Observer must be configured correctly for drill down to operate in Apex. Ensure your active instances are configured correctly. To prepare Observer for drill down, ensure the GigaStor active instances are configured correctly: 1. Ensure the GigaStor probe instance(s) you want to drill down on are in a connected state. A connected probe instance is green. 2. Right-click a probe instance and choose Administer Selected Probe. 3. Click the GigaStor Instances tab. Understanding GigaStor Report drill down Chapter 3: Gather data from your products 65

66 4. Ensure your passive probe instances are bound to your active instances correctly. 5. Ensure that each passive probe instance can reach the GSCP by choosing Capture > GigaStor Control Panel. If you successfully reach the GSCP with probe instances, using them for drill down in Apex will be successful provided that all prerequisites have been met. How to prepare Apex for drill down Create a relationship between the GigaStor probe instance, inside an Apex data source, and the local probe instance. Use the GigaStor integration feature to create this relationship. To add the GigaStor for drill-down: 1. In the web interface, click Settings > GigaStor Integration. 66 Understanding GigaStor Report drill down Apex (23 Jan 2016) Archive/Non-authoritative version

67 2. Click New. The New GigaStor Integration Entry pane appears. 3. Select a business group from the Business Group list. 4. Select a data source from the Data Source list. 5. Select a remote probe from the Probe list. 6. Select a remote probe from the Instance list. 7. Under the Configure Mapping area, type details into the Asset IP/DNS, Username and Set password boxes. You are using the IP address and credentials of your locally installed Observer system connected to Apex through a web browser. If that describes your Understanding GigaStor Report drill down Chapter 3: Gather data from your products 67

68 laptop, for example, you would type your laptop s IP/DNS and its probe administration password. 8. Click Configure. Apex in your web browser connects to your local Observer and returns a list of probe instances. 9. Choose a "target" probe instance from the list that will open its GSCP. The probe instance must be able to open a GSCP locally. Typically, this probe instance is your GigaStor probe instance which may be redirected to your local Observer. This can be an active or passive probe instance. 10. Click Accept. How to configure a widget for drill down GigaStor drill down can be performed only on dashboard widgets that have included the Data Source key field. Therefore, adding the Data Source key field to a widget is necessary for GigaStor Report drill down. Prerequisite(s): This process requires that you have already created a widget. Built-in (system) widgets cannot be used because they are read-only. To configure a widget for GigaStor Report drill down: 1. In the web interface, click Libraries > Widget Library. 2. Select a widget from the leftmost pane by clicking it. The widget is now editable. 68 Understanding GigaStor Report drill down Apex (23 Jan 2016) Archive/Non-authoritative version

69 3. Click Select Key Fields. 4. Select the Data Source key field. This adds the Data Source key field needed for drill down. 5. Click Accept. You added the Data Source key field to a widget and saved your changes. The widget is ready for GigaStor drill down, provided that all prerequisites have been met. GigaStor integration settings Business Group The business group in Apex that will map to a drill-down in GigaStor. Data Source The data source in Apex that will map to a drill-down in GigaStor. Probe The remote probe that has GigaStor data. Instance If seen in dashboard results, this probe instance can perform a drill-down to the GigaStor probe instance configured in the Configure Mapping area. Asset IP/DNS The IP address or DNS name of the remote Observer containing a list of GigaStor probes. Username The user name of an authorized user in OMS. If OMS is not in use, you may type any string of characters and they will be accepted. Set password The probe administration password of the Observer located at Asset IP/DNS. Configure Click to connect to the Observer set in Asset IP/DNS. GigaStor Probe Instances GigaStor instance to map to data source. Understanding GigaStor Report drill down Chapter 3: Gather data from your products 69

70 How to drill down using Apex After the GigaStor Report drill down feature is configured, you can follow Apex dashboards directly to packet data stored in a GigaStor. Prerequisite(s): To successfully drill down from Apex into a GigaStor, you must meet all prerequisites before continuing. Note: A drill down will fail if the Data Source key field shown on the dashboard s widget is part of a "nested" business group. To drill down using Apex: 1. In the web interface, click My Dashboards. 2. Select a dashboard from the leftmost pane by clicking it. Make sure you choose a dashboard that contains a widget with the Data Source key field inside. See How to configure a widget for drill down if you need to do this again. 3. Click inside the widget to show its Drill Down Menu. In table widgets, an entry in the column named Drilldown is what you click. 4. Click GigaStor Reports. Observer must be open and running in application mode not service mode. If the drill down is successful, the GSCP is brought into focus in Observer. The time frame is automatically selected to match your Apex dashboard. 70 Understanding GigaStor Report drill down Apex (23 Jan 2016) Archive/Non-authoritative version

71 5. Now in Observer, click Analyze and then OK. An Observer filter is automatically created to match what you saw in the Apex dashboard. 6. Ensure the GigaStor Drill Down filter is selected. Understanding GigaStor Report drill down Chapter 3: Gather data from your products 71

72 7. (Optional) Make further modifications to the GigaStor Drill Down filter if desired. The GigaStor Drill Down filter is temporary and overwritten each time a drill down is performed. You can save the filter under a new name and report folder to make it permanent. 8. Click OK to confirm all changes. The GigaStor now begins to load actual packets that meet the filter rules and time frame transferred from Apex. 72 Understanding GigaStor Report drill down Apex (23 Jan 2016) Archive/Non-authoritative version

73 4 Chapter 4: Installing and upgrading How to install Apex Apex is an intelligent reporting solution that users connect to using a web browser. We recommend you install Apex on a server or rack-mounted appliance. Prerequisite(s): Ensure you have the latest version of Apex before continuing. Download the latest version from our FTP site: ftp://ftp.observer.viavisolutions.com/pub/ downloads/observer/. See Supported Operating Systems for a list of supported operating systems. Caution: Do not uninstall your product prior to or after upgrading unless you intend to remove the product from your system. Beginning with Observer Platform 17.0, each Observer Platform product creates a security certificate that uniquely identifies it when it is installed. If you uninstall your product prior to upgrading, you will lose the trust relationship established by the security certificate and must re-authenticate. Uninstalling and reinstalling creates a new certificate. The new certificate will be automatically rejected by other Observer Platform products that had had a pre-existing association with the asset ID of the reinstalled software. For more details about the certificates, see Understanding the certificate trust model. To install Apex: We recommend backing up your existing installation if applicable. Simply run the self-extracting executable and follow the installation prompts.

74 You may be prompted to license the application during its first launch. This can happen when performing a clean installation, such as after a hard drive reformat. Provide your credentials if prompted. Supported Operating Systems Windows Vista (64-bit SP1 or higher) Windows 7 (64-bit SP1 or higher) Windows Server 2003 Enterprise, Standard, Web (64-bit SP3 or higher) Windows Server 2008 Enterprise, Standard, Web (64-bit SP2 or higher) Windows Server 2008 R2 Enterprise, Standard, Web (SP1 or higher) Windows bit Windows Server bit Windows 10 Pro, Enterprise, Enterprise 2015 LTSB 64-bit Ports used by Observer Platform v17 and later Open inbound and outbound TCP 80, 443, and on your firewalls for Observer Platform products version 17 and later. Port Functionality TCP 80 Requests from product to Viavi to see if a new version or update exists. TCP 443 Secure web server traffic. TCP 8008 Default port for transfer of software upgrades. TCP All intra-observer Platform communication. System specifications The system specifications in the table applies to appliances from Viavi. If you want to use the software version of Apex on your own hardware or to put Apex in a virtual machine, the table below lists the minimum requirements with these changes (as appropriate): DATA array: Four (4) disk RAID5. The more read speed you have, the better off you will be. Hard drives: 7200 RPM platter HDDs RPM HDDs and solid state drives (SSDs) are not recommended. Platform 2U 19-inch rack-mountable appliance. Memory/RAM 64 GB Processor(s) Single - Six Core Hard drive(s) OS: 500 GB / DATA: 8 TB (8 x 1 TB RAID5) Redundant Power Supply Yes; Standard Lights Out Management IPMI v2.0 Power consumption Input voltage: 100V-240V auto select Input frequency: 50/60Hz 258w (880 Btu/h) 74 How to install Apex Apex (23 Jan 2016) Archive/Non-authoritative version

75 Operating Temperature Range 32 F (0 C) to 104 F (40 C) Dimensions 19 in (W) x 3.48 in (H) x in (mounting depth) (Full probe depth with handles: 28 in) 48.3 cm (W) x 8.8 cm (H) x 66.1 cm (mounting depth) (Full depth with handles: 71.1 cm) Weight 55 lbs (25 kg) Operating system 64-bit Windows 7 Understanding your deployment strategy To use Apex effectively, you must understand how you have data sources deployed in your network. Where you install Apex, Observer Suite, and probes will depend on the size and traffic levels of your network. In general,high-traffic installations should have a dedicated Apex system, resulting in a three-tier distribution of Apex functionality: Apex Observer Suite analyzer(s) Probe instances that actually collect the data We highly recommend that any probe, Observer Suite, or Observer Infrastructure (OI) be installed on a system with a static IP address. Having a dynamic address may cause confusion with reports should the address for a system change. It becomes very difficult to correlate problems or history when addresses change. Tip! Create a unique probe instance on every probe that will be used for the sole purpose of collecting network trending data for Apex and call it Apex instance. Example 1. For larger networks or heavier traffic For larger networks, or networks with heavy traffic,apex can be installed on a different system than the Observer Analyzer analyzer used to collect network trending statistics. This forms a three-tier collection and reporting hierarchy with probes passing information to Observer and Observer passing information to Apex. Example 2. For smaller networks or lighter traffic For smaller networks, or networks with light traffic, the Apex appliance has Apex and Observer Suite pre-loaded to form a two-tier collection/reporting hierarchy. Installing the Apex appliance Getting your appliance installed is the first step to greater visibility of your network. This topic covers installing your appliance in the cabinet and connecting it to your network. Caution: Do not attempt in-cabinet repairs of your appliance. The appliance is very heavy! 1. Take the appliance and all other components out of their packing materials. 2. Install the rail kits. See How to install the Viavi rail kits. How to install Apex Chapter 4: Installing and upgrading 75

76 3. Install the appliance into the rails in your cabinet. Caution! The appliance is heavy. Lift with care. Do not turn on the appliance yet. 4. Install the drives into your Apex appliance. The RAID is pre-built and each drive must be installed in a very specific location. To install a drive, slide the drive in until it clicks firmly in place. See Installing the drives in your Observer Platform appliance for details. 5. Use the Ethernet cable to connect the management network interface card (NIC) in the appliance to the network. The next step is to set the appliance s IP address. How to install the Viavi rail kits Viavi rail kits are used with its 2U and 5U 19 inch rack-mounted appliances in four post L-bracket or U-bracket cabinets. Prerequisite(s): Identify whether the mounting posts in your cabinet are an L-bracket or Ubracket. This determines whether you must use the U-extension. If they look like a "U" (Figure 13), you have a U-bracket cabinet. If the mounting posts in your cabinet look like an "L" (Figure 14), you have an L-bracket cabinet. The Uextension is only used in L-bracket cabinets to provide extra length and support due to the weight of some of the appliances. The appliance ships with the long rail component attached. This provides a useful handhold when unpacking these larger appliances. Viavi manufactures its rails using high-grade, heavy duty materials. The parts of the rail kit include: Long rail component (2) Short rail component (2) U-extension (2) 8-32 flathead screws (8) panhead screws (4) 1. Measure the length of your cabinet from front mounting post to rear mounting post. 2. Remove the long rail component from the appliance. 3. Attach the short rail component to the long rail component. Adjust to the length between your mounting posts and set using the 8-32 flathead screws. Note: The rails are designed to be used in any manufacturer's cabinet. The width between the mounting posts can vary greatly from cabinet to cabinet. If loosening the screws and sliding the rails does not provide the correct length for your cabinet, you may need to separate the two rail components and flip the short piece and reattach it. 4. L-cabinets only: Attach the U-extension to the long rail component using the panhead screws. The rough side of the U-extension with the small protruding nodules must face towards the long rail component. The U must face towards the outside of the cabinet and away from the appliance (Figure 14). 76 How to install Apex Apex (23 Jan 2016) Archive/Non-authoritative version

77 5. Attach the rails securely to the cabinet using screws (not provided) appropriate for your cabinet to the front and rear mounting posts. 6. Insert the empty appliance, then install any hard drives (if applicable). Figure 13: U-bracket Cabinet Figure 14: L-bracket Cabinet with U-extension How to install Apex Chapter 4: Installing and upgrading 77

78 Installing the drives in your Observer Platform appliance Failure to install the drives in the proper location will result in poor read/write performance until the RAID array volume is rebuilt. Follow these instructions to install the drives correctly before starting the appliance. Stickers on each drive identify which slot it should be installed in. The drive labeled A1 must be installed in the upper left slot of the appliance. 1. Make sure that the appliance is turned off. 2. Locate the drives that comprise the array. The drives are labeled to show you where they should be installed in the drive cage. (Image may not exactly match your product.) Figure 15: Appliance front 3. To install a drive, slide the drive in until it clicks firmly in place. Repeat until all of the drives are firmly installed as labeled. To install the bottom row of drives, the door may need be hanging down or completely level. 4. Turn on the system. Check that every LED light is blue. If not, turn off the system and reinsert the drive into its cage. Confirm that it clicks into place. Tug each drive slightly to ensure that it is properly seated. It should not move or come out. Additionally, you may want to visually inspect all of the drives from the side to verify that they are all sitting at the same approximate depth. Check any that are protruding. Figure 16: RAID drive The RAID drives are now in place and you can turn on the appliance. How to handle hard drives properly Be especially careful when handling and installing the hard drives. Proper handling is paramount to the longevity of the unit. The internal mechanism of the hard drive can be seriously damaged if the hard drive is subjected to forces outside its environmental specifications. 78 How to install Apex Apex (23 Jan 2016) Archive/Non-authoritative version

79 Caution: When transporting the hard drive, always use the original packaging in which the hard drive was delivered to you, and avoid exposing the hard drive to extreme changes in temperature to minimize the risk of condensation. Each drive for the appliance is packed in shock-resistant boxes. Never drop the unit. Handle it with care. Never place the hard drive in the vicinity of equipment giving off strong magnetic fields, such as CRT monitors, televisions, or loudspeakers. Always use an anti-static mat and wrist strap when handling the hard drive. Hold the hard drive by the base and never touch the components on the circuit board assembly. If the temperature difference between the storage location and installation location exceeds 50 F/10 C, for temperature acclimation purposes, leave the hard drive in the new location over night (or at least two hours) before turning it on. Setting the IP address It is unlikely that the default address will be the one you want to keep for it. Configuring the IP address allows you to put the device on your network and to connect to it using an Observer analyzer or Windows Remote Desktop, both of which can be very useful since most devices are in distant or physically secure locations. At this point you have physically installed the hardware and connected all the cables. Now, you must turn on the device and configure the software. After this is complete all of your interaction with the device can now be done remotely by connecting to the device using an Observer or Windows Remote Desktop depending on what you want to accomplish. 1. Connect a monitor, keyboard, and mouse to the device and ensure the device is plugged into a power outlet. These are only needed temporarily to set the IP address. You can disconnect them when you are finished. Alternatively, you can use Windows Remote Desktop to connect to the device to make these changes. The default IP address is Turn on the system. For some devices, such as the Apex, you may need to ensure the power switch is in the ON position on the back of the device. Then on the front of the device, press the power button until the system starts to turn on. 3. Log in to the Windows operating system using the Administrator account. The default Administrator password is admin. After logging in, you may change this. See the Windows documentation, if necessary. 4. Click Start > Control Panel > Network and Internet Connections > Network Connections. Choose Local Area Connection and right-click and choose Properties. 5. Select Internet Protocol Version 4 (TCP/IPv4). How to install Apex Chapter 4: Installing and upgrading 79

80 Figure 17: Default TCP/IP settings 6. Set the IP address, subnet mask, gateway, and DNS server for your environment and click OK. Click OK again to close the Local Area Connection Properties dialog. Close the Network Connections window. Configuring the Lights Out Management port (newer revisions) Your appliance comes with an on-board Lights Out Management (LOM) port that provides you a dedicated management channel for device maintenance. It allows you to monitor and manage your appliance by remote control regardless of whether the appliance is powered on. If you want to use Lights Out Management features, you must first configure the IP address for the LOM port from the BIOS. Then, you should change the administrator password to something different than the default. 1. Ensure the LOM port is connected to your network using a straight-through Ethernet cable. A crossover cable will not work. 2. When starting your appliance, press Delete during POST to enter the BIOS setup. 80 How to install Apex Apex (23 Jan 2016) Archive/Non-authoritative version

81 3. In the BIOS, choose IPMI > BMC network configuration. 4. Set Update IPMI LAN configuration to Yes. 5. Set Configuration Address source to Static. How to install Apex Chapter 4: Installing and upgrading 81

82 6. Configure the Station IP address, Subnet mask, and Gateway IP address. These values must be valid and usable on your network! 7. Press F4 to save your changes and to exit the BIOS setup. The LOM port is now accessible from the IP address you chose. Now you can log on to the LOM web interface and change the default password. 8. To change the default password, open a web browser to and log on with the user name ADMIN and password ADMIN in caps. Note: The user name and password boxes are always case-sensitive. 9. Choose Configuration > Users, and select the second user account (ADMIN account). 10. Click Modify User, and change the password. You configured the LOM port and changed the default password. Set up Apex for the first time How to begin using Apex After Apex is properly installed, all interactions with Apex will occur through a web browser. To begin using Apex, log in to Apex. 82 Set up Apex for the first time Apex (23 Jan 2016) Archive/Non-authoritative version

83 Prerequisite(s): A compatible web browser is required. Internet Explorer 9.0 or later Mozilla Firefox Google Chrome Tip! Do you need to license and activate Apex? See the instructions at How to license Apex. 1. Open a compatible web browser, and type the following URL into the location bar: replacing "ApexHost" with the host name or IP address of the system where Apex is installed and running. You may notice a security certificate warning; this is normal for a self-signed certificate. 2. Log in to Apex using a user name and password managed by Apex or OMS (sold separately). Tip! The default user name is admin, and the default password is admin, and it is case-sensitive. You successfully logged in to Apex. All of your interactions with Apex will occur in this web interface. How to license Apex Apex is designed to be used as a server-based application. If Apex is installed along with an Observer Platform product but not licensed, you have Apex Lite. Apex Lite provides limited reporting capabilities. To license and activate Apex: 1. Install and launch the application. 2. Your default web browser will open to the following URL: localhost/oa If it does not, type the URL in the location bar of your web browser and press Enter. 3. Follow the on-screen instructions provided by your web browser to accept the self-signed security certificate. Your web browser must accept the self-signed security certificate to continue. 4. Type into the Contact/Department, Company, and License Information boxes exactly what is listed in your license document. 5. Click the License button. You successfully licensed and activated your product. If licensing and activating your product remains unsuccessful, please contact Technical Support. Licensing settings Identification The identification number shown should match the identification number in your license document. Set up Apex for the first time Chapter 4: Installing and upgrading 83

84 If the numbers do not match, examine the Licensed to and Company boxes for typing errors. Contact/ Department The contact or department as written in your license document. Company Company name must be accurately typed here for successful licensing. Company name is an item found in your license document. The license number is included in your license document. License Valid Input: License numbers are always case-sensitive. How to create a user User accounts allow people to view dashboards and create user widgets. Note: If you are using OMS, see How to add new users. The user name and password must be created there. Any user created in Apex is local to Apex. It is not connected in any way to a domain user account or local system account. If you want or require that sort of integration you must use OMS. Any local user wanting to log in to view or create dashboards must use the user name and password set here. To create a user: 1. In the web interface, click Settings > Users. 2. Click. 3. Complete the fields using the information in User settings if necessary. 4. Click Accept. The new user is created and is available to log in and begin using Apex. User settings The User settings control how and whether a user may log in and use Apex. Username The case-sensitive user name for this user. Valid Input: The length must be between 2-50 characters. Space characters cannot be used, but you may Description Descriptions are optional and displayed in the Users table. Consider a real name, or a department name if the user name is shared. addresses are optional and displayed in the Users table. Login enabled As an alternative to deletion, a user can be disabled. Only enabled users may log in. The 'admin' user cannot be disabled. Set password Password to be used with the user name. Valid Input: The length must be between 2-50 characters. Space characters cannot be used. 84 Set up Apex for the first time Apex (23 Jan 2016) Archive/Non-authoritative version

85 How to configure general settings General program settings control the Apex name, data transfer settings, and data storage location. 1. In the web interface, click Settings > General Settings. 2. Complete the fields using the information in General and data transfer settings if necessary. 3. Click Accept. General and data transfer settings Field Description Apex asset name This changeable name identifies Apex to other Viavi products. Data storage location Data transferred to Apex is stored in this directory. All dashboards are populated with the data inside. The default file path is C:\Program Files\Observer Apex \Data for software-only installations and D:\DATA if a hardware appliance. Data transfer period (minutes) The collection period in minutes. Data transfer delay (minutes) Sets the minutes to wait after completion of a data source statistics collection interval before the data is transferred to Apex. This value cannot be changed. Valid Input: Valid values are Setting a delay can improve hard disk performance on the data source because data is transferred N-minutes after being written. Missing data files limit (days) Apex automatically retrieves up to this many previous days of data from data sources if any are missing. Valid Input: Valid values are This helps Apex recover 'missing' data from data sources if Apex experiences downtime, or when collecting data from a data source for the first time. How to have Apex managed by OMS If your organization uses OMS and wants Apex to be a managed asset, you must integrate Apex into OMS. Doing so allows functionality like user authentication and authorization, plus software version control. Caution: By following these steps, Apex will be managed by OMS. After the connection is made, you will be unable to disable the management within Apex. Therefore, the only way to remove Apex from being managed is to remove the asset from within OMS. To change Apex to be managed by OMS: 1. In the web interface, click Settings > Manage By OMS. 2. Select Manage Asset with OMS Set up Apex for the first time Chapter 4: Installing and upgrading 85

86 3. In the OMS Server IP/DNS Name box, type the IP address or DNS name of the OMS server. 4. Type OMS administrator credentials into the User Name and Password boxes. The credentials must have permission to add new assets and/or licenses to OMS (depending on which is needed), or the asset must already be defined and the user must have access to the asset and a license number must be present. 5. Click Accept. If successful, Apex should now be managed by OMS. Manage by OMS settings Manage By OMS If selected, this installation is an asset managed by OMS. OMS Server IP/ DNS Name The IP address or host name of OMS. User Name A user name that has authorization to add assets to OMS. Password The password for the user in User Name. How to upgrade or downgrade Apex New and past versions of Apex software are made available to you directly from Viavi. Use the Apex upgrade tool to check for, download, or install a version of Apex. The Apex upgrade tool allows you to: Check the Viavi upgrade repository for old and new versions of Apex. Download any available version of Apex for offline installation. Install any available version of Apex without needing to leave the Apex interface. How to retrieve a list of available Apex versions A listing of Apex software versions to upgrade or downgrade to is available directly in Apex. Connect to the Viavi upgrade repository to retrieve the latest listing of available versions. Note: Interacting with the upgrade repository requires web connectivity over TCP port 80 on the Apex system. This can be achieved with direct connectivity from OMS to the web or by configuring a proxy in the proxy configuration settings of OMS for downloads. The upgrade repository is hosted by Viavi and no public mirrors are used. To retrieve a list of available Apex versions: 1. In the web interface, click Settings > Apex Updates. 2. Click Check For Upgrades. Apex connects to the upgrade repository and displays the versions available for download. Release notes for each version are available for viewing. 86 How to upgrade or downgrade Apex Apex (23 Jan 2016) Archive/Non-authoritative version

87 How to download a version of Apex New or old versions of Apex can be downloaded from the upgrade repository. Apex is not automatically installed after downloading a version using this method. Instead, this method is suitable for scheduled installation or installation from Windows Explorer. To download an available version of software for later installation, visit the repository and download any self-extracting setup executable: 1. In the web interface, click Settings > Apex Updates. 2. (Optional) Click Check For Upgrades. Doing this ensures all available versions are shown. 3. Select one by clicking a table row. 4. Click Download. If not previously downloaded, the download begins, and you can view its transfer progress. You successfully downloaded a software upgrade. How to install a version of Apex Installing a software upgrade downloads the self-extracting setup executable and immediately installs the upgrade. To install a software upgrade: 1. In the web interface, click Settings > Apex Updates. 2. Select one by clicking a table row. 3. Click Install. The download begins, and you can view its transfer progress. After the download completes, the software upgrade begins installing. You successfully installed the selected software upgrade. A notification appears if any errors occur during the upgrade. Upgrade settings There are several settings that change the behavior of version upgrades. Check for upgrades If selected, Apex periodically checks for upgrades. Scheduled transfers and installs rely on knowing if new versions exist. If cleared, users must manually check for available upgrades before any scheduled transfers or installs can occur. Show downgrade options If selected, any available downgrade versions are displayed in the available versions list. It is recommended to leave this cleared (disabled) if downgrading to previous versions is not desirable. Preferred speed (Kbps) Sets the preferred maximum transfer speed in kilobits per second. Use the value '0' to disable this bandwidth restriction. How to upgrade or downgrade Apex Chapter 4: Installing and upgrading 87

88 Use proxy server If selected, a proxy server is used for downloading upgrade versions. Proxy type Sets which type of proxy server to connect to. Proxy address The IP address or DNS name of the proxy server. Proxy port The port number accepting connections to the proxy server. Proxy user Sets the user name expected by the proxy server for authentication. Leave this box empty if authentication is not required. Proxy password Sets the password used to authenticate with the proxy server. Leave this box empty if authentication is not required. Download upgrades Schedules the download of available upgrade versions. Install upgrades Schedules the installation of downloaded version upgrades. Downloaded versions will not automatically install unless an installation schedule or upgrade policy allows it. This setting affects version upgrades that are downloaded both automatically or manually. 88 How to upgrade or downgrade Apex Apex (23 Jan 2016) Archive/Non-authoritative version

89 5 Chapter 5: Troubleshooting Understanding logging in Apex Logging captures events that occur in the application and between assets. These events may range from informational to critical. Logging creates an audit trail, or transaction log, allowing you as an administrator to see who did what and when they did it. You may need this information for compliance or other reasons. Another reason logging can be useful is if you have a problem with the application, the log events will help identify where the issue is occurring. How to view event logs Event logs are useful for troubleshooting, compliance, and more. View the event logs at any time. To view event logs: 1. In the web interface, click Log. 2. (Optional) Type in the Filter box to show log events containing your text. For example, type Info to show informational events only. The events logs are now showing. How to send Syslog messages Syslog is widely used for message logging and separates the application generating the messages from the program that reports and analyzes them. Apex can send messages to your Syslog server.

90 To send log events and alarm notifications, first configure your server and recipient settings. After configuring these settings, you can enable and disable the sending of automated messages. Configure your server settings: 1. In the web interface, click Settings > Notification Settings. 2. Select Configure a Syslog server. 3. Configure the options. For details, use the information in Syslog settings. 4. Click Accept. Enable the sending of log events and alarm notifications: 5. In the web interface, click Settings > Log Settings. 6. Select Export logged events to a Syslog server. 7. Configure the options. 8. Click Accept. Apex will send logged events to your Syslog server. Syslog settings Export logged events to a Syslog server If selected, system logs are forwarded to a Syslog server. Target IP address The host address of the Syslog server. System logs remain accessible through the dashboard and CLI interfaces. Include up to 10 Syslog servers by separating each with a comma ','. Target port The port number of the Syslog server. If more than one Syslog server is specified, this port is used for each. Format Sets which Syslog protocol is used. Severity The minimum severity level of log events sent to the Syslog server. Informational: Contains normal operational messages. No action is required. Warning: Contains cautionary messages. No error has occurred but an error may occur if no corrective action is taken. Critical: Contains fault-finding messages. Corrective action should be taken promptly. Log events of lower severity are not sent. How to send SNMP traps Events recorded in the Apex log can be sent as SNMP traps. Doing so allows you to monitor Apex activity and trigger automated processes to start when certain events occur. SNMP traps are widely used for sending notifications from one application to another, generally for alerting or notification purposes. 90 Understanding logging in Apex Apex (23 Jan 2016) Archive/Non-authoritative version

91 To send log events and alarm notifications, first configure your server and recipient settings. After configuring these settings, you can enable and disable the sending of automated messages. Configure your server settings: 1. In the web interface, click Settings > Notification Settings. 2. Select Configure an SNMP Trap. 3. Configure the options. For details, use the information in SNMP trap settings. 4. Click Accept. 5. In the web interface, click Settings > Log Settings. 6. Select Export logged events to an SNMP Trap. 7. Configure the options. 8. Click Accept. Apex will send logged events to your SNMP Trap server. SNMP trap settings Export logged events to an SNMP Trap If selected, system logs are forwarded as SNMP traps to a trap recipient. Target IP address The host name or IPv4 or IPv6 address of the SNMP trap recipient. Include up to 10 SNMP trap recipients by separating each with a comma ','. Target port The port number of the SNMP trap recipient. Example: 162 If more than one SNMP trap recipient is specified, this port is used for each. Community String Community string for your SNMP trap server. SNMP version Sets the SNMP trap version. Severity The minimum severity level of log events sent as SNMP traps. Informational: Contains normal operational messages. No action is required. Warning: Contains cautionary messages. No error has occurred but an error may occur if no corrective action is taken. Critical: Contains fault-finding messages. Corrective action should be taken promptly. Log events of lower severity are not sent. How to send alerts To send log events and alarm notifications, first configure your server and recipient settings. After configuring these settings, you can enable and disable the sending of automated messages. Configure your server settings: Understanding logging in Apex Chapter 5: Troubleshooting 91

92 1. In the web interface, click Settings > Notification Settings. 2. Select Configure an server. 3. Configure the options. For details, use the information in settings. 4. Click Accept. Enable the sending of log events and alarm notifications: 5. In the web interface, click Settings > Log Settings. 6. Select Export logged events via Configure the options. 8. Click Accept. Apex will send logged events to your SMTP server. settings Export logged events via If selected, system logs are forwarded as messages. SMTP Server The host address of the outgoing server. Example: or- smtp.example.com Valid Input: Valid addresses include IPv4 or DNS name. SMTP Port The port number of the outgoing server. Security The connection to the outgoing server can be encrypted to prevent eavesdropping. PlainText Connection is not encrypted. SSL, TLS, or DTLS Connection is encrypted. STARTTLS Negotiates an encrypted connection. If negotiation fails, the connection is not encrypted. Authentication The authentication type for connecting to the outgoing server. Try choosing 'Auto Detect' if you experience authentication problems. User Name The user name used to connect to the outgoing server. Password If 'User Name' requires a password to connect, type the password here. Leave this box blank if 'User Name' does not require a password. Sender Name If specified, this sender name appears in the 'From' field of the sent . Setting Sender Name to 'OMS Security' or similar could help recipients categorize the s. Sender The sender address appears in the 'From' field of the sent . Recipients Log events are sent to the specified address or addresses. Example: chris@example.com -orchris@example.com;pat@example.com 92 Understanding logging in Apex Apex (23 Jan 2016) Archive/Non-authoritative version

93 multiple recipients by separating each address with a semi-colon ';' or comma ','. Severity The minimum severity level of log events sent as messages. Informational: Contains normal operational messages. No action is required. Warning: Contains cautionary messages. No error has occurred but an error may occur if no corrective action is taken. Critical: Contains fault-finding messages. Corrective action should be taken promptly. Log events of lower severity are not sent. How to return to the default log settings You can return the event log to its default settings if necessary. The default behavior is to not forward any log events to , SNMP, or Syslog, so these will be disabled in the process. To return to the default log settings: 1. In the web interface, click Log. 2. Click Reset. 3. Click Accept. The log settings have been returned to their default settings. Understanding alarms An Observer Apex alarm monitors the thresholds of widgets in a dashboard. If any widget crosses a set threshold, the alarm is triggered. A triggered alarm sends notification messages to the server and recipients you specify. If any widget within a chosen dashboard crosses a threshold, the alarm is triggered. Not every widget in a dashboard needs to be in an alarmed state for the alarm to trigger. One widget crossing a threshold is sufficient for the alarm to trigger. This means you might receive multiple alarm notifications depending on how many widgets are crossing thresholds in the dashboard. Also, because there are marginal and critical thresholds, you can choose if the alarm should trigger from crossing the marginal threshold or the critical threshold. This is configurable in the alarm. A triggered alarm sends an alarm notification to specified servers and recipients. The servers and recipients receive alarm notifications as soon as a specified threshold is measured to be crossed, such as a marginal threshold. A short delay may occur between when the network events occur and the alarms are sent. This is due to the nature of a data collection transfer interval. Mission critical alarms, where timing is most important, should be made directly in Observer Analyzer. An alarm can be filtered. Filtering can help narrow or broaden what actually triggers the alarm. For example, typing app http in the filter box of the alarm settings means HTTP metrics are all that may trigger an alarm because it is the only application of interest. This filtering is additional to any filtering done on Understanding alarms Chapter 5: Troubleshooting 93

94 the business group, dashboard, or widgets. Therefore, if a dashboard or all of its widgets are always filtered to show MySQL traffic, giving this dashboard an alarm for HTTP is not meaningful. Using narrowly-filtered alarms on broad, unfiltered dashboards and widgets may be a good method to follow unless you are comfortable managing filters at each level. Your web browser can be closed and alarms will still operate. Alarms have no dependence on you actually being present in a web browser session for the alarm to trigger. Because alarm triggering and alarm actions, like sending an SNMP trap or , are performed entirely server-side, you only need to create or edit the alarm from your web browser and that is all. Apex will do the rest. How to create an alarm Prerequisite(s): To successfully create an alarm, these items are needed: A dashboard with threshold-supporting widgets added to it. At least one type of notification setting has been configured. To create an Apex alarm: 1. In the web interface, click Settings > Alarms. 2. Click New. 3. In the Edit Alarm Settings pane, do the following: a. Under the Alarm Settings area, configure the business group and dashboard that the alarm will associate with, plus any other options. Every option shown here requires configuration except Alarm Schedule, as it already defaults to Never. To enable this alarm, you must set a schedule. b. Under the Actions area, select and configure where the alarm notifications should be sent. At least one selection must be made. These selections use your notification settings. 4. Click Accept. You successfully created an alarm for the selected dashboard and business group. If a widget in the dashboard crosses the threshold you specified, the alarm will trigger. A triggered alarm sends notifications to the servers and recipients you specified. How to disable an alarm You can disable an alarm that is producing too many alarm notifications. Or, the problem has been identified and your team is now troubleshooting additional notifications are unnecessary. Instead of deleting an alarm to avoid receiving more notifications, you can choose to disable it. This method allows you to reenable the alarm at a later time. To disable an alarm: 1. In the web interface, click Settings > Alarms. 2. Select one by clicking a table row. 94 Understanding alarms Apex (23 Jan 2016) Archive/Non-authoritative version

95 3. In the Edit Alarm Settings pane, set the Alarm Schedule to Never. 4. Click Accept. The alarm is disabled. It is no longer active because the schedule was removed. Alarm settings Several settings affect the behavior of Apex alarms. Alarm Name The name of this alarm. Business Group Sets which business group is used against the chosen dashboard. Dashboard Sets which dashboard this alarm is monitoring. Filter This alarm can be filtered for specific applications, addresses, and more. Alarm Schedule Set when the alarm is active and can be triggered. This alarm can only trigger during dates and times that you include. Send Syslog If selected, alarm notifications are forwarded as Syslog messages. Configure the Syslog server settings at Settings > Notification Settings. Syslog Severity The minimum severity level of log events sent to the Syslog server. Log events of lower severity are not sent. Send SNMP Trap If selected, alarm notifications are forwarded as SNMP traps. Configure the SNMP trap settings at Settings > Notification Settings. SNMP Trap Severity The minimum severity level of log events sent as SNMP traps. Send If selected, alarm notifications are forwarded as messages. Log events of lower severity are not sent. Configure the server settings at Settings > Notification Settings. addresses Alarm notifications are sent to the specified address or addresses. Example: multiple recipients by separating each address with a semi-colon ';' or comma ','. Send Severity The minimum severity level of log events sent as messages. Log events of lower severity are not sent. Understanding alarms Chapter 5: Troubleshooting 95

96 Troubleshooting network, server, and application issues Using a simple, flexible, and easy-to-understand workflow will help you troubleshoot many common network, server, and application issues. This will guide your process and help identify areas of interest while providing a working context for your investigation. The Observer Platform provides powerful and comprehensive tools and analytics that allow you to troubleshoot many IT and network issues. The Observer Platform provides two primary applications. The first is Apex, which is the dashboard report functionality that provides powerful Layer 2-7 analytics that can be used to quickly resolve many issues. Apex dashboards use statistical data (metadata) that Observer collects separate from packet captures using network trending. The metadata files can easily store weeks or months of trending statistics. The second application is Observer, which provides detailed packet-based analytics and tools for decoding and working with packets. Observer analyzes packet data and assesses more than 700 conditions and has powerful tools to help you determine the root cause of an issue. A logical and methodical workflow is needed to analyze and resolve issues. You need to know how to use your tools and understand what the analytics are telling you; it takes practice. It s important that you gather as much information as possible before trying to resolve a problem. Here are some suggestions on information to consider: Is it one user or many? One server or several? Is it a particular application? When does the issue happen? All the time or at a certain time? Does it impact local or remote users or both? Were there any recent changes? (Are you sure? How do you know?) We suggest that you always start your investigation from the Apex dashboard. Apex is easy to use and understand and can help you resolve many issues within minutes with only a couple mouse clicks. We encourage you to spend time practicing and learning how to use Observer and Apex. Documentation and free web based training are available. 1. From the interface first select the desired probe/location. 2. Select the desired time frame. It s best to use the smallest time frame that is relevant for the issue, usually a couple hours is ideal. This way the information will be more detailed and accurate. Tip! Apex lets you easily focus a dashboard on your area of interest by providing a dashboard filter or widget filter or using your mouse to select a key field. Apply the dashboard to the selected object (like application or IP address). Also, if you click a key field, you can pass that parameter to another dashboard for even more analysis. 96 Troubleshooting network, server, and application issues Apex (23 Jan 2016) Archive/Non-authoritative version

97 Learn to use the dynamic filtering ability and key field dashboard links so the dashboards show the metrics that are relevant for your investigation. It s an easy way to quickly get to the information you need. Many network engineers use a common best practice approach to troubleshooting. This approach typically starts with determining if an issue is related to a network, a server, or an application problem. After that determination is made, it then leads to more targeted investigation, analysis, and, ultimately, a resolution. This approach also is helpful from an organizational perspective so that appropriate resources and tools are engaged. We will illustrate this troubleshooting process by working through a common problem: Users are complaining that a server is slow. Is it the network? The Network Performance dashboard helps you determine if network roundtrip and latency are impacting server response time to users. It focuses on networkcentric information like network latency and delay, network roundtrip, device byte counts, retransmissions, and utilization. Select the Network Performance dashboard. To get the dashboard, see Importing a user-contributed dashboard. Let s look at some widgets on this dashboard from a slow server perspective. Total server response time is made up of two components: 1) network latency, the time it takes for the packets to traverse the network; and 2) server delay, the time it takes for the server to process that application request. These are calculated by analyzing the time it takes for the TCP three-way handshake to complete at the beginning of a user connection. The total server response time metric is an accurate indication of how efficiently your network is delivering packets as well as the latency of the network. Let s first look at a healthy network by using our dashboard widget for SQL servers. The network delay roundtrip metric is always a good starting point. The Server Network Delay- Round Trip widget shows server network delay metrics sorted by the longest round trip time. If that number is low, then your packets are moving efficiently through the network and the latency is low. Notice our round trip, maximum, and average delays are all low. This network is running well. We don t see network delay, latency-centric problems, or many retransmissions here. Figure 18: Healthy network Troubleshooting network, server, and application issues Chapter 5: Troubleshooting 97

98 Now let s take a look at an unhealthy network using the same widget, but focused on HTTP servers. Our first HTTP server, , has an average Network Delay Round Trip time of 1719 ms, almost 2 seconds. The table shows network delay by direction: from client to server, from server to client, as well average and maximum values. Knowing the direction of the delay is helpful. It s also important to compare the average and maximum value. If the average value is high it suggests this problem is happening all the time. If the average is low but the maximum is high, it suggests that this may have been a temporary condition or just an anomaly, perhaps caused by a spike in network utilization. Also note that retransmissions are 0, so we know packets are not being lost. The servers in this table are showing high average and maximum network delays which suggests that the network is not running efficiently, this is indicative of a network issue. Figure 19: Unhealthy network To further troubleshoot round trip/latency issues, it s helpful to know additional information, such as what does the network topology look like, where is the server located, are users accessing the server over a WAN, what is the utilization of the various network segments being traversed. It s also important to know where the probe is located in the network for context of the network delay metrics. The network delay round trip value is usually the best metric to quickly assess network latency problems. Determining where the latency is actually occurring and why in a complex network is a bit more difficult. If you have deployed probes strategically, you can use the MultiHop Analysis tool in Observer to show you where the latency is occurring in your network. Below is an example MultiHop Analysis summary for four segments showing where the latency is occurring (a probe is deployed at each segment). 98 Troubleshooting network, server, and application issues Apex (23 Jan 2016) Archive/Non-authoritative version

99 Figure 20: MultiHop Summary Is it the server? In Is it the network? we used the Network Performance dashboard to take a close look at response time issues from a network perspective. Now we will focus on response time issues from a server perspective. The Server Performance dashboard helps you determine if a server is impacting server slow and is having slow response times that are affecting users. Select the Server Performance dashboard. To get the dashboard, see Importing a user-contributed dashboard. Slow server problems are typically caused by: Many users accessing an application server at the same time. The server not having enough resources (CPU, memory, etc). The server is encountering error conditions. Dependent front end or middleware, database, server or other systems are causing delays. This dashboard provides detailed server performance metrics as well as some metrics we previously examined for the network. Since network performance impacts server response times, it s convenient to have analytics from both in one dashboard. For Figure 21, we have filtered the dashboard to a single HTTP server. Troubleshooting network, server, and application issues Chapter 5: Troubleshooting 99

100 Figure 21: Server Performance dashboard Looking at the Servers by response time max widget, we see the maximum response time is greater than four seconds. But just as important, notice that the average response time is only 159 milliseconds and the round trip delay is very low (40 milliseconds). This means that the majority of the time the server response time is low and our network is running efficiently, but we do have some performance spikes. Let s look at another widget in Figure 21: Server/client by response time max. These are the clients connecting to our HTTP server sorted by maximum response time. You can see that only one client has a high maximum response time value (4137 milliseconds), the rest are low. Also notice that the server had 536 retransmissions to that client. This suggests that the problem is limited to this server/client pair. Tip! Using additional tools like Connection Dynamics or Ad Hoc Application Transaction Analysis in Observer to look at the packet data between this client and server can provide detailed insight into a problem such as this. Let s look at another example: Figure 22. High average response time and low network delay is indicative of a slow server problem. The two servers not only have a high maximum response time, but their average response time is greater than one second. We know that the network round trip delay is relatively low so the problem is not the network. Figure 22: Server Response Time - Max A correlation chart can show if there is a relationship between the number of connections, traffic volumes, network delay, or retransmissions and the application server response time. 100 Troubleshooting network, server, and application issues Apex (23 Jan 2016) Archive/Non-authoritative version

101 Figure 23: Correlation chart: performance analysis by time You can also use the Server Analysis tool in Observer to get server details. In Figure 24, you can see values comparing the number of users and simultaneous requests. Notice that the response time is relatively linear and flat, indicating the server is handling the load well. If you saw a large or exponential increase in response time as simultaneous requests increased, that would suggest too many users or inadequate server resources. We know that the average response time is relatively flat, so the problem is not the network. Figure 24: Average response time Is it the application? We have looked at Is it the network? to assess network round trip and latency issues and Is it the server? to assess server response time issues. We determined that neither the network nor server were the culprit. The Application Performance dashboard helps you determine if application transaction response times and application error conditions and the impact they can have on application server response times are the source of the problem affecting users. Select the Application Performance dashboard. To get the dashboard, see Importing a user-contributed dashboard. This dashboard provides detailed application transaction information such as transaction types and errors, as well as detailed response times. This information helps you determine how the application is performing by transaction and whether it is the application that is impacting users. To see application level information in Apex, you must have application transaction analysis enabled for the desired servers on the Observer GigaStor or probe. Observer and Apex support application transaction analysis for many different enterprise applications such as DNS, SQL, HTTP, Citrix, LDAP, CIFS/SMB, SIP, and more. Troubleshooting network, server, and application issues Chapter 5: Troubleshooting 101

102 Below are two tables from the Application Performance dashboard that show transaction responses and requests for an HTTP server of interest. You can see the request and response codes and description, plus the corresponding average and maximum response time for each transaction type. In Figure 25, if you look at the Request table (lower table), the most common request transaction is a GET, which is typical for HTTP. If you look at the GET request line the average response time is low, 120 ms, but the maximum is almost 10 seconds (9996 milliseconds). Clearly some user transactions are experiencing long response time delays. Figure 25: Application Analysis Server-Response Let s now look at the top table for transaction responses in Figure 25. We have sorted the response codes to show various HTTP transaction errors that show up in the 400 response code range. You will notice several transaction problems. We had Bad Requests that took almost 10 seconds max to process. But what is really problematic is that we had 2, Not Found response errors. The average response time was 166 milliseconds and the maximum response time was greater than 8 seconds (8320 milliseconds). These issues are causing user errors as well as slow response time. By looking at the Application Performance dashboard, we can determine if we have application errors causing user problems as well as the response time metrics associated with various transaction types. In this example, we identified a major application error problem from our Application Performance dashboard. We were getting many 404 File Not Found errors. We can use the ability to launch a drilldown connection from a dashboard to the packet data in the probe (this passes a context-based filter to the GigaStor), or we can just go to our probe and analyze the packet data for a particular server to find the root cause of any application error. Figure 26 shows the probe statistics for several monitored web servers. You can right-click the application error 404=Not Found and then choose Go to Request Packet or Go to Response Packet to decode the data. 102 Troubleshooting network, server, and application issues Apex (23 Jan 2016) Archive/Non-authoritative version

103 Figure 26: Application Statistics Figure 27 shows the packet decode and the HTTP request was for the file system_requirements_and_installation.html on networkinstruments.com. We now know what file was missing on our web server that caused 404=Not Found errors. Figure 27: 404 HTTP Request Summary Using some common sense troubleshooting techniques, and asking ourselves some basic questions, we were able to use Apex, Observer, and GigaStor to look at the network, server, and application to isolate the problem. Now that we know where the problem is, we can assign it to the appropriate team to resolve. In addition to the ones mentioned here, Apex has several dashboards that you can use and configure. The VoIP/UC Analysis dashboard provides summaries for VoIP/UC Analysis performance. The Web/HTTP Analysis dashboard provides Troubleshooting network, server, and application issues Chapter 5: Troubleshooting 103

104 details from an HTTP perspective. The Device Health Analysis dashboard gives you a comprehensive network, server, and application information for a device, all in one dashboard. It also shows detailed application transaction analysis between a client/server pair for in-depth analysis. The dashboard library is dynamic and growing. See Importing a user-contributed dashboard. All dashboards are made up of widgets. The dashboards and widgets are very flexible and can easily be customized by you. We encourage you to design and customize your own widgets and dashboards after you have become comfortable with the use and design of them. 104 Troubleshooting network, server, and application issues Apex (23 Jan 2016) Archive/Non-authoritative version

105 6 Chapter 6: Backups and Secondary Configuring a failover or redundant Apex If you need a high degree of availability for Apex, then enable the Apex redundancy feature. Redundancy, also known as failover, helps maintain a high up time for your Apex system. If your primary Apex system becomes unavailable for any reason, then the secondary Apex system automatically becomes active and available for dashboards. By having a failover Apex system, you can help ensure that maximum availability is maintained.