user guide - viavi solutions
TRANSCRIPT
ApexUser Guide
Notice
Every effort was made to ensure that the information in this manual was accurate at the time of printing. However, informationis subject to change without notice, and Viavi reserves the right to provide an addendum to this manual with information notavailable 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”). Allother trademarks and registered trademarks are the property of their respective owners. No part of this guide may be reproducedor 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 softwareare subject to Viavi standard terms and conditions, available at www.viavisolutions.com/terms.
Specifications, terms, and conditions are subject to change without notice. All trademarks and registered trademarks are theproperty 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 acommercial environment. This product generates, uses, and can radiate radio frequency energy and, if not installed and used inaccordance with the instruction manual, may cause harmful interference to radio communications. Operation of this product in aresidential area is likely to cause harmful interference, in which case you will be required to correct the interference at your ownexpense.
The authority to operate this product is conditioned by the requirements that no modifications be made to the equipment unlessthe 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 becollected separately and disposed of according to your national regulations. In the European Union, all equipment and batteriespurchased from Viavi after 2005-08-13 can be returned for disposal at the end of its useful life. Viavi will ensure that all wasteequipment and batteries returned are reused, recycled, or disposed of in an environmentally friendly manner, and in compliancewith 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 theequipment or battery was imported by a reseller whose name or logo is marked on the equipment or battery, then the ownershould 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 siteat http://www.viavisolutions.com. If you have questions concerning disposal of your equipment or batteries, contact Viavi WEEEProgram Management team at [email protected].
Technical Support
North America 1.844.GO VIAVI / 1.844.468.4284Latin America +52 55 5543 6644EMEA +49 7121 862273APAC +1 512 201 6534All Other Regions viavisolutions.com/contactsemail [email protected]
Support hours are 7:00 A.M to 7:00 P.M. (local time for each office).
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............................................................................................ 10
Licensing...................................................................................................................................................... 10
How to license Apex.............................................................................................................................. 10
How to modify baseline calculations.......................................................................................................11
General and data transfer settings.......................................................................................................... 11
Chapter 3: Gather data from your products................................................................................... 12
Understanding data sources.....................................................................................................................12
How to add a data source....................................................................................................................12
How to assign a data source............................................................................................................... 13
How to edit a data source.................................................................................................................... 13
How to delete a data source................................................................................................................ 14
How to force the transfer of network trending data........................................................................ 14
How to transfer older network trending data................................................................................... 14
Data source settings............................................................................................................................. 15
Understanding business groups............................................................................................................... 15
How to create a business group.......................................................................................................... 16
How to nest a business group..............................................................................................................16
How to filter a business group.............................................................................................................17
How to hide a business group............................................................................................................. 17
How to halt a business group from retrieving data..........................................................................17
4 Table of Contents (23 Jan 2016) — Archive/Non-authoritative version
Business group settings........................................................................................................................ 18
Understanding dashboards...................................................................................................................... 18
How to create a dashboard................................................................................................................. 20
How to promote a dashboard............................................................................................................. 20
How to let dashboards automatically refresh................................................................................... 21
How to export a dashboard................................................................................................................. 22
How to import a dashboard................................................................................................................ 22
How to filter a dashboard.................................................................................................................... 22
How to save a dashboard as PDF....................................................................................................... 23
How to delete a dashboard..................................................................................................................24
Understanding dashboard times........................................................................................................ 24
Additional Apex dashboards............................................................................................................... 26
Understanding thresholds.........................................................................................................................30
How to configure thresholds................................................................................................................30
Understanding threshold color bars in tables................................................................................... 31
Understanding widgets............................................................................................................................. 32
How to create a widget........................................................................................................................ 34
How to add a widget to a dashboard.................................................................................................34
How to filter a widget........................................................................................................................... 34
How to edit a widget.............................................................................................................................35
How to export a widget........................................................................................................................ 35
How to import a widget....................................................................................................................... 36
How to delete a widget.........................................................................................................................36
Understanding key fields......................................................................................................................36
Widget settings...................................................................................................................................... 37
Widget types and categories.................................................................................................................... 38
Understanding status widgets.............................................................................................................38
Widget fields by data stream type and widget type......................................................................... 40
Understanding an application dependency map (ADM)...................................................................... 58
Visualizing the components of multi-tier applications.................................................................... 58
How to create an application dependency widget........................................................................... 59
How to operate an application dependency widget.........................................................................60
Understanding scheduled reports............................................................................................................ 61
How to create a scheduled report....................................................................................................... 62
How to edit scheduled reports.............................................................................................................63
Scheduled report options..................................................................................................................... 63
Understanding GigaStor Report drill down............................................................................................ 63
Overall steps needed for drill down.................................................................................................... 64
How to prepare Observer for drill down............................................................................................ 65
How to prepare Apex for drill down................................................................................................... 66
How to drill down using Apex..............................................................................................................70
Chapter 4: Installing and upgrading................................................................................................73
How to install Apex.................................................................................................................................... 73
Supported Operating Systems............................................................................................................. 74
Ports used by Observer Platform v17 and later.................................................................................74
Table of Contents (23 Jan 2016) — Archive/Non-authoritative version 5
System specifications............................................................................................................................ 74
Understanding your deployment strategy.........................................................................................75
Installing the Apex appliance.............................................................................................................. 75
Setting the IP address........................................................................................................................... 79
Configuring the Lights Out Management port (newer revisions)................................................... 80
Set up Apex for the first time.................................................................................................................... 82
How to begin using Apex..................................................................................................................... 82
How to license Apex.............................................................................................................................. 83
How to create a user............................................................................................................................. 84
How to configure general settings......................................................................................................85
How to have Apex managed by OMS................................................................................................. 85
How to upgrade or downgrade Apex...................................................................................................... 86
How to retrieve a list of available Apex versions.............................................................................. 86
How to download a version of Apex...................................................................................................87
How to install a version of Apex..........................................................................................................87
Upgrade settings................................................................................................................................... 87
Chapter 5: Troubleshooting..............................................................................................................89
Understanding logging in Apex................................................................................................................89
How to view event logs........................................................................................................................ 89
How to send Syslog messages............................................................................................................. 89
How to send SNMP traps......................................................................................................................90
How to send e-mail alerts.................................................................................................................... 91
How to return to the default log settings...........................................................................................93
Understanding alarms............................................................................................................................... 93
How to create an alarm........................................................................................................................94
How to disable an alarm...................................................................................................................... 94
Alarm settings........................................................................................................................................ 95
Troubleshooting network, server, and application issues.................................................................... 96
Is it the network?................................................................................................................................... 97
Is it the server?....................................................................................................................................... 99
Is it the application?........................................................................................................................... 101
Summary.............................................................................................................................................. 103
Chapter 6: Backups and Secondary............................................................................................... 105
Configuring a failover or redundant Apex............................................................................................105
Defining a failover Apex.....................................................................................................................106
Becoming a primary/secondary Apex.............................................................................................. 107
Understanding configuration backups................................................................................................. 107
How to create a backup..................................................................................................................... 107
How to restore configuration settings..............................................................................................108
How to schedule backups.................................................................................................................. 108
How to change where backups are stored...................................................................................... 108
Index..................................................................................................................................................110
1
Chapter 1: Understanding Apex
Learn about ApexApex helps your organization create reports, called dashboards, from thedata collected by Observer Platform products. These reports can assist yourorganization with troubleshooting, planning, performance, compliance, and more.
Apex vs. Apex LiteApex is a full-featured reporting engine for combining information from manyassets while Apex Lite has limited functionality and can only be used for reportsof the local asset.
Table 1: Apex vs. Apex LiteFeature Apex Apex LiteSystem and userdashboards
X X
Import dashboards X XFiltering X XEvent logging /notifications
X X
Tags X XTables X XGraphs X XCharts X XThreshold graphs X
GigaStor workflowintegration
X
Site dashboards X
Understanding the certificate trust modelChapter 1: Understanding Apex 7
Feature Apex Apex LiteMultiple datasources
X
Business groups X
Status widgets X
Applicationdependency maps(ADM)
X
Failover /Redundancy
X
Multiple userconfiguration
X
Thresholds X
Alarms X
Scheduled reports X
Works with Observer Analyzer (Expert andSuite)Observer GigaStor
Observer (Expert and Suite)GigaStor
Figure 1: Observer Platform
Understanding the certificate trust modelThe certificate trust model allows Observer Platform products to securelycommunicate using TLS encryption. It is also provides resistance to man-in-the-middle attacks by requiring administrator intervention when a known certificatehas changed.
All product-to-product communication is encrypted by default. A web oftrust between Observer Platform products is created by requiring certificatesfrom each participating software application. The main benefit is that this
Understanding the certificate trust model8 Apex (23 Jan 2016) — Archive/Non-authoritative version
ensures encryption of communication between all parts of the ObserverPlatform.
Each software application owns a unique certificate. This certificate isautomatically created during the first installation of an Observer Platformapplication. For example, Apex. The unique application certificate is labeledLocal when viewed from inside that software application. Upgrading to newersoftware versions does not create a new certificate, so no certificate maintenanceis typically needed. However, uninstalling and reinstalling (fresh installs) createsa new certificate. The new certificate will be automatically rejected by otherproducts that had a pre-existing association with the asset ID of the reinstalledsoftware.
The first time two products communicate, each checks to see if they havethe certificate for the asset ID of the other software application. If theydo not, then certificates are exchanged, marked Trusted, and associated withthe asset ID of the participating device. This enables the “easy configuration”model. After an association is made, each application will expect to see the samecertificate (to remain trusted) when communicating.
Note: Prior to version 17 of the Observer Platform, encryption was availablebut not enabled by default. This has changed to become the default out-of-the-box behavior in Observer Platform version 17 and later, and it also usesa 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 fromthat asset (determined by the asset ID) occurs using a different certificate, theadministrator must inspect and manually accept the certificate because thecertificate is in a Rejected state. A rejected certificate breaks the trust model,so any offending device(s) and software are banned from product-to-productcommunication until an administrator investigates and accepts the certificate.
Certificates can be manually rejected by administrators. In the event thatproduct-to-product communication must be immediately severed because ofan imminent threat or other security risk, an administrator can manually rejectcertificates.
How to view certificatesYou can view every certificate that Apex has collected. This information showscertificate trust state, certificate ID, fingerprints, last time seen, last networklocation, 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 hascollected.
How to change the trust of a certificateThe trust of a certificate can be changed between trusted and rejected states.The certificate must remain trusted for communication to occur.
Understanding the certificate trust modelChapter 1: Understanding Apex 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 usedCertificates ensure secure communication between Observer Platform products.The certificates encrypt this communication and help you the maintain theauthenticity of device communication.
Certificates use public key infrastructure (PKI) to encrypt all product-to-productcommunication 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 notencrypted.
2
Chapter 2: Activating and configuring
LicensingLicensing your product enables functionality and entitles you to support duringyour maintenance period.
How to license ApexApex is designed to be used as a server-based application.
If Apex is installed along with an Observer Platform product but not licensed, youhave 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: https://
localhost/OA
If it does not, type the URL in the location bar of your web browser and pressEnter.
3. Follow the on-screen instructions provided by your web browser to acceptthe 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 contactTechnical Support.
How to modify baseline calculationsChapter 2: Activating and configuring 11
How to modify baseline calculationsBaselines help uncover how much a statistic has changed over time. You canchange 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 tocalculate a baseline.
General and data transfer settingsField DescriptionApex asset name This changeable name identifies Apex to other Viavi products.
Data storagelocation
Data transferred to Apex is stored in this directory. Alldashboards 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 hardwareappliance.
Data transferperiod (minutes)
The collection period in minutes.
This value cannot be changed.
Data transferdelay (minutes)
Sets the minutes to wait after completion of a data sourcestatistics collection interval before the data is transferred toApex.
Valid Input: Valid values are 0-10.
Setting a delay can improve hard disk performance on thedata source because data is transferred N-minutes after beingwritten.
Missing data fileslimit (days)
Apex automatically retrieves up to this many previous days ofdata from data sources if any are missing.
Valid Input: Valid values are 0-365.
This helps Apex recover 'missing' data from data sources if Apexexperiences downtime, or when collecting data from a datasource for the first time.
3
Chapter 3: Gather datafrom your products
Understanding data sourcesA data source is any Observer Platform product that feeds data into ObserverApex. Data sources are configured in Apex, by you, and assigned to one or morebusiness groups.
Data sources must be configured. Apex must be connected to data sources forthe application's core features to operate. Adding a new data source tells Apexabout a new Observer Platform product from which you want to get data. Forexample, one Observer Analyzer analyzer can be an aggregation point that getsdata from several probes like a GigaStor or Observer Suite.
Data sources must be added to business groups. It is not enough to justconfigure a data source and have Apex automatically connect to it. To transferthe data collected by data sources to Apex, your chosen data sources must beadded to a business group.
Apex Lite cannot create data sources. Only a fully licensed Apex has thatcapability. For other differences, see Apex vs. Apex Lite.
How to add a data sourceAdding a new data source tells Apex about the Observer Platform product youwant to get data from. At least one data source is needed for Apex to fullyoperate.
To add a data source:
1. In the web interface, click Settings > Data Sources.2. Click New.
Understanding data sourcesChapter 3: Gather data from your products 13
3. In the Edit pane, provide information about the data source and credentialsto connect to it.
4. Click Accept.
The data source is added to Apex, and Apex attempts to communicate with thedata source. The Connection State indicator shows the connection status in realtime; 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 yourconfiguration. This is because network trending data is only transferred to Apexafter a data source is assigned to a business group. For details, see How to assigndata sources.
How to assign a data sourceData sources must be added to business groups before their data can betransferred to Apex.
Prerequisite(s):
You must have a data source before you can assign it to a business group. If youneed 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 tothe business group.
5. Click Accept.
Apex contacts the data source to request and retrieve its trending data. Thevalue of Data transfer delay (minutes) at Settings > General Settingscontrols 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 datafrom your assigned data source will begin transferring two minutes after thedata source has finished its statistics collection interval.
How to edit a data sourceYou can make edits to an existing data source if its IP address, DNS name, or usercredentials have changed. This ensures continuity of its trending data even incases 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 sources14 Apex (23 Jan 2016) — Archive/Non-authoritative version
3. In the Edit pane, provide information about the data source and credentialsto connect to it.
4. Click Accept.
You successfully edited a data source. If the connection is successful, widgets anddashboards that rely on data from this data source are provided the trendingdata. The Connection State indicator shows the connection status in real time; itis not necessary to refresh the web page.
How to delete a data sourceData sources can be deleted for any reason. Deleting a data source removes itfrom 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 dataIf you are unable to wait for trending data to automatically transfer, you canforce its transfer.
Apex frequently and automatically receives network trending data from datasources. 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 dataIf you need to transfer trending data into Apex that is much older that whatApex currently has, you can do so. This allows you to view dashboards againstmuch 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
Understanding business groupsChapter 3: Gather data from your products 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 settingsObserver 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 Observeror 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 Apexand this data source.
This indicator always shows current information. You will notneed to refresh the web page.
Host The host address of the data source.
Example: 203.0.113.148 -or- mintw028.example.netValid 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 datasource.
These user names and passwords are maintained by the datasource and not Apex.
Understanding business groupsBusiness groups are collections of data sources. By assembling multiple datasources into a logical grouping, you are creating a business group for thatgrouping.
Business groups are a collection of data sources. Imagine you have 14web servers across your network that are monitored by three different probeinstances. You can create a business group that views the statistical datafrom those data sources—the three probes instances. This allows you to viewdashboards that combine the metrics from those web servers.
Data sources only transfer trending data after being placed into a businessgroup. It is not enough to add a data source to Apex and have Apex connect toit. To actually transfer data from your data sources, the data sources must beassigned to one or more business groups. This must be done for widgets anddashboards to show any data.
Business groups can contain these data sources:
♦ Probe instances from Observer Suite analyzer, GigaStor, and other probes.
Understanding business groups16 Apex (23 Jan 2016) — Archive/Non-authoritative version
Business groups can include other business groups. Business groups can benested. This allows you the option of making smaller, more manageable businessgroups and still have them act as one large business group.
How to create a business groupBusiness groups can be created to organize your data sources by department,location, multi-tiered application, or for other reasons. A business group withdata 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 datasources.
5. (Optional) If you want to combine other business groups into this businessgroup, use a drag-and-drop operation in the Included Business Groups tab.
6. (Optional) If you want to immediately add data sources, complete thefollowing: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 tothe business group.
7. Click Accept.
You successfully created a business group. You assigned, or will assign in thefuture, one or more data sources to the business group you created. All selectablebusiness groups appear in a list in the upper-left corner of My Dashboards.
How to nest a business groupA business group can be arranged so the data sources available to one businessgroup can include those from other business groups. This is accomplished bynesting 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-and-
drop operation.
You can repeat the drag-and-drop operation to nest more business groupsinto 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.
Understanding business groupsChapter 3: Gather data from your products 17
How to filter a business groupFiltering 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 ineffect when the business group is selected. It is the “highest” level of filteringavailable in Apex, so all other filters (like filters on a dashboard) take effect afterthe business group filter. We recommend designing business group filters to bebroad 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 thisbusiness group is selected in My Dashboards.
How to hide a business groupBusiness groups can be hidden to avoid accidentally selecting them. This is usefulwhen 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 isthat it cannot be selected from the list shown to users. There is typically no needto 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 beselected directly, which may be the case if you are nesting business groups.
How to halt a business group from retrieving dataTo stop a business group from retrieving data, you can disable the businessgroup. While the business group is disabled, any data that was already retrievedcan 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 dashboards18 Apex (23 Jan 2016) — Archive/Non-authoritative version
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 datais retrieved from its configured data sources. Previously transferred trendingdata remains usable by widgets and dashboards.
4. Click Accept.
You successfully disabled a business group.
Business group settingsName The name of this business group.
Description Descriptions are optional and displayed in the Business Groupstable.
Filter
Trending Enabled If cleared, this business group is disabled. While disabled, notrending data is retrieved from its configured data sources.Previously transferred trending data remains usable by widgetsand dashboards.
Any other enabled business group configured to use some or allof 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 includedin a different business group.
Understanding dashboardsA dashboard is a report populated with widgets, and these widgets show theinformation collected by your data sources.
Dashboards are reports populated with widgets. Your reports—yourdashboards—are populated with one or many widgets. The data shown bywidgets in your dashboards belongs to Observer. To make use of dashboards,Observer must be collecting network trending data and be a data source toApex. Without trending data, Apex will not have any data for the widgets in adashboard.
Understanding dashboardsChapter 3: Gather data from your products 19
Figure 2: An Apex dashboard populated with five widgets
System dashboards are available "out-of-the-box" for you and cannotbe modified. Dashboards that are pre-made by Viavi are available to you assystem dashboards. System dashboards are identical in function to dashboardsyou create on your own, but they cannot be modified. Additionally, systemdashboards provide broad information and are useful for high-level analytics. Atemporary filter can be used while viewing system dashboards, but a permanentfilter cannot be added.
Dashboards can be filtered. Any dashboard can have an always-on filterwritten into its properties. Dashboard filters force every widget in a dashboardto display only information that meets the filter. For example, you can filtera 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 VoIPconversation.
A dashboard filter can be applied to the design of the dashboard itself (always-filtered), applied during viewing of the dashboard (temporary), or applied as acombination of the two.
User dashboards are only viewable by you. Each newly created dashboard isconsidered a user dashboard. User dashboards are unique to the user that loggedin 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 thedashboard. A promoted dashboard becomes a site dashboard that is viewable byother 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 withoutpromoting the underlying user widgets—if any exist. This protects your personaluser widgets from being altered and changed by others. If you want to share a
Understanding dashboards20 Apex (23 Jan 2016) — Archive/Non-authoritative version
dashboard with others (by promotion) and also allow changes to those widgets,the widgets must be promoted to site widgets.
How to create a dashboardYou can report on metrics that matter to you and your organization. Do this bycreating 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 awidget 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 willshow data when run in the My Dashboards page.
How to promote a dashboardTo share a user dashboard with other Apex users, the creator must promote thedashboard. A promoted dashboard becomes a site dashboard that is viewable byother users. A promoted dashboard cannot be demoted.
User dashboards are only viewable by you. Each newly created dashboard isconsidered a user dashboard. User dashboards are unique to the user that loggedin to and created it, and it can only be viewed and modified by that user. Sitedashboards 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.
Understanding dashboardsChapter 3: Gather data from your products 21
Note: If you accidentally promote a dashboard that you wanted tokeep as a user dashboard, export the site dashboard, delete the sitedashboard, then import your exported dashboard file.
You successfully promoted a dashboard and it is now viewable by others.
How to let dashboards automatically refreshIf you want dashboards to show running changes—that is, to show new datasoon after it’s available—you can set your reporting period to use the auto-refresh option.
When setting the reporting period during your Apex session, dashboardsshow you metrics observed during that time frame. If you continue viewing adashboard like this, without navigating elsewhere in Apex and then returningto the same dashboard (which triggers a refresh), the dashboard sits idle andshows the same data it originally fetched. However, with the auto-refresh optionenabled, the dashboards you are viewing can update automatically.
Caution: Viewing a dashboard while auto-refresh is enabled will suspendEnable Session Timeout for as long as it is in view. In this specificscenario, 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 timeframes. 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 anddisplays new data automatically.
For more information about auto-refresh operates, see Understanding dashboardauto-refresh.
Understanding dashboards22 Apex (23 Jan 2016) — Archive/Non-authoritative version
How to export a dashboardEvery dashboard can be exported to a downloadable file. The file can be used formany purposes, such as archival, back ups, or to import back into Apex.
The exported dashboard contains the properties, layout, and widget selectionsof the dashboard you are viewing, but it does not contain the underlying reportdata. 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 useraccount importing a dashboard is a different user. Ideally, all widgets on yourdashboard are site widgets so that they can be shared.
This process is not related to saving your dashboard as a PDF. That information islocated at How to save a dashboard as PDF.
Note: The exported dashboard file may contain sensitive information. Thisis especially true of the dashboard name and description, which are includedin 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 dashboardAny dashboard that was previously exported can be imported into Apex. Thiscreates 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 de-select 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 thedashboard were also imported and appear as user widgets.
How to filter a dashboardFiltering a dashboard helps you isolate just the object of interest for you, suchas a specific application, IP or MAC address, or telephone number in a VoIPconversation.
Understanding dashboardsChapter 3: Gather data from your products 23
You can choose to permanently filter a dashboard or temporarily filter it using anad 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. Itremains 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 thedashboard at all times.
How to save a dashboard as PDFYou can save what a dashboard is currently showing you by saving it as a PDF.Apex has a feature for producing a PDF in just a few clicks.
To save a dashboard as a PDF:
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 PDF.4. Click PDF.
5. In the dialog box that appears, configure how the PDF should appear.6. Click OK.
Understanding dashboards24 Apex (23 Jan 2016) — Archive/Non-authoritative version
The PDF is being generated for your dashboard. After it generates, the PDFbecomes available for download. All time values are specified in UTC using theISO8601 time format: "2015-10-24T04:06:16Z". The Z at the end of the formatindicates that there is no time offset from UTC. UTC does not observe summertime (daylight savings time). It is also possible that UTC may be several hoursdifferent from your local time. The web UI client uses its local browser time, butall API requests use UTC.
How to delete a dashboardYou can delete a dashboard to permanently remove it from Apex.
If you have authorization to delete dashboards, you can delete site dashboardsand your own user dashboards. Deleting a user dashboard removes it from youruser, 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 removedfrom Apex. If you deleted a site dashboard, no users will be able to view thatdashboard.
Understanding dashboard timesDashboards are very time sensitive. The data that appears on a dashboardchanges or updates when the time frame changes. This can lead to differentresults.
If your dashboard time frame is too short, your network may look better (orworse) than it actually is. A dashboard may take some time to load if you loadinga longer period of time that contains a lot of data and reporting intervals. Thedata and reporting intervals used are determined by the time frame selectedat the top of the dashboard. Data on the dashboard only changes when a newtime frame is selected or when you manually reload it; it does not automaticallyupdate.
Figure 6: Dashboard time frame
Custom Allows you to create a unique time frame from minutes to years.
Last
Hour: If the current time is 11:48, then last hour is10:00-11:00.
12 Hours: If the current time is 11:48, then last twelve hoursis 23:00 to 11:00.
Day: If today is Wednesday, then last day is Tuesday.
Understanding dashboardsChapter 3: Gather data from your products 25
Week: If today is Wednesday, then last week is from twoSundays 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:48.
12 Hours: If the current time is 11:48, then last twelve hoursis 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 twoSundays 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 untilnow on Wednesday.
Month: If today is August 22, then To Date is August 1 untilAugust 22.
Trailing
Hour: If the current time is 11:48, then trailing hour is10:49-11:48.
12 Hours: If the current time is 11:48, then trailing twelvehours is 23:49 to 11:48 (now).
Day: If today is Wednesday at 11:48, then trailing day is fromTuesday (yesterday) at 0:00 to 11:48 Wednesday (now).
Week: If today is Wednesday at 11:48, then trailing week isfrom last Wednesday at 0:00 to now.
Month: If today is August 22, then trailing month is July 23to August 22.
Understanding dashboard auto-refreshWhen you select the auto-refresh option in your reporting period, dashboardsautomatically update. There are some factors to be aware of when auto-refresh isenabled.
A primary benefit of using auto-refresh is to see current metrics at-a-glance. With auto-refresh, it is feasible to have a dashboard continuouslyupdating in a browser window while keeping that window on a separate display.In this way, you can stay informed of important networks and applications at-a-glance. Another benefit of auto-refresh is to see frequent dashboard updateswhen it matters most, such as during scheduled maintenance period or cut-overof systems. During these times, it is important to see that you and your team arenot introducing problems and that services are coming back online as expected.
The refresh rate varies depending on the length of the report period. Whenthe reporting period encompasses one hour or less, the dashboard will refreshapproximately every 10 minutes. When the reporting period encompasses onehour or more, but less than 24 hours, the dashboard will refresh approximatelyeach hour. When the reporting period is 24 hours or longer, the dashboard willrefresh approximately once per day. However, if Last is chosen in the reportingperiod, dashboards refresh as often as the selection. Meaning, if Last coversthe last five hours, dashboards refresh every five hours. Any time you navigateaway from and revisit a dashboard, it resets its scheduled refresh; this is becauserevisiting a dashboard triggers a manual refresh (like always).
Understanding dashboards26 Apex (23 Jan 2016) — Archive/Non-authoritative version
Viewing a dashboard while auto-refresh is enabled ignores the sessiontimeout feature. This means that viewing a dashboard while auto-refresh isenabled will suspend Enable Session Timeout for as long as the dashboard is inview, so you can continue watching. In this specific scenario, the inactive user willnot be signed out of Apex. The normal session timeout behavior (if set) continuesto operate as normal when not viewing a dashboard.
Auto-refresh is not always available to choose. The Auto-Refresh check boxis available for Week, Day, and shorter time frames. The option does not appearif Month is chosen. Additionally, the option does not appear if the reportinginterval is set to Custom, as that choice requires an absolute time frame—sonothing would change even if the dashboard refreshes. Auto-refresh is availablein all other selections.
Under certain reporting period choices, auto-refresh will experience anadditional one-minute delay before the dashboard refreshes. To ensure thebest hard disk performance, Apex always takes advantage of the Data transferdelay (minutes) setting found in Settings > General Settings. Auto-refreshtriggers 1-minute after this data transfer delay completes if the reporting periodis set to This, To Date, or Trailing. This minimizes the chance that a dashboardwill be refreshed at the same time the network trending data is writing to disk.This is a purely performance-driven design choice; viewing dashboards whileApex 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 dashboardsUse these contributed dashboards to quickly enhance how you use Apex totroubleshoot network, application, and server issues in your environment.
Importing a user-contributed dashboardA dashboard’s file extension is .oad. When you import a dashboard, it is a userdashboard and only viewable by you. If you want others to be able to use of theinformation displayed on these dashboards you must promote each one to a sitedashboard.
1. Right-click any dashboard name from the table and save the .oad file to yoursystem.
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 dashboardsRight-click the dashboard name to save the file to your system.
Dashboardname
Description Sample/Layout
Apex Litecompatible?
Created in
NetworkPerformance
Helps youdetermineif networkroundtrip andlatency are
Yes 17.0.9.0
Understanding dashboardsChapter 3: Gather data from your products 27
Dashboardname
Description Sample/Layout
Apex Litecompatible?
Created in
impactingserverresponse timeto users. Itfocuses onnetwork-centricinformationlike networklatencyand delay,networkroundtrip,device bytecounts,retransmissions,andutilization.See Is it thenetwork?
Server Performance Helps youdetermineif a server isimpactingperformanceand is havingslow responsetimes thatare affectingusers. See Is itthe server?
Yes 17.0.9.0
ApplicationTransactionAnalysis
Helps youdetermine ifapplicationtransactionresponsetimes andapplicationerrorconditionsand theimpact theycan have onapplicationserverresponsetimes arethe source ofthe problemaffectingusers. SeeIs it theapplication?
Yes 17.0.9.0
Understanding dashboards28 Apex (23 Jan 2016) — Archive/Non-authoritative version
Dashboardname
Description Sample/Layout
Apex Litecompatible?
Created in
Device HealthAnalysis
Comprehensivenetwork,server, andapplicationinformationfor a device,all in onedashboard.It also showsdetailedapplicationperformancebetweena client/server pairfor in-depthanalysis.
Yes 17.0.9.0
VoIP/UC Analysis Summariesfor VoIP/UC Analysisperformance.
Yes 17.0.9.0
Web/HTTP Analysis Details froman HTTPperspective.
Yes 17.0.9.0
Forensic searchtable
Shows datasource, clientand serverIP and MACaddresses,IP protocol,link protocol,completedand droppedrequests,observedconnections,and packetssent (clientand server) ina table.
Yes 17.0.9.0
VoIP/UC searchtable
Shows VoIPcalls by name,number, IPtype, station,jitter (ms)maximum,averagepacket loss,codec, anddata source.
Yes 17.0.9.0
Understanding dashboardsChapter 3: Gather data from your products 29
Dashboardname
Description Sample/Layout
Apex Litecompatible?
Created in
Forensic ADM Shows totalrequestsbetweennetworkdevices in amap layout.Perfect forfocusedsearching andtroubleshooting!
No 17.0.9.0
Multi-tier systemanalysis
Intendedto trackperformanceof multi-tieredapplicationsusing anapplicationdependencymapat top foridentificationwith client/server/application-focusedtables belowto identifyapplicationand inter-tierperformanceissues basedon networkresponsetime,applicationrequesttimes, andapplicationresponsetimes.
No 17.0.9.0
Traffic sent/received by site orsubnet
Having bothbits/sec and% util onthe samedashboardyou get tosee the actualtraffic rateand you cancalculatethe totalbandwidth.
Yes 17.0.12.0
Understanding thresholds30 Apex (23 Jan 2016) — Archive/Non-authoritative version
Dashboardname
Description Sample/Layout
Apex Litecompatible?
Created in
Alarms 1 A dashboardshowingthe currentstatus of webresponsetimes with atable of thecorrespondingdata. Currentstatus andentries areshown fordatabase andSQL averages,file serverand CIFS/SMB responsetimes, andVoIP MOSaverage andVoIP quality.
No 17.0.12.0
Alarms 2 AnotherdashboardshowingHTTP, SQL,file server,data center,VoIP, andapplicationstatus.
No 17.0.12.0
Understanding thresholdsThresholds are defined values that determine if a statistic is above, below, orwithin a normal range on your network.
Thresholds are also used when displaying colors in dashboards. Anything belowthe marginal threshold is green, anything between the marginal and criticalthreshold is yellow, and anything above the critical threshold is red. Thresholdscan also be used as part of status widgets that are based on either performanceor a baseline.
How to configure thresholdsIn Apex, the default thresholds are pre-configured, so additional setup is rarelyneeded. If necessary, you can change them to better reflect your networkconditions.
To configure a threshold:
1. In the web interface, click Settings > Thresholds.2. Select one by clicking a table row.
The editing pane appears.
Understanding thresholdsChapter 3: Gather data from your products 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 eitherabove or below this value, and widgets display a yellow color ifa 'Marginal Value' is crossed.
Performance based thresholds use actual values, whilebaseline thresholds use percentage values.
Critical Value Critical Value determines if a statistic is greatly out-of-rangefor your network. Based on Threshold Type, 'critical' is eitherabove or below this value, and widgets display a red color if a'Critical Value' is crossed.
Performance based thresholds use actual values, whilebaseline thresholds use percentage values.
4. Click Accept.
You successfully configured a threshold to better reflect your network conditions.
Understanding threshold color bars in tablesThreshold color bars in table widgets reveal when normal, marginal, and criticalvalues are observed during a reporting period. For example, a table withthreshold color bars can display which hours today had critically poor VoIP MOSscores instead of summarizing the full day only.
You can identify occurrences of poor network performance within areporting period by using threshold color bars. A table widget can beenhanced to show increments of time when marginal and critical thresholds havebeen 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 typessupport threshold color bars. You must edit the data fields of your table widgetto enable this option, as threshold color bars are not enabled by default whencreating a table widget.
Threshold color bars require your table widget have its reporting intervalbe set to Summary. Meaning, the option is unavailable in table widgets thathave By Time set as the reporting interval. If you want the summary valuesto also show in your table widget, consider also selecting Include SummaryColumn when editing the data field. This inserts another column in the tablethat represents the total values.
Threshold color bars can only be enabled in threshold-supporting datafields. This means that only certain data fields (and never key fields) show theoption. If the data field supports either baseline or performance thresholds—andeither of those is selected—then the threshold color bars option is available whileyou edit the data field. Additionally, threshold color bars cannot work if you setThreshold 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 widgetsfor more details about threshold values and colors.
Understanding widgets32 Apex (23 Jan 2016) — Archive/Non-authoritative version
Conditions for threshold color bars to appearThe 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 aredescribed in the following table.
Table 2: Data field conditions for threshold color bars to appearWidget > Table TableReportingInterval >
Summary By Time
Data field set toperformance orbaseline threshold
Yes No
Data field supportsthresholds but isset to None
No No
Data field does notsupport thresholds
No No
Understanding widgetsWidgets are tables, graphs, pie charts, and more, made to display informationcollected by Observer Platform products. For widgets to have any effect, theymust be put into dashboards.
Widgets are the building blocks of your dashboards. Every widget type isdesigned 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 chartwidget type could display which protocols contributed most of the traffic duringthe report period.
Understanding widgetsChapter 3: Gather data from your products 33
Figure 7: The Widget Properties tab
Widgets show the data collected by other products. Widgets show thedata collected by data sources. Data sources are your other Observer Platformproducts. This retrieved data, from data sources, is parsed by Apex and displayedin 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 comfortablewith creating their own widgets, you might develop less reliance on these.We recommend using system widgets as needed, and even exploring how thesystem widgets were created can aid your learning about Apex!
Widgets can be filtered. The purpose of widget filtering is to narrow thescope of reported criteria, so the end result, like a graph, is specific and easilyunderstood by viewers. Any widget can have a filter written directly into itsdesign. Widget filters force the widget to display only information that meetsthe filter.
For example, you can filter a widget so that it shows statistics from only specificapplications 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 combinea widget filter with other filtering techniques, such as filtering the dashboardor business group, to further filter your results. The widget retains its filterregardless of the dashboards it is placed into. Finally, filtering a widget will notdisplace or modify your underlying data.
Understanding widgets34 Apex (23 Jan 2016) — Archive/Non-authoritative version
The same widget can be put into different dashboards. Widgets can bereused by any number of dashboards. For example, if a widget is placed inone dashboard, the widget can also be put into a different dashboard. Each"instance" of a widget behaves exactly the same regardless of the dashboard, ordashboards, it was placed into. There are some exceptions, however. One exampleis if a dashboard or business group is being filtered, the information shown bythe widget is influenced by the filter. Under these circumstances, it is possible forthe same widget to display different information based on the filter of its parentdashboard or business group.
How to create a widgetYou can create a widget to track the performance of your networks. Thecompleted 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-selectthe widget.
3. Use the menus and options shown to configure a widget.
You can click the Next and Previous buttons to navigate through thesemenus, 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 dashboardTo 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 widgetYou can filter individual widgets if desired. Meaning, the smallest building-blocksof your dashboards, like tables and graph widgets, can be filtered to focus onspecific 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 trendingdata.
Understanding widgetsChapter 3: Gather data from your products 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—thefilter remains in effect.
How to edit a widgetEditing a widget changes its behavior in any dashboard it is used in. You can edita 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 thesemenus, or you can click the tabs.
4. Click Accept.
The widget was successfully edited. Any dashboard the widget is used in willimmediately reflect your changes.
How to export a widgetEvery widget can be exported to a downloadable file. The file can be used formany purposes, such as archival, back ups, or to import back into Apex.
The exported widget contains all the properties, fields selections, andconfiguration of the widget you are viewing.
Note: The exported widget file may contain sensitive information. This isespecially true of the widget title and customized names for fields, whichare 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 widgets36 Apex (23 Jan 2016) — Archive/Non-authoritative version
How to import a widgetAny widget that was previously exported can be imported into Apex. This createsa full widget, including its properties and field selections, that existed when itwas 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-selectthe 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 widgetDeleting a widget removes it from every dashboard it is used in, and it alsodeletes 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 fieldsA key field provides context for your measurements. For example, measuring BitsReceived from your web server can be helpful, but it is extra helpful to categorizethose bits received by the application used. Application is a key field that makesthis happen.
Understanding widgetsChapter 3: Gather data from your products 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 measurementsyour data sources collect and pass to Apex are just numbers—they are pieces ofinformation. After you give the numbers some context, like a key field will do,you begin to create knowledge. This is the difference between knowing youraverage VoIP MOS score is low and determining which UC Manager is responsiblefor lowering the average.
Generally, you can think of key fields as legends, like the legends includedin a bar graph. That statement is not always true, though, because it dependson the widget type you choose to use. For example, status widgets do not evenuse 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 seepacket 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 justpacket volume over time by application? What if it is important to know the MACaddress as well? Just add MAC Address - Client and/or MAC Address - Serveras key fields, depending on which endpoints are important to you. If you wereediting a table widget, the table would begin showing the MAC addresses.
Filters will interact with your chosen key fields, and sometimes that isunwelcome. For example, having a key field of VLAN Tag ID and a dashboardor widget filter that ignores all measurements from VLAN 1, VLAN 2, and VLAN3, can show you VLAN tag IDs from VLAN 4 or greater only. Maybe this is whatyou intend, but sometimes it might cause confusion or negatively influence yourunderstanding.
Widget settingsWidget settings determine what your widget looks like, what type it is, howmany items appear in the widget, and more.
Title The name of this widget. The name shows on the widget whenviewed in a dashboard.
Widget types and categories38 Apex (23 Jan 2016) — Archive/Non-authoritative version
Widget titles are all you see when making dashboards, so bedescriptive.
Widget Type Build a widget from one of several base types.
For details about widget types, see Widget types andcategories.
Reporting Interval Reporting Interval controls how data is displayed by thiswidget.
Summary Sum of all values collected during the reportingperiod
By Time Individual values collected during the reportingperiod
Graph Type Sets or changes the graph type.
Max Items Sets the maximum number of results drawn in the widget evenif more results are available.
Valid Input: Valid values are 1-1000. The default is 10.
The types of items drawn differ between widget types and fieldcombinations.
Filter Filter strings can be added to narrow your results.
For details about filter strings, see Apex filters.
Hide emptycolumns
If selected, this widget hides fields that contain no data.
Fields can hide if no data was collected or no activity occurredduring the reporting period.
Widget types and categoriesEach 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 widgetsStatus widgets show current performance or current performance relative to aknown baseline.
Widget types and categoriesChapter 3: Gather data from your products 39
Figure 9: Status Dial and Arc
There are important differences to be aware of when looking at a statuswidget. First, you must know whether you are looking at a widget showingactual current performance or a widget showing current performance relativeto a baseline. Second, you must be aware of the From/To time frame for theentire dashboard because all widgets—and especially baseline widgets—arebased 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 isgreen, yellow, or red is determined by the percentage difference in the variancefrom the baseline value. Performance widgets are also green, yellow, or red, buttheir status is determined by whether the current value is higher or lower thanthreshold value for that category. Whether the widget is green, yellow, or red isbased This is a subtle but important distinction between performance widgetsand baseline widgets.
When a status widget combines multiple data fields the status shownis for the worst-performing component. For example, consider a statuswidget for an application. That application is really comprised of a database,some middleware, and several servers. Each one of those components has itsown status. If any one of them shows a yellow or red status, then the top-levelapplication status will also show yellow or red based on the worst performingcomponent. In case there are multiple statuses that are equally bad, then thetop-level status shows the worst of the worst. This is so you know where tofocus your attention first.
When no current value is available for a status widget, the widget displaysa “No data” message. For baseline status widgets, if there is a current value butno baseline is available, the widget appears grayed out with the current valuealso shown as gray.
If a status widget’s current value and its threshold data are zero (0), the widgetwill either be green or red depending on the “above” or “below” thresholdsetting.
Widget types and categories40 Apex (23 Jan 2016) — Archive/Non-authoritative version
Widget fields by data stream type and widget typeThis table lists every data field and key field in Apex and shows the data streamit came from and in what widget type each can be used.
Table 3: Widget fields and data streams Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
AvailableFields
FieldType1
PairData
IPSubnet
APATradingMulticast
GeneralURLSQLFIX SummaryCallsServerTableGraphChartStatusADMTableGraphGraphThreshold
AlignmentErrors1->2
DF X X X X X X X X
AlignmentErrors1<-2
DF X X X X X X X X
AlignmentErrorsClient->Server
DF X X X X X X X X X
AlignmentErrorsClient<-Server
DF X X X X X X X X X
AlignmentErrorsRx
DF X X X X X X X X
AlignmentErrorsTotal
DF X X X X X X X X X
AlignmentErrorsTx
DF X X X X X X X X
AudioBits/Sec
DF X X X X X X X X X X
AudioBytes
DF X X X X X X X X X X
AudioPackets
DF X X X X X X X X X X
AverageCallDuration(seconds)
DF X X X X X X X X X
Widget types and categoriesChapter 3: Gather data from your products 41
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
AverageCallSetupDuration(seconds)
DF X X X X X X X X X
Bits/sec1->2
DF X X X X X X X X X X
Bits/sec1<-2
DF X X X X X X X X X X
Bits/secClient->Server
DF X X X X X X X X X X X
Bits/secClient<-Server
DF X X X X X X X X X X X
Bits/secRx
DF X X X X X X X X X X
Bits/secTotal
DF X X X X X X X X X X X
Bits/secTx
DF X X X X X X X X X X
BroadcastPacketsTx
DF X X X X X X X X
Broadcast/MulticastPacketsTxTotal
DF X X X X X X X X
Burst%Average
DF X X X X X X X X X
BurstDensity%Average
DF X X X X X X X X X
Widget types and categories42 Apex (23 Jan 2016) — Archive/Non-authoritative version
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
BurstDurationAverage(seconds)
DF X X X X X X X X X
Bytes1->2
DF X X X X X X X X X X
Bytes1<-2
DF X X X X X X X X X X
BytesClient->Server
DF X X X X X X X X X X X
BytesClient<-Server
DF X X X X X X X X X X X
BytesRx
DF X X X X X X X X X X
BytesTotal
DF X X X X X X X X X X X
BytesTx
DF X X X X X X X X X X
Bytes/sec1->2
DF X X X X X X X X X X
Bytes/sec1<-2
DF X X X X X X X X X X
Bytes/secClient->Server
DF X X X X X X X X X X X
Bytes/secClient<-Server
DF X X X X X X X X X X X
Widget types and categoriesChapter 3: Gather data from your products 43
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
Bytes/secRx
DF X X X X X X X X X X
Bytes/secTotal
DF X X X X X X X X X X X
Bytes/secTx
DF X X X X X X X X X X
CRCErrors1->2
DF X X X X X X X X
CRCErrors1<-2
DF X X X X X X X X
CRCErrorsClient->Server
DF X X X X X X X X X
CRCErrorsClient<-Server
DF X X X X X X X X X
CRCErrorsRx
DF X X X X X X X X
CRCErrorsTotal
DF X X X X X X X X X
CRCErrorsTx
DF X X X X X X X X
CallCount
DF X X X X X X X X X
CallPhonesAddressList
DF X X X
CallStartTime
DF X X X
CallStation
DF X X X
Widget types and categories44 Apex (23 Jan 2016) — Archive/Non-authoritative version
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
AddressListCallsClosed
DF X X X X X X X X
CallsStarted
DF X X X X X X X X
CodecList
DF X X X X X
CompletedRequests
DF X X X X X X X X X X X X
ControlBits/Sec
DF X X X X X X X X X X
ControlBytes
DF X X X X X X X X X X
ControlPackets
DF X X X X X X X X X X
DataBits/Sec
DF X X X X X X X X X X
DataBytes
DF X X X X X X X X X X
DataPackets
DF X X X X X X X X X X
DroppedRequests
DF X X X X X X X X X X X X
GapDensity%Average
DF X X X X X X X X X
GapDurationAverage(seconds)
DF X X X X X X X X X
GoodputBits/secClient->Server
DF X X X X X X X X X
GoodputBits/secClient<-Server
DF X X X X X X X X X
GoodputBytesClient-
DF X X X X X X X X X
Widget types and categoriesChapter 3: Gather data from your products 45
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
>ServerGoodputBytesClient<-Server
DF X X X X X X X X X
Goodput/Throughput%Client->Server
DF X X X X X X X X X
Goodput/Throughput%Client<-Server
DF X X X X X X X X X
IPToSMaximum
DF X X X X X X X X X X X X
IPToSMinimum
DF X X X X X X X X X X X X
Jitter(ms)Average
DF X X X X X X X X X X
Jitter(ms)Maximum
DF X X X X X X X X X X
Jitter(ms)Minimum
DF X X X X X X X X X X
JitterAverage
DF X X X X X X X X X X
JitterMaximum
DF X X X X X X X X X X
JitterMinimum
DF X X X X X X X X X X
LossRateAverage
DF X X X X X X X X X
MOSAudioAverage
DF X X X X X X X X X X
MOSAudioMaximum
DF X X X X X X X X X X
Widget types and categories46 Apex (23 Jan 2016) — Archive/Non-authoritative version
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
MOSAudioMinimum
DF X X X X X X X X X X
MOSVideoAverage
DF X X X X X X X X X X
MOSVideoMaximum
DF X X X X X X X X X X
MOSVideoMinimum
DF X X X X X X X X X X
MulticastPacketsTx
DF X X X X X X X X
NetworkDelayAverage(ms)Client->Server
DF X X X X X X X X X
NetworkDelayAverage(ms)Client<-Server
DF X X X X X X X X X
NetworkDelayMaximum(ms)Client->Server
DF X X X X X X X X X
NetworkDelayMaximum(ms)Client<-Server
DF X X X X X X X X X
NetworkDelayRoundTrip(ms)
DF X X X X X X X X X
NetworkSpeed
DF X X X X X X X X X X X X X X X X X
Widget types and categoriesChapter 3: Gather data from your products 47
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
Bits/secNetworkUtilizationAverage
DF X X X X X X X X X X X X X X X X X X X
NetworkUtilizationMaximum
DF X X X X X X X X X X X X X X X X X X X
NetworkUtilizationMinimum
DF X X X X X X X X X X X X X X X X X X X
ObservedConnections
DF X X X X X X X X X
Packets1->2
DF X X X X X X X X X X
Packets1<-2
DF X X X X X X X X X X
PacketsClient->Server
DF X X X X X X X X X X X
PacketsClient<-Server
DF X X X X X X X X X X X
PacketsLost%Average
DF X X X X X X X X X X
PacketsOutofOrder
DF X X X X X X X X X X
PacketsRx
DF X X X X X X X X X X
PacketsTotal
DF X X X X X X X X X X X
PacketsTx
DF X X X X X X X X X X
Packets/sec1->2
DF X X X X X X X X X X
Widget types and categories48 Apex (23 Jan 2016) — Archive/Non-authoritative version
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
Packets/sec1<-2
DF X X X X X X X X X X
Packets/secClient->Server
DF X X X X X X X X X X X
Packets/secClient<-Server
DF X X X X X X X X X X X
Packets/secRx
DF X X X X X X X X X X
Packets/secTotal
DF X X X X X X X X X X X
Packets/secTx
DF X X X X X X X X X X
QualityBits/Sec
DF X X X X X X X X X X
QualityBytes
DF X X X X X X X X X X
QualityPackets
DF X X X X X X X X X X
R-FactorAudioAverage
DF X X X X X X X X X X
R-FactorAudioMaximum
DF X X X X X X X X X X
R-FactorAudioMinimum
DF X X X X X X X X X X
R-FactorVideoAverage
DF X X X X X X X X X X
R-Factor
DF X X X X X X X X X X
Widget types and categoriesChapter 3: Gather data from your products 49
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
VideoMaximumR-FactorVideoMinimum
DF X X X X X X X X X X
RequestBits/sec
DF X X X X X X X X X X X X
RequestBytes
DF X X X X X X X X X X X X
RequestBytes/sec
DF X X X X X X X X X X X X
RequestPackets
DF X X X X X X X X X X X X
ResponseBits/sec
DF X X X X X X X X X X X X
ResponseBytes
DF X X X X X X X X X X X X
ResponseBytes/sec
DF X X X X X X X X X X X X
ResponsePackets
DF X X X X X X X X X X X X
ResponseTimeAverage(ms)
DF X X X X X X X X X X X X
ResponseTimeAverage(ms)Client->Server
DF X X X X X X X X X
ResponseTimeAverage(ms)Client<-Server
DF X X X X X X X X X
ResponseTimeDistribution
DF X X X X X X X X X X
ResponseTime
DF X X X X X X X X X X X X
Widget types and categories50 Apex (23 Jan 2016) — Archive/Non-authoritative version
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
Maximum(ms)ResponseTimeMaximum(ms)Client->Server
DF X X X X X X X X X
ResponseTimeMaximum(ms)Client<-Server
DF X X X X X X X X X
RetransmissionsClient->Server
DF X X X X X X X X X
RetransmissionsClient<-Server
DF X X X X X X X X X
RetransmissionsTooFastClient->Server
DF X X X X X X X X X
RetransmissionsTooFastClient<-Server
DF X X X X X X X X X
RuntErrors1->2
DF X X X X X X X X
RuntErrors1<-2
DF X X X X X X X X
RuntErrorsClient
DF X X X X X X X X X
Widget types and categoriesChapter 3: Gather data from your products 51
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
->ServerRuntErrorsClient<-Server
DF X X X X X X X X X
RuntErrorsRx
DF X X X X X X X X
RuntErrorsTotal
DF X X X X X X X X X
RuntErrorsTx
DF X X X X X X X X
SizeDistribution1->2
DF X X X X X
SizeDistribution1<-2
DF X X X X X
SizeDistributionClient->Server
DF X X X X X
SizeDistributionClient<-Server
DF X X X X X
SizeDistributionRx
DF X X X X X
SizeDistributionTotal
DF X X X X X
SizeDistributionTx
DF X X X X X
SubnetNetworkSpeed
DF X X X X X X X
Widget types and categories52 Apex (23 Jan 2016) — Archive/Non-authoritative version
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
Bits/secSubnetRangeAddressPair
DF X X X
TooBigErrors1->2
DF X X X X X X X X
TooBigErrors1<-2
DF X X X X X X X X
TooBigErrorsClient->Server
DF X X X X X X X X X
TooBigErrorsClient<-Server
DF X X X X X X X X X
TooBigErrorsRx
DF X X X X X X X X
TooBigErrorsTotal
DF X X X X X X X X X
TooBigErrorsTx
DF X X X X X X X X
TotalRequests
DF X X X X X X X X X X X X
TotalResponses
DF X X X X X X X X X X X X
TradingMulticastGoodput
DF X X X X X X X X
Widget types and categoriesChapter 3: Gather data from your products 53
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
Bits/secTradingMulticastGoodputBytes
DF X X X X X X X X
TradingMulticastGoodputBytes/sec
DF X X X X X X X X
TradingMulticastGoodput/Throughput%
DF X X X X X X X X
TradingMulticastPacketsLost
DF X X X X X X X X
TradingMulticastPacketsLost%
DF X X X X X X X X
TradingMulticastPacketsOutOfOrder
DF X X X X X X X X
TradingMulticastPacketsOutOfOrder%
DF X X X X X X X X
TradingMulticastPacketsTotal
DF X X X X X X X X
TradingMulticastPackets/secLost
DF X X X X X X X X
TradingMulticastPackets/secOut
DF X X X X X X X X
Widget types and categories54 Apex (23 Jan 2016) — Archive/Non-authoritative version
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
ofOrderTradingMulticastPackets/secTotal
DF X X X X X X X X
TradingMulticastThroughputBits/sec
DF X X X X X X X X
TradingMulticastThroughputBytes
DF X X X X X X X X
TradingMulticastThroughputBytes/sec
DF X X X X X X X X
Utilization1->2
DF X X X X X X X X X X
Utilization1<-2
DF X X X X X X X X X X
UtilizationClient->Server
DF X X X X X X X X X X X
UtilizationClient<-Server
DF X X X X X X X X X X X
UtilizationRx
DF X X X X X X X X X X
UtilizationSubnet1->2
DF X X X X X X X X
UtilizationSubnet1<-2
DF X X X X X X X X
Widget types and categoriesChapter 3: Gather data from your products 55
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
UtilizationSubnetTotal
DF X X X X X X X X
UtilizationTotal
DF X X X X X X X X X X X
UtilizationTx
DF X X X X X X X X X X
VideoBits/Sec
DF X X X X X X X X X X
VideoBytes
DF X X X X X X X X X X
VideoPackets
DF X X X X X X X X X X
VoIPBits/SecTotal
DF X X X X X X X X X X
VoIPBytesTotal
DF X X X X X X X X X X
VoIPPacketsTotal
DF X X X X X X X X X X
ZeroWindowsClient->Server
DF X X X X X X X X X
ZeroWindowsClient<-Server
DF X X X X X X X X X
ApplicationKF
BrowserKF
BrowserPlatform
KF
BrowserVersion
KF
DataSource
KF
EthertypeKF
FIXOrderTypeRequest
KF
FIXOrder
KF
Widget types and categories56 Apex (23 Jan 2016) — Archive/Non-authoritative version
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
TypeResponseIPAddress
KF
IPAddress-Client
KF
IPAddress-Pair
KF
IPAddress-Server
KF
IPProtocol
KF
LinkProtocol
KF
MACAddress
KF
MACAddress-Client
KF
MACAddress-Pair
KF
MACAddress-Server
KF
MPLSLabel
KF
MPLSLabel-Client
KF
MPLSLabel-Pair
KF
MPLSLabel-Server
KF
NetFlowAutonomousSystem
KF
Widget types and categoriesChapter 3: Gather data from your products 57
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
NetFlowAutonomousSystem-Client
KF
NetFlowAutonomousSystem-Pair
KF
NetFlowAutonomousSystem-Server
KF
NetFlowInterfaceIndex
KF
NetFlowInterfaceIndex-Client
KF
NetFlowInterfaceIndex-Pair
KF
NetFlowInterfaceIndex-Server
KF
NetworkType
KF
PortKF
Port-Client
KF
Port-Pair
KF
Port-Server
KF
RequestCode
KF
ResponseCode
KF
SQLStatement
KF
Understanding an application dependency map (ADM)58 Apex (23 Jan 2016) — Archive/Non-authoritative version
Type of Data Stream Widgets Types for Fields APA ATA VoIP Summary By Time
SubnetRange
KF
TradingMulticastStreamIdentifier
KF
TradingMulticastStreamName
KF
URLKF
VLANTagID
KF
VoIPCall
KF
VoIPDeviceIP
KF
VoIPIPType
KF
VoIPStationIP
KF
1. DF=data field; KF=key field
Understanding an application dependency map(ADM)
An application dependency map widget (ADM) allows you to discover and mapthe 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 thedependency one server has on another server. The application dependency mapelement can help expose those dependencies.
For example, you may have legacy equipment in your network environment. Thisequipment has been on your network for years, but what exactly is it responsiblefor? Would removing it from the network harm any existing applications andsolutions? The answers may have been lost over time, but Apex can help youunderstand those dependencies before you act.
Visualizing the components of multi-tier applicationsUsing data from Application Performance Analysis, multi-tier applications canbe automatically parsed and visualized as a diagram. Each diagram displays theobserved dependencies of a multi-tier application, such as the servers involvedand clients served.
Understanding an application dependency map (ADM)Chapter 3: Gather data from your products 59
The workflow requires steps be performed from Libraries > Dashboard Libraryand some steps while viewing the widget from My Dashboards. These are thehigh-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 anapplication 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 widgetAn ADM widget must be created and added to a dashboard before it can be fullyconfigured 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)60 Apex (23 Jan 2016) — Archive/Non-authoritative version
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 thesemenus, 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 widgetAfter adding an application dependency map widget to a dashboard, further useof the widget now occurs while viewing the dashboard.
Prerequisite(s):
These steps assume you have already added an application dependencymap widget to your dashboard and are viewing that dashboard from MyDashboards. 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 criteriafor your server search.
5. Set the criteria for your server search as broad or narrow as necessary, andclick OK to start the discovery.
For example, to discover all stations that used LDAP or MySQL this week, typeLDAP, MySQL into the Application(s) box. Then click inside the Time Rangebox 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 themto the ADM widget.
7. Right-click any of the servers (nodes) that appear in the ADM widget, andclick Discover Connections.
8. Select the servers or clients of interest from the resulting list, and click OK toadd 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 theADM widget.
10. Lock the ADM widget by clicking the Lock icon in the upper-right corner ofthe ADM widget.
Understanding scheduled reportsChapter 3: Gather data from your products 61
The connecting lines interact with the thresholds set in Settings > Thresholdsand the reporting interval. Each line can be clicked for additional information.
After you are finished, you can rearrange the nodes on the ADM widget byclicking and dragging. The widget must be unlocked for rearrangements to bemade.
Understanding scheduled reportsA scheduled report is a report that is sent out by email at specified times. Youcan specify what is included; who should get the report; and how often it will besent.
Scheduled reports are static, which means they do not change even ifthe underlying data changes. A PDF attachment is sent to email recipientsspecified in the scheduled report, and the content inside the PDF is a snapshotof 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 isa convenient way to get information without having to search for it. It simplyarrives in your email inbox.
The scheduled report contains data for the time frame you selected,relative to the time you set the scheduled report to execute. So whencreating a scheduled report, you must specify the report schedule intervals,which are the times the report executes and a PDF is prepared. For most of theseschedule intervals, there are Execution Frequency and Execution Period liststhat must be configured to your liking.
For example, if you schedule the report to execute every one hour (ExecutionFrequency 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 timeperiod 12:00-13:00; at 14:00 for the period 13:00-14:00; and at 15:00 for theperiod 14:00-15:00. The scheduled report itself will typically be sent to emailrecipients about 10-20 minutes after each execution, to allow time for the datato be transferred—the wait is usually Data transfer period (minutes) plus Datatransfer delay (minutes)—but the data it runs against is from your specifiedtimes, always.
Understanding scheduled reports62 Apex (23 Jan 2016) — Archive/Non-authoritative version
Figure 10: Execution times from our example
Optionally, a filter can be applied to any scheduled report. The filter on yourscheduled report is in addition to other applicable filters like business groupfilters, dashboard filters, and widget filters. The scheduled report filter takeseffect after all other filters, so it is equivalent to using the “ad hoc” filter thatlooks like a search box when viewing dashboards normally.
If the business group or dashboard selected in your scheduled report isdeleted, the scheduled report is also deleted. For example, if you delete abusiness group from which three scheduled reports are using, all three scheduledreports will be deleted. These deletion events appear in the event log, but noexplicit notifications of deletions are sent to the email recipients.
How to create a scheduled reportA scheduled report is a snapshot of a dashboard that is sent out by email atspecified times. Email recipients can then view the dashboard as a PDF.
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.
Understanding GigaStor Report drill downChapter 3: Gather data from your products 63
You successfully created a scheduled report. During each scheduled time frame, aPDF is created and an email is sent to recipients.
How to edit scheduled reportsAfter creating a scheduled report, you may need to periodically edit it to meetyour 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 effectimmediately.
Scheduled report optionsThere are several options that affect your scheduled reports.
Scheduled ReportName
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.
PDF Orientation Sets the orientation of the PDF output.
PDF Layout Sets how widgets are displayed in the resulting PDF.
Email addresses Scheduled reports are sent to the specified email address oraddresses.
Example: [email protected] [email protected];[email protected] multiple recipients by separating each address with asemi-colon ';' or comma ','.
Report Schedule Set the times and days when this scheduled report executes.
Understanding GigaStor Report drill downGigaStor Report drill down refers to following data entries shown in Apexdashboards and widgets directly to packets stored in the GigaStor. This alsopasses any applicable Apex filters to the GigaStor Control Panel (GSCP).
For GigaStor Report drill down to work, the computer system viewing Apex froma web browser must also have Observer installed within it. Without Observerinstalled 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 targetGigaStor probe instance would be unavailable.
Understanding GigaStor Report drill down64 Apex (23 Jan 2016) — Archive/Non-authoritative version
Overall steps needed for drill downGigaStor Report drill down requires setup in both Observer and Apex before itcan be used. The initial setup may take some time, but no further configuration isnecessary unless you need to make changes.
Table 4: What to do in Observer/GigaStorWhat to haveconfigured
Purpose for doing this
Observer mustbe installed andrunning on thesame local systemthat the dashboardis being viewedfrom and that isattempting theGigaStor Reportdrill down.
Apex opens the GSCP in Observer when drill down is successful.Therefore, this can only occur if Observer is installed locally.
Your GigaStorprobe instance(s)to drill down onmust be shownas Connected(green color), whichimplies that thisprobe instance isavailable for use.
The drill down operation will fail if your local probe instance isdisconnected/unavailable or is redirected to a different Observersystem than yours.
The “target”GigaStor probeinstance mustbe bound to thecorrect activeinstance for whichthe packet data isstored and writtento disk.
This ensures that the probe instance is able to data mine on thecorrect set of data written to disk. Otherwise, you run the risk ofperforming drill down into data that you might not care about.
The correct Apexdata sourcemapping betweenthe data source inthe business groupand the GigaStordrill down probeinstance(s) must bemade.
This enables Apex to properly make the “correct” connectionbetween the dashboard data entry, shown for a given datasource and the actual GigaStor probe instance which maycontain the specific packet data related to that Apex data entry.
The GSCP inObserver mustbe accessibleat the time ofperforming a drilldown operation inApex. For example,a scheduled packetcapture cannotbe occurring at
If the GSCP is disabled on the probe instance, the drill downoperation will fail.
Understanding GigaStor Report drill downChapter 3: Gather data from your products 65
What to haveconfigured
Purpose for doing this
this time becauseit temporarilydisables the GSCP.
Table 5: What to do in ApexWhat to haveconfigured
Purpose for doing this
The intendeddashboard, withinwhich GigaStordrill down is to beused, must containa widget with theData Source keyfield added to it.
This enables an aspect of the relationship between thedashboard data entry and the actual GigaStor probe instance,which may contain the specific data, to be made.
A probe instancethat you want todrill down intomust be part ofthe data sourcethat is assignedto the businessgroup for which thedashboard will berun.
Assigning the data sources correctly enables the Apex dashboardto display the intended data during drill downs.
How to prepare Observer for drill downThe GigaStor probe instances in Observer must be configured correctly for drilldown to operate in Apex. Ensure your active instances are configured correctly.
To prepare Observer for drill down, ensure the GigaStor active instances areconfigured correctly:
1. Ensure the GigaStor probe instance(s) you want to drill down on are in aconnected 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 down66 Apex (23 Jan 2016) — Archive/Non-authoritative version
4. Ensure your passive probe instances are bound to your active instancescorrectly.
5. Ensure that each passive probe instance can reach the GSCP by choosingCapture > GigaStor Control Panel.
If you successfully reach the GSCP with probe instances, using them for drilldown in Apex will be successful provided that all prerequisites have been met.
How to prepare Apex for drill downCreate a relationship between the GigaStor probe instance, inside an Apex datasource, and the local probe instance. Use the GigaStor integration feature tocreate this relationship.
To add the GigaStor for drill-down:
1. In the web interface, click Settings > GigaStor Integration.
Understanding GigaStor Report drill downChapter 3: Gather data from your products 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 Observersystem connected to Apex through a web browser. If that describes your
Understanding GigaStor Report drill down68 Apex (23 Jan 2016) — Archive/Non-authoritative version
laptop, for example, you would type your laptop’s IP/DNS and its probeadministration password.
8. Click Configure.
Apex in your web browser connects to your local Observer and returns a listof 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 probeinstance is your GigaStor probe instance which may be redirected to yourlocal Observer. This can be an active or passive probe instance.
10. Click Accept.
How to configure a widget for drill downGigaStor drill down can be performed only on dashboard widgets that haveincluded the Data Source key field. Therefore, adding the Data Source key fieldto 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.
Understanding GigaStor Report drill downChapter 3: Gather data from your products 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. Thewidget is ready for GigaStor drill down, provided that all prerequisites have beenmet.
GigaStor integration settings
Business Group The business group in Apex that will map to a drill-down inGigaStor.
Data Source The data source in Apex that will map to a drill-down inGigaStor.
Probe The remote probe that has GigaStor data.
Instance If seen in dashboard results, this probe instance can performa drill-down to the GigaStor probe instance configured in theConfigure Mapping area.
Asset IP/DNS The IP address or DNS name of the remote Observer containinga 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 andthey will be accepted.
Set password The probe administration password of the Observer located atAsset IP/DNS.
Configure Click to connect to the Observer set in Asset IP/DNS.
GigaStor ProbeInstances
GigaStor instance to map to data source.
Understanding GigaStor Report drill down70 Apex (23 Jan 2016) — Archive/Non-authoritative version
How to drill down using ApexAfter the GigaStor Report drill down feature is configured, you can follow Apexdashboards directly to packet data stored in a GigaStor.
Prerequisite(s):
To successfully drill down from Apex into a GigaStor, you must meet allprerequisites before continuing.
Note: A drill down will fail if the Data Source key field shown on thedashboard’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 DataSource key field inside. See How to configure a widget for drill down if youneed 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. Thetime frame is automatically selected to match your Apex dashboard.
Understanding GigaStor Report drill downChapter 3: Gather data from your products 71
5. Now in Observer, click Analyze and then OK.
An Observer filter is automatically created to match what you saw in theApex dashboard.
6. Ensure the GigaStor Drill Down filter is selected.
Understanding GigaStor Report drill down72 Apex (23 Jan 2016) — Archive/Non-authoritative version
7. (Optional) Make further modifications to the GigaStor Drill Down filter ifdesired.
The GigaStor Drill Down filter is temporary and overwritten each time adrill down is performed. You can save the filter under a new name and reportfolder to make it permanent.
8. Click OK to confirm all changes.
The GigaStor now begins to load actual packets that meet the filter rules andtime frame transferred from Apex.
4
Chapter 4: Installing and upgrading
How to install ApexApex is an intelligent reporting solution that users connect to using a webbrowser. 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 thelatest version from our FTP site: ftp://ftp.observer.viavisolutions.com/pub/downloads/observer/. See Supported Operating Systems for a list of supportedoperating systems.
Caution: Do not uninstall your product prior to or after upgradingunless you intend to remove the product from your system. Beginningwith Observer Platform 17.0, each Observer Platform product createsa security certificate that uniquely identifies it when it is installed. Ifyou uninstall your product prior to upgrading, you will lose the trustrelationship established by the security certificate and must re-authenticate.Uninstalling and reinstalling creates a new certificate. The new certificatewill be automatically rejected by other Observer Platform products that hadhad a pre-existing association with the asset ID of the reinstalled software.For more details about the certificates, see Understanding the certificatetrust model.
To install Apex:
♦ We recommend backing up your existing installation if applicable.♦ Simply run the self-extracting executable and follow the installation
prompts.
How to install Apex74 Apex (23 Jan 2016) — Archive/Non-authoritative version
You may be prompted to license the application during its first launch. This canhappen 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 8.1 64-bit♦ Windows Server 2012 64-bit♦ Windows 10 Pro, Enterprise, Enterprise 2015 LTSB 64-bit
Ports used by Observer Platform v17 and laterOpen inbound and outbound TCP 80, 443, and 25901 on your firewalls forObserver Platform products version 17 and later.
Port FunctionalityTCP 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 25901 All intra-Observer Platform communication.
System specificationsThe 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 putApex in a virtual machine, the table below lists the minimum requirements withthese changes (as appropriate):
♦ DATA array: Four (4) disk RAID5. The more read speed you have, the betteroff you will be.
♦ Hard drives: 7200 RPM platter HDDs. 5400 RPM HDDs and solid statedrives (SSDs) are not recommended.
Platform 2U 19-inch rack-mountable appliance.Memory/RAM 64 GBProcessor(s) Single - Six CoreHard drive(s) OS: 500 GB / DATA: 8 TB (8 x 1 TB RAID5)Redundant PowerSupply
Yes; Standard
Lights OutManagement
IPMI v2.0
Power consumption Input voltage: 100V-240V auto selectInput frequency: 50/60Hz258w (880 Btu/h)
How to install ApexChapter 4: Installing and upgrading 75
OperatingTemperature Range
32° F (0° C) to 104° F (40° C)
Dimensions 19 in (W) x 3.48 in (H) x 26.01 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 strategyTo use Apex effectively, you must understand how you have data sourcesdeployed in your network.
Where you install Apex, Observer Suite, and probes will depend on the sizeand traffic levels of your network. In general,high-traffic installations shouldhave a dedicated Apex system, resulting in a three-tier distribution of Apexfunctionality:
♦ 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 addressmay cause confusion with reports should the address for a system change. Itbecomes very difficult to correlate problems or history when addresses change.
Tip! Create a unique probe instance on every probe that will be used for thesole purpose of collecting network trending data for Apex and call it “Apexinstance.”
Example 1. For larger networks or heavier traffic
For larger networks, or networks with heavy traffic,Apex can be installed on adifferent system than the Observer Analyzer analyzer used to collect networktrending statistics. This forms a three-tier collection and reporting hierarchy withprobes passing information to Observer and Observer passing information toApex.
Example 2. For smaller networks or lighter traffic
For smaller networks, or networks with light traffic, the Apex appliance has Apexand Observer Suite pre-loaded to form a two-tier collection/reporting hierarchy.
Installing the Apex applianceGetting your appliance installed is the first step to greater visibility of yournetwork. This topic covers installing your appliance in the cabinet and connectingit to your network.
Caution: Do not attempt in-cabinet repairs of your appliance. Theappliance 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 Apex76 Apex (23 Jan 2016) — Archive/Non-authoritative version
3. Install the appliance into the rails in your cabinet. Caution! The appliance isheavy. Lift with care. Do not turn on the appliance yet.
4. Install the drives into your Apex appliance. The RAID is pre-built and eachdrive must be installed in a very specific location. To install a drive, slide thedrive in until it clicks firmly in place. See Installing the drives in your ObserverPlatform 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 kitsViavi rail kits are used with its 2U and 5U 19 inch rack-mounted appliances in fourpost L-bracket or U-bracket cabinets.
Prerequisite(s):
Identify whether the mounting posts in your cabinet are an L-bracket or U-bracket. This determines whether you must use the U-extension. If they looklike a "U" (Figure 13), you have a U-bracket cabinet. If the mounting posts inyour cabinet look like an "L" (Figure 14), you have an L-bracket cabinet. The U-extension is only used in L-bracket cabinets to provide extra length and supportdue to the weight of some of the appliances.
The appliance ships with the long rail component attached. This provides a usefulhandhold when unpacking these larger appliances.
Viavi manufactures its rails using high-grade, heavy duty materials. The parts ofthe rail kit include:
♦ Long rail component (2)♦ Short rail component (2)♦ U-extension (2)♦ 8-32 flathead screws (8)♦ 10-32 panhead screws (4)
1. Measure the length of your cabinet from front mounting post to rearmounting 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 cabinetto cabinet. If loosening the screws and sliding the rails does not providethe correct length for your cabinet, you may need to separate the tworail components and flip the short piece and reattach it.
4. L-cabinets only: Attach the U-extension to the long rail component using the10-32 panhead screws.
The rough side of the U-extension with the small protruding nodules mustface towards the long rail component. The U must face towards the outside ofthe cabinet and away from the appliance (Figure 14).
How to install ApexChapter 4: Installing and upgrading 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 Apex78 Apex (23 Jan 2016) — Archive/Non-authoritative version
Installing the drives in your Observer Platform applianceFailure to install the drives in the proper location will result in poor read/writeperformance until the RAID array volume is rebuilt.
Follow these instructions to install the drives correctly before starting theappliance.
Stickers on each drive identify which slot it should be installed in. The drive labeledA1 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 exactlymatch your product.)
Figure 15: Appliance front
3. To install a drive, slide the drive in until it clicks firmly in place. Repeat untilall of the drives are firmly installed as labeled. To install the bottom row ofdrives, 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 thesystem 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 moveor come out. Additionally, you may want to visually inspect all of the drivesfrom the side to verify that they are all sitting at the same approximatedepth. 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 properlyBe especially careful when handling and installing the hard drives. Properhandling is paramount to the longevity of the unit. The internal mechanism ofthe hard drive can be seriously damaged if the hard drive is subjected to forcesoutside its environmental specifications.
How to install ApexChapter 4: Installing and upgrading 79
Caution: When transporting the hard drive, always use the originalpackaging in which the hard drive was delivered to you, and avoid exposingthe hard drive to extreme changes in temperature to minimize the riskof condensation. Each drive for the appliance is packed in shock-resistantboxes.
♦ 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 onthe circuit board assembly.
♦ If the temperature difference between the storage location andinstallation location exceeds 50°F/10°C, for temperature acclimationpurposes, leave the hard drive in the new location over night (or at leasttwo hours) before turning it on.
Setting the IP addressIt 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 toconnect to it using an Observer analyzer or Windows Remote Desktop, both ofwhich can be very useful since most devices are in distant or physically securelocations.
At this point you have physically installed the hardware and connected all thecables. Now, you must turn on the device and configure the software. After thisis complete all of your interaction with the device can now be done remotelyby connecting to the device using an Observer or Windows Remote Desktopdepending on what you want to accomplish.
1. Connect a monitor, keyboard, and mouse to the device and ensure the deviceis plugged into a power outlet. These are only needed temporarily to set theIP address. You can disconnect them when you are finished. Alternatively, youcan use Windows Remote Desktop to connect to the device to make thesechanges. The default IP address is 192.168.1.10.
2. Turn on the system. For some devices, such as the Apex, you may need toensure 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 systemstarts to turn on.
3. Log in to the Windows operating system using the Administrator account. Thedefault Administrator password is admin. After logging in, you may changethis. See the Windows documentation, if necessary.
4. Click Start > Control Panel > Network and Internet Connections >Network Connections. Choose Local Area Connection and right-click andchoose Properties.
5. Select Internet Protocol Version 4 (TCP/IPv4).
How to install Apex80 Apex (23 Jan 2016) — Archive/Non-authoritative version
Figure 17: Default TCP/IP settings
6. Set the IP address, subnet mask, gateway, and DNS server for yourenvironment and click OK. Click OK again to close the Local Area ConnectionProperties dialog. Close the Network Connections window.
Configuring the Lights Out Management port (newerrevisions)
Your appliance comes with an on-board Lights Out Management (LOM) portthat provides you a dedicated management channel for device maintenance. Itallows you to monitor and manage your appliance by remote control regardlessof whether the appliance is powered on.
If you want to use Lights Out Management features, you must first configurethe IP address for the LOM port from the BIOS. Then, you should change theadministrator password to something different than the default.
1. Ensure the LOM port is connected to your network using a straight-throughEthernet cable.
A crossover cable will not work.2. When starting your appliance, press Delete during POST to enter the BIOS
setup.
How to install ApexChapter 4: Installing and upgrading 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.
Set up Apex for the first time82 Apex (23 Jan 2016) — Archive/Non-authoritative version
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 defaultpassword.
8. To change the default password, open a web browser tohttp://IpAddressOfLOMport, and log on with the user name ADMIN andpassword ADMIN in caps.
Note: The user name and password boxes are always case-sensitive.
9. Choose Configuration > Users, and select the second user account (ADMINaccount).
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 ApexAfter Apex is properly installed, all interactions with Apex will occur through aweb browser. To begin using Apex, log in to Apex.
Set up Apex for the first timeChapter 4: Installing and upgrading 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 Howto license Apex.
1. Open a compatible web browser, and type the following URL into the locationbar: https://ApexHost/oa replacing "ApexHost" with the host name or IPaddress of the system where Apex is installed and running.
You may notice a security certificate warning; this is normal for a self-signedcertificate.
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 inthis web interface.
How to license ApexApex is designed to be used as a server-based application.
If Apex is installed along with an Observer Platform product but not licensed, youhave 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: https://
localhost/OA
If it does not, type the URL in the location bar of your web browser and pressEnter.
3. Follow the on-screen instructions provided by your web browser to acceptthe 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 contactTechnical Support.
Licensing settings
Identification The identification number shown should match theidentification number in your license document.
Set up Apex for the first time84 Apex (23 Jan 2016) — Archive/Non-authoritative version
If the numbers do not match, examine the Licensed to andCompany 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 successfullicensing.
Company name is an item found in your license document.
License The license number is included in your license document.
Valid Input: License numbers are always case-sensitive.
How to create a userUser 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 andpassword must be created there.
Any user created in Apex is local to Apex. It is not connected in any way to adomain user account or local system account. If you want or require that sort ofintegration you must use OMS.
Any local user wanting to log in to view or create dashboards must use the username 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 settingsThe 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. Spacecharacters cannot be used, but you may use @_.-.
Description Descriptions are optional and displayed in the Users table.
Consider a real name, or a department name if the user name isshared.
Email Email 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 bedisabled.
Set password Password to be used with the user name.
Valid Input: The length must be between 2-50 characters. Spacecharacters cannot be used.
Set up Apex for the first timeChapter 4: Installing and upgrading 85
How to configure general settingsGeneral program settings control the Apex name, data transfer settings, and datastorage 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 DescriptionApex asset name This changeable name identifies Apex to other Viavi products.
Data storagelocation
Data transferred to Apex is stored in this directory. Alldashboards 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 hardwareappliance.
Data transferperiod (minutes)
The collection period in minutes.
This value cannot be changed.
Data transferdelay (minutes)
Sets the minutes to wait after completion of a data sourcestatistics collection interval before the data is transferred toApex.
Valid Input: Valid values are 0-10.
Setting a delay can improve hard disk performance on thedata source because data is transferred N-minutes after beingwritten.
Missing data fileslimit (days)
Apex automatically retrieves up to this many previous days ofdata from data sources if any are missing.
Valid Input: Valid values are 0-365.
This helps Apex recover 'missing' data from data sources if Apexexperiences downtime, or when collecting data from a datasource for the first time.
How to have Apex managed by OMSIf your organization uses OMS and wants Apex to be a managed asset, you mustintegrate Apex into OMS. Doing so allows functionality like user authenticationand authorization, plus software version control.
Caution: By following these steps, Apex will be managed by OMS. Afterthe connection is made, you will be unable to disable the management withinApex. Therefore, the only way to remove Apex from being managed is toremove 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
How to upgrade or downgrade Apex86 Apex (23 Jan 2016) — Archive/Non-authoritative version
3. In the OMS Server IP/DNS Name box, type the IP address or DNS name ofthe OMS server.
4. Type OMS administrator credentials into the User Name and Passwordboxes.
The credentials must have permission to add new assets and/or licenses toOMS (depending on which is needed), or the asset must already be definedand the user must have access to the asset and a license number must bepresent.
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 ApexNew and past versions of Apex software are made available to you directly fromViavi. Use the Apex upgrade tool to check for, download, or install a version ofApex.
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 versionsA listing of Apex software versions to upgrade or downgrade to is availabledirectly in Apex. Connect to the Viavi upgrade repository to retrieve the latestlisting of available versions.
Note: Interacting with the upgrade repository requires web connectivityover TCP port 80 on the Apex system. This can be achieved with directconnectivity from OMS to the web or by configuring a proxy in the proxyconfiguration settings of OMS for downloads. The upgrade repository ishosted 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 fordownload. Release notes for each version are available for viewing.
How to upgrade or downgrade ApexChapter 4: Installing and upgrading 87
How to download a version of ApexNew or old versions of Apex can be downloaded from the upgrade repository.Apex is not automatically installed after downloading a version using thismethod. Instead, this method is suitable for scheduled installation or installationfrom Windows Explorer.
To download an available version of software for later installation, visit therepository 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 itstransfer progress.
You successfully downloaded a software upgrade.
How to install a version of ApexInstalling a software upgrade downloads the self-extracting setup executableand 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 ifany errors occur during the upgrade.
Upgrade settingsThere are several settings that change the behavior of version upgrades.
Check forupgrades
If selected, Apex periodically checks for upgrades. Scheduledtransfers and installs rely on knowing if new versions exist.
If cleared, users must manually check for available upgradesbefore any scheduled transfers or installs can occur.
Show downgradeoptions
If selected, any available downgrade versions are displayed inthe available versions list.
It is recommended to leave this cleared (disabled) ifdowngrading to previous versions is not desirable.
Preferred speed(Kbps)
Sets the preferred maximum transfer speed in kilobits persecond.
Use the value '0' to disable this bandwidth restriction.
How to upgrade or downgrade Apex88 Apex (23 Jan 2016) — Archive/Non-authoritative version
Use proxy server If selected, a proxy server is used for downloading upgradeversions.
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 forauthentication.
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.
Downloadupgrades
Schedules the download of available upgrade versions.
Downloaded versions will not automatically install unless aninstallation schedule or upgrade policy allows it.
Install upgrades Schedules the installation of downloaded version upgrades.
This setting affects version upgrades that are downloaded bothautomatically or manually.
5
Chapter 5: Troubleshooting
Understanding logging in ApexLogging captures events that occur in the application and between assets. Theseevents may range from informational to critical.
Logging creates an audit trail, or transaction log, allowing you as anadministrator to see who did what and when they did it. You may need thisinformation for compliance or other reasons.
Another reason logging can be useful is if you have a problem with theapplication, the log events will help identify where the issue is occurring.
How to view event logsEvent logs are useful for troubleshooting, compliance, and more. View the eventlogs 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 messagesSyslog is widely used for message logging and separates the applicationgenerating the messages from the program that reports and analyzes them. Apexcan send messages to your Syslog server.
Understanding logging in Apex90 Apex (23 Jan 2016) — Archive/Non-authoritative version
To send log events and alarm notifications, first configure your server andrecipient settings. After configuring these settings, you can enable and disablethe 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 loggedevents to a Syslogserver
If selected, system logs are forwarded to a Syslog server.
System logs remain accessible through the dashboard and CLIinterfaces.
Target IP address The host address of the Syslog server.
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 foreach.
Format Sets which Syslog protocol is used.
Severity The minimum severity level of log events sent to the Syslogserver.
Informational: Contains normal operational messages. Noaction is required.
Warning: Contains cautionary messages. No error hasoccurred but an error may occur if no corrective action istaken.
Critical: Contains fault-finding messages. Corrective actionshould be taken promptly.
Log events of lower severity are not sent.
How to send SNMP trapsEvents recorded in the Apex log can be sent as SNMP traps. Doing so allows youto monitor Apex activity and trigger automated processes to start when certainevents occur.
SNMP traps are widely used for sending notifications from one application toanother, generally for alerting or notification purposes.
Understanding logging in ApexChapter 5: Troubleshooting 91
To send log events and alarm notifications, first configure your server andrecipient settings. After configuring these settings, you can enable and disablethe 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 loggedevents to anSNMP Trap
If selected, system logs are forwarded as SNMP traps to a traprecipient.
Target IP address The host name or IPv4 or IPv6 address of the SNMP traprecipient.
Include up to 10 SNMP trap recipients by separating each with acomma ','.
Target port The port number of the SNMP trap recipient.
Example: 162If more than one SNMP trap recipient is specified, this port isused 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. Noaction is required.
Warning: Contains cautionary messages. No error hasoccurred but an error may occur if no corrective action istaken.
Critical: Contains fault-finding messages. Corrective actionshould be taken promptly.
Log events of lower severity are not sent.
How to send e-mail alertsTo send log events and alarm notifications, first configure your server andrecipient settings. After configuring these settings, you can enable and disablethe sending of automated messages.
Configure your server settings:
Understanding logging in Apex92 Apex (23 Jan 2016) — Archive/Non-authoritative version
1. In the web interface, click Settings > Notification Settings.2. Select Configure an email server.3. Configure the options.
For details, use the information in E-mail 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 email.7. Configure the options.8. Click Accept.
Apex will send logged events to your SMTP server.
E-mail settings
Export loggedevents via email
If selected, system logs are forwarded as email messages.
SMTP Server The host address of the outgoing email server.
Example: 203.0.113.12 -or- smtp.example.comValid Input: Valid addresses include IPv4 or DNS name.
SMTP Port The port number of the outgoing email server.
Security The connection to the outgoing email server can be encryptedto prevent eavesdropping.
PlainText Connection is not encrypted.
SSL, TLS, or DTLS Connection is encrypted.
STARTTLS Negotiates an encrypted connection. Ifnegotiation fails, the connection is not encrypted.
Authentication The authentication type for connecting to the outgoing emailserver.
Try choosing 'Auto Detect' if you experience authenticationproblems.
User Name The user name used to connect to the outgoing email server.
Password If 'User Name' requires a password to connect, type thepassword here.
Leave this box blank if 'User Name' does not require apassword.
Sender Name If specified, this sender name appears in the 'From' field of thesent email.
Setting Sender Name to 'OMS Security' or similar could helprecipients categorize the emails.
Sender Email The sender email address appears in the 'From' field of the sentemail.
Recipients Email Log events are sent to the specified email address or addresses.
Example: [email protected] [email protected];[email protected]
Understanding alarmsChapter 5: Troubleshooting 93
Email multiple recipients by separating each address with asemi-colon ';' or comma ','.
Severity The minimum severity level of log events sent as emailmessages.
Informational: Contains normal operational messages. Noaction is required.
Warning: Contains cautionary messages. No error hasoccurred but an error may occur if no corrective action istaken.
Critical: Contains fault-finding messages. Corrective actionshould be taken promptly.
Log events of lower severity are not sent.
How to return to the default log settingsYou can return the event log to its default settings if necessary. The defaultbehavior is to not forward any log events to email, SNMP, or Syslog, so these willbe 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 alarmsAn Observer Apex alarm monitors the thresholds of widgets in a dashboard.If any widget crosses a set threshold, the alarm is triggered. A triggered alarmsends notification messages to the server and recipients you specify.
If any widget within a chosen dashboard crosses a threshold, the alarmis 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 forthe alarm to trigger. This means you might receive multiple alarm notificationsdepending on how many widgets are crossing thresholds in the dashboard. Also,because there are marginal and critical thresholds, you can choose if the alarmshould trigger from crossing the marginal threshold or the critical threshold. Thisis configurable in the alarm.
A triggered alarm sends an alarm notification to specified servers andrecipients. The servers and email recipients receive alarm notifications as soonas 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 alarmsare sent. This is due to the nature of a data collection transfer interval. Missioncritical alarms, where timing is most important, should be made directly inObserver Analyzer.
An alarm can be filtered. Filtering can help narrow or broaden what actuallytriggers the alarm. For example, typing app http in the filter box of the alarmsettings means HTTP metrics are all that may trigger an alarm because it is theonly application of interest. This filtering is additional to any filtering done on
Understanding alarms94 Apex (23 Jan 2016) — Archive/Non-authoritative version
the business group, dashboard, or widgets. Therefore, if a dashboard or all ofits widgets are always filtered to show MySQL traffic, giving this dashboardan alarm for HTTP is not meaningful. Using narrowly-filtered alarms on broad,unfiltered dashboards and widgets may be a good method to follow unless youare comfortable managing filters at each level.
Your web browser can be closed and alarms will still operate. Alarms have nodependence on you actually being present in a web browser session for the alarmto trigger. Because alarm triggering and alarm actions, like sending an SNMP trapor email, are performed entirely server-side, you only need to create or edit thealarm from your web browser and that is all. Apex will do the rest.
How to create an alarmPrerequisite(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 anddashboard 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 aschedule.
b. Under the Actions area, select and configure where the alarmnotifications should be sent.
At least one selection must be made. These selections use yournotification 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 willtrigger. A triggered alarm sends notifications to the servers and recipients youspecified.
How to disable an alarmYou can disable an alarm that is producing too many alarm notifications. Or, theproblem has been identified and your team is now troubleshooting—additionalnotifications are unnecessary. Instead of deleting an alarm to avoid receivingmore notifications, you can choose to disable it. This method allows you to re-enable 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.
Understanding alarmsChapter 5: Troubleshooting 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 settingsSeveral 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 youinclude.
Send Syslog If selected, alarm notifications are forwarded as Syslogmessages.
Configure the Syslog server settings at Settings > NotificationSettings.
Syslog Severity The minimum severity level of log events sent to the Syslogserver.
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 > NotificationSettings.
SNMP TrapSeverity
The minimum severity level of log events sent as SNMP traps.
Log events of lower severity are not sent.
Send Email If selected, alarm notifications are forwarded as email messages.
Configure the email server settings at Settings > NotificationSettings.
Email addresses Alarm notifications are sent to the specified email address oraddresses.
Example: [email protected] [email protected];[email protected] multiple recipients by separating each address with asemi-colon ';' or comma ','.
Send EmailSeverity
The minimum severity level of log events sent as emailmessages.
Log events of lower severity are not sent.
Troubleshooting network, server, and application issues96 Apex (23 Jan 2016) — Archive/Non-authoritative version
Troubleshooting network, server, and applicationissues
Using a simple, flexible, and easy-to-understand workflow will help youtroubleshoot many common network, server, and application issues. This willguide your process and help identify areas of interest while providing a workingcontext for your investigation.
The Observer Platform provides powerful and comprehensive tools and analyticsthat 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-7analytics that can be used to quickly resolve many issues. Apex dashboards usestatistical data (metadata) that Observer collects separate from packet capturesusing network trending. The metadata files can easily store weeks or months oftrending statistics. The second application is Observer, which provides detailedpacket-based analytics and tools for decoding and working with packets.Observer analyzes packet data and assesses more than 700 conditions and haspowerful tools to help you determine the root cause of an issue.
A logical and methodical workflow is needed to analyze and resolve issues. Youneed to know how to use your tools and understand what the analytics aretelling you; it takes practice. It’s important that you gather as much informationas possible before trying to resolve a problem. Here are some suggestions oninformation 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 withinminutes with only a couple mouse clicks. We encourage you to spend timepracticing and learning how to use Observer and Apex. Documentation and freeweb 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, usuallya couple hours is ideal. This way the information will be more detailed andaccurate.
Tip! Apex lets you easily “focus” a dashboard on your area of interest byproviding a dashboard filter or widget filter or using your mouse to selecta key field. Apply the dashboard to the selected object (like application orIP address). Also, if you click a key field, you can pass that parameter toanother dashboard for even more analysis.
Troubleshooting network, server, and application issuesChapter 5: Troubleshooting 97
Learn to use the dynamic filtering ability and key field dashboard links so thedashboards show the metrics that are relevant for your investigation. It’s an easyway to quickly get to the information you need.
Many network engineers use a common best practice approach totroubleshooting. This approach typically starts with determining if an issue isrelated to a network, a server, or an application problem. After that determinationis made, it then leads to more targeted investigation, analysis, and, ultimately,a resolution. This approach also is helpful from an organizational perspectiveso that appropriate resources and tools are engaged. We will illustrate thistroubleshooting process by working through a common problem: Users arecomplaining that a server is slow.
Is it the network?The Network Performance dashboard helps you determine if network roundtripand latency are impacting server response time to users. It focuses on network-centric information like network latency and delay, network roundtrip, devicebyte counts, retransmissions, and utilization.
Select the Network Performance dashboard. To get the dashboard, seeImporting 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, thetime it takes for the packets to traverse the network; and 2) server delay, the timeit takes for the server to process that application request. These are calculatedby analyzing the time it takes for the TCP three-way handshake to complete atthe beginning of a user connection. The total server response time metric is anaccurate indication of how efficiently your network is delivering packets as wellas the latency of the network.
Let’s first look at a healthy network by using our dashboard widget for SQLservers. The network delay roundtrip metric is always a good starting point.The Server Network Delay- Round Trip widget shows server network delaymetrics sorted by the longest round trip time. If that number is low, then yourpackets are moving efficiently through the network and the latency is low.Notice our round trip, maximum, and average delays are all low. This networkis running well. We don’t see network delay, latency-centric problems, or manyretransmissions here.
Figure 18: Healthy network
Troubleshooting network, server, and application issues98 Apex (23 Jan 2016) — Archive/Non-authoritative version
Now let’s take a look at an unhealthy network using the same widget, butfocused on HTTP servers. Our first HTTP server, 54.241.162.83, has an averageNetwork Delay Round Trip time of 1719 ms, almost 2 seconds. The table showsnetwork delay by direction: from client to server, from server to client, as wellaverage and maximum values. Knowing the direction of the delay is helpful.
It’s also important to compare the average and maximum value. If the averagevalue is high it suggests this problem is happening all the time. If the average islow but the maximum is high, it suggests that this may have been a temporarycondition 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. Theservers in this table are showing high average and maximum network delayswhich suggests that the network is not running efficiently, this is indicative of anetwork issue.
Figure 19: Unhealthy network
To further troubleshoot round trip/latency issues, it’s helpful to know additionalinformation, such as what does the network topology look like, where is theserver located, are users accessing the server over a WAN, what is the utilizationof the various network segments being traversed. It’s also important to knowwhere the probe is located in the network for context of the network delaymetrics. The network delay round trip value is usually the best metric to quicklyassess network latency problems.
Determining where the latency is actually occurring and why in a complexnetwork is a bit more difficult. If you have deployed probes strategically, youcan use the MultiHop Analysis tool in Observer to show you where the latencyis occurring in your network. Below is an example MultiHop Analysis summaryfor four segments showing where the latency is occurring (a probe is deployed ateach segment).
Troubleshooting network, server, and application issuesChapter 5: Troubleshooting 99
Figure 20: MultiHop Summary
Is it the server?In Is it the network? we used the Network Performance dashboard to take aclose look at response time issues from a network perspective. Now we will focuson response time issues from a server perspective.
The Server Performance dashboard helps you determine if a server is impactingserver slow and is having slow response times that are affecting users.
Select the Server Performance dashboard. To get the dashboard, see Importinga 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 somemetrics we previously examined for the network. Since network performanceimpacts server response times, it’s convenient to have analytics from both in onedashboard. For Figure 21, we have filtered the dashboard to a single HTTP server.
Troubleshooting network, server, and application issues100 Apex (23 Jan 2016) — Archive/Non-authoritative version
Figure 21: Server Performance dashboard
Looking at the Servers by response time max widget, we see the maximumresponse time is greater than four seconds. But just as important, notice thatthe average response time is only 159 milliseconds and the round trip delay isvery low (40 milliseconds). This means that the majority of the time the serverresponse time is low and our network is running efficiently, but we do have someperformance spikes.
Let’s look at another widget in Figure 21: Server/client by response timemax. These are the clients connecting to our HTTP server sorted by maximumresponse time. You can see that only one client has a high maximum responsetime value (4137 milliseconds), the rest are low. Also notice that the server had536 retransmissions to that client. This suggests that the problem is limited tothis server/client pair.
Tip! Using additional tools like Connection Dynamics or Ad Hoc ApplicationTransaction Analysis in Observer to look at the packet data between thisclient 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 slowserver 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 thenetwork 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 numberof connections, traffic volumes, network delay, or retransmissions and theapplication server response time.
Troubleshooting network, server, and application issuesChapter 5: Troubleshooting 101
Figure 23: Correlation chart: performance analysis by time
You can also use the Server Analysis tool in Observer to get server details. InFigure 24, you can see values comparing the number of users and simultaneousrequests. Notice that the response time is relatively linear and flat, indicatingthe server is handling the load well. If you saw a large or exponential increase inresponse time as simultaneous requests increased, that would suggest too manyusers or inadequate server resources. We know that the average response time isrelatively 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 latencyissues and Is it the server? to assess server response time issues. We determinedthat neither the network nor server were the culprit.
The Application Performance dashboard helps you determine if applicationtransaction response times and application error conditions and the impact theycan have on application server response times are the source of the problemaffecting users.
Select the Application Performance dashboard. To get the dashboard, seeImporting a user-contributed dashboard.
This dashboard provides detailed application transaction information such astransaction types and errors, as well as detailed response times. This informationhelps you determine how the application is performing by transaction andwhether it is the application that is impacting users. To see application levelinformation in Apex, you must have application transaction analysis enabledfor the desired servers on the Observer GigaStor or probe. Observer andApex support application transaction analysis for many different enterpriseapplications such as DNS, SQL, HTTP, Citrix, LDAP, CIFS/SMB, SIP, and more.
Troubleshooting network, server, and application issues102 Apex (23 Jan 2016) — Archive/Non-authoritative version
Below are two tables from the Application Performance dashboard that showtransaction responses and requests for an HTTP server of interest. You can seethe request and response codes and description, plus the corresponding averageand maximum response time for each transaction type. In Figure 25, if you lookat the Request table (lower table), the most common request transaction is aGET, which is typical for HTTP. If you look at the GET request line the averageresponse time is low, 120 ms, but the maximum is almost 10 seconds (9996milliseconds). Clearly some user transactions are experiencing long response timedelays.
Figure 25: Application Analysis Server-Response
Let’s now look at the top table for transaction responses in Figure 25. We havesorted the response codes to show various HTTP transaction errors that showup in the 400 response code range. You will notice several transaction problems.We had 124 400-Bad Requests that took almost 10 seconds max to process. Butwhat is really problematic is that we had 2,134 404-Not Found response errors.The average response time was 166 milliseconds and the maximum response timewas greater than 8 seconds (8320 milliseconds). These issues are causing usererrors as well as slow response time. By looking at the Application Performancedashboard, we can determine if we have application errors causing user problemsas well as the response time metrics associated with various transaction types.
In this example, we identified a major application error problem from ourApplication Performance dashboard. We were getting many 404 File NotFound errors. We can use the ability to launch a drilldown connection from adashboard to the packet data in the probe (this passes a context-based filter tothe GigaStor), or we can just go to our probe and analyze the packet data for aparticular server to find the root cause of any application error.
Figure 26 shows the probe statistics for several monitored web servers. You canright-click the application error 404=Not Found and then choose Go to RequestPacket or Go to Response Packet to decode the data.
Troubleshooting network, server, and application issuesChapter 5: Troubleshooting 103
Figure 26: Application Statistics
Figure 27 shows the packet decode and the HTTP request was for the filesystem_requirements_and_installation.html on networkinstruments.com. We nowknow what file was missing on our web server that caused 404=Not Found errors.
Figure 27: 404 HTTP Request
SummaryUsing some common sense troubleshooting techniques, and asking ourselvessome basic questions, we were able to use Apex, Observer, and GigaStor to lookat the network, server, and application to isolate the problem. Now that weknow 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 youcan use and configure. The VoIP/UC Analysis dashboard provides summariesfor VoIP/UC Analysis performance. The Web/HTTP Analysis dashboard provides
Troubleshooting network, server, and application issues104 Apex (23 Jan 2016) — Archive/Non-authoritative version
details from an HTTP perspective. The Device Health Analysis dashboard givesyou a comprehensive network, server, and application information for a device,all in one dashboard. It also shows detailed application transaction analysisbetween a client/server pair for in-depth analysis. The dashboard library isdynamic and growing. See Importing a user-contributed dashboard.
All dashboards are made up of widgets. The dashboards and widgets are veryflexible and can easily be customized by you. We encourage you to design andcustomize your own widgets and dashboards after you have become comfortablewith the use and design of them.
6
Chapter 6: Backups and Secondary
Configuring a failover or redundant ApexIf you need a high degree of availability for Apex, then enable the Apexredundancy 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 thesecondary Apex system automatically becomes active and available fordashboards. By having a failover Apex system, you can help ensure thatmaximum availability is maintained.
Configuring a failover or redundant Apex106 Apex (23 Jan 2016) — Archive/Non-authoritative version
Figure 28: Example of failover operation
Failover
Config/Logs
HeartbeatPrimary
Normal Operation: A heartbeat confirms primary system is available. Primary sends configuration data to failover at regular intervals. Failover is online, but passive.
Failover Operation: A heartbeat is no longer detected. Failover assumes primary system’s responsibilities.
Defining a failover ApexUsing a failover server ensures the least amount of disruption and allows users tostay productive if there is a network or hardware issue.
Follow these steps to configure Apex to use two servers to maintain maximumuptime.
1. In the web interface, click Settings > Failover.2. Complete the fields. Use the information in Failover settings for details.3. Click Accept.
The failover server is created when the Failover server saved notificationappears on the screen.
Failover settingsThe failover settings control whether a failover server is used. Use thisinformation to configure a failover server.
Enable failovermode
If selected, failover mode is enabled between the primary andsecondary servers.
View 'Connection to the failover server' to ensure the primaryand secondary servers are communicating.
Understanding configuration backupsChapter 6: Backups and Secondary 107
Set this server asprimary
If selected, this Apex server is the primary server in a failoverconfiguration. Otherwise, it is the secondary or failover server.
Only v17 or newer assets will report a value.
IP address/DNS ofthe other failoverserver
The host address of the other Apex server.
Valid Input: Valid addresses include IPv4, IPv6, or DNS name.
Maximumdays to keepunpropagatedconfigurationchanges
Sets the maximum number of days without connectivity to aprimary server before configuration changes stop accumulatingand replicating to the secondary server. If this happens, theprimary server replicates its complete configuration to thesecondary server after connectivity is re-established.
Any configuration changes made on the secondary server duringthis period will be overwritten.
Connection to thefailover server
A read-only field.
The network connection status between the primary andsecondary server.
Becoming a primary/secondary ApexPrerequisite(s):
Ensure you have defined the secondary Apex. See Defining a failover Apex.
If you have two Apex systems, follow these steps to switch roles of the Apexsystems. These instructions assume you want to promote the secondary server tothe primary server.
1. In the web interface, click Settings > Failover.2. On the primary server, clear Set this server as primary.3. On the secondary server, select Set this server as primary.4. Click Accept.
The Apex systems communicate and exchange roles.
Understanding configuration backupsBackups allow you to restore the configuration settings of Apex to a previousstate.
A backup can restore all of your Apex configuration settings.
How to create a backupYou can back up your configuration settings so that restoring them is possible.
To create a backup:
1. In the web interface, click Settings > Backup & Restore.2. Click New.3. Click Yes to confirm creation of the backup.
You successfully created a backup. With it, your configuration settings can berestored.
Understanding configuration backups108 Apex (23 Jan 2016) — Archive/Non-authoritative version
How to restore configuration settingsYou can restore Apex to how it was when a backup was created. This can beuseful for troubleshooting or even simple archival.
Prerequisite(s):
This process requires a previously made backup file. This backup file must belocated in—or placed into, if it is not already there—the file directory wherebackups are stored.
Note: This process will log you out of Apex upon completion. You can logback in immediately afterwards.
To restore configuration settings:
1. In the web interface, click Settings > Backup & Restore.2. Select one by clicking a table row.3. Click Restore.4. Click Yes to confirm the restoration.
All of your previous settings are now replaced with the settings inside thebackup file.
Because the process logs you out of Apex, you can log in after the backup isrestored.
How to schedule backupsYou can schedule the creation of new backups. This can help ensure you haveaccess to backups from multiple times and dates in case they are needed.
To schedule backups:
1. In the web interface, click Settings > Backup & Restore.2. Click Prefs.3. Set Backup schedule to Daily or Day of Week to begin making a schedule.
Note: Backing up manually always remains an option, regardless of thissetting.
For example, click Daily and then the plus symbol to add daily times.4. Click Accept.
You successfully created a schedule for backups. One backup file will be createdduring each scheduled time.
How to change where backups are storedBy default, backups are stored in a subdirectory where Apex is installed.However, this storage location can be changed to a different hard drive or to amapped network drive, as examples.
The configuration backup files are stored in a ZIP archive. Each backup producesone ZIP archive file, and its total compressed size is less than 100 KB.
Understanding configuration backupsChapter 6: Backups and Secondary 109
To change where backups are stored:
1. In the web interface, click Settings > Backup & Restore.2. Click Prefs.3. Type a different directory path in the Configuration backup location box.4. Click Accept.
You successfully changed the storage location for your backups.
110 Index (23 Jan 2016)
Index
Aactivating 10, 83ADM 58, 58, 59, 60APA 40Apex
about 6installing 73, 75Observer, and 75
Apex Lite 10, 83Apex, and 75ATA 40
Bbackup
configuration settings 107baseline 38business group
about 15adding or creating 16
business groupsfiltering 17
By time 40
Cconfiguration
backing up 107connecting expansion units 75contributed dashboard 26
Ddashboard 22, 26, 26, 26
about 18adding or creating 20viewing 82widgets, adding 20
dashboards 23auto-refresh 21auto-refresh, about 25deleting 24exporting 22GigaStor 66scheduled reports 62, 63scheduling 61scheduling, options 63
data sourceabout 12adding or creating 12assigning 13
data sourcesdata transfer, forcing 14, 14
data stream 40daylight savings time 23deleting
dashboards 24deploying 75deployment architecture 75
Eexpansion units 75, 79
Ffailover server 106, 107field type 40fields, key 36filter 22, 37FIX 40
GGen2 card
Gigabit copper 75get started 10, 82, 83Gigabit copper 75GigaStor 79
dashboards 66expansion units 75, 79hard drives
installing 78, 78, 78graph threshold 40graph type 37green 38
Hhard drives
installing 78, 78, 78hide empty columns 37high-traffic installations 75
IiKVM 75import 26, 26installing 73, 75, 75, 78, 78, 78
deployment architecture 75IP address
GigaStor 79setting 79, 79
IP subnet 40IPMI 80ISO8601 23
Chapter : 111
Kkey fields 36KVM 75
Llarger 75licensing 10, 83lights out management 75, 80LOM 75, 80
Mmax items 37
Nnetworks
larger 75smaller 75
OObserver
Apex, and 75Observer, and 75operating system 74out-of-band management 75, 80
Ppair data 40ports 74primary server 106, 107probe instance 75Probe Options 79Probe Service Configuration Applet 79promote 26
Rread performance 78red 38Remote Desktop 79reporting interval 37reports 18
Ssecondary server 106, 107service 79setting 79, 79settings
backing up 107backing up, scheduling 108backing up, storage location 108restoring 108
SFP 75shared dashboard 26site dashboard 26smaller 75SQL 40starting 10, 82, 83status widget 38summer time 23
T
TCBthreshold color bars 31, 32
TCP 79TCP/IP 79TCP/IP settings 79threshold 40threshold color bars 31, 32title 37Trading Multicast 40
UURL 40UTC 23
VVoIP calls 40VoIP server 40VoIP summary 40
Wwidget 32, 40widget settings 37widget type 37widget types 40widgets
ADM 58, 58, 59, 60Windows
Remote Desktop 79service 79
Windows 10 74Windows 2003 74Windows 2008 74Windows 2012 74Windows 7 74Windows 8 74Windows Vista 74write performance 78
Yyellow 38