vFoglight™ 5.2.
© 2008 Quest Software, Inc. ALL RIGHTS RESERVED. This guide contains proprietary information protected by copyright. The software described in this guide is furnished under a software license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of the applicable agreement.
Table of Contents Introduction to this Guide ...................................................................................................................................9 About vFoglight .............................................................................................................................................................. 10 About this Guide............................................................................................................................................
vFoglight User Guide Bookmarks ............................................................................................................................................................. 43 Understanding Roles in vFoglight................................................................................................................................... 46 Working with Dashboards .............................................................................................................................
Table of Contents 5 Availability Graphs................................................................................................................................................107 Choosing Another Service Level ..........................................................................................................................108 Building a Service ...................................................................................................................................................
vFoglight User Guide Viewing Server Metrics ................................................................................................................................................. 147 Looking at Server Details.............................................................................................................................................. 149 Viewing MySQL Database Details ................................................................................................................
Table of Contents 7 Editing a Scheduled Report..................................................................................................................................200 Copying a Scheduled Report ...............................................................................................................................201 Disabling/Enabling a Scheduled Report...............................................................................................................
vFoglight User Guide
Introduction to this Guide This chapter provides information about what is contained in the vFoglight User Guide. It also provides information about the vFoglight documentation suite and Vizioncore. This chapter contains the following sections: About vFoglight............................................................................................................................10 About this Guide.............................................................................................................
vFoglight Cartridge for VMware User Guide About vFoglight vFoglight helps IT organizations understand the virtual infrastructure by managing the relationships and interaction between all the components in the environment, including data centers, data stores, clusters, resource pools, hosts and virtual machines.
Introduction to this Guide vFoglight Documentation Suite 11 Chapter 7, Working with Applications—This chapter describes how to monitor and create an application. Chapter 8, Working with Reports—This chapter introduces the Reports dashboard and Report Manager dashboard. Reports can be created based on the supplied report templates or your own custom report.
vFoglight Cartridge for VMware User Guide The PDF guides are included in the zip file downloaded from Vizioncore. Adobe® Reader® is required. • HTML: Release Notes are provided in HTML.
Introduction to this Guide Text Conventions 13 Some cartridges include additional PDF guides, which may be one or more of the following: a Getting Started Guide, an Installation Guide, a User Guide, and a Reference Guide. Feedback on the Documentation We are interested in receiving feedback from you about our documentation.
vFoglight Cartridge for VMware User Guide About Vizioncore Inc. Vizioncore was formed in July 2002 as a consulting and software-development company with the mission to create easy-to-use software solutions that performed reliable and repeatable automation of datacenter functions specifically for the Citrix platform.
Introduction to this Guide About Vizioncore Inc.
Contacting Dell Note: If you do not have an active Internet connection, you can find contact information on your purchase invoice, packing slip, bill, or Dell product catalog. Dell provides several online and telephone-based support and service options. Availability varies by country and product, and some services may not be available in your area. To contact Dell for sales, technical support, or customer service issues: 1 Visit http://support.dell.com.
Austria (Vienna) International Access Code: 900 Country Code: 43 City Code: 1 Bahamas Barbados Belgium (Brussels) Bolivia Brazil International Access Code: 00 Country Code: 55 City Code: 51 British Virgin Islands Brunei Country Code: 673 Canada (North York, Ontario) International Access Code: 011 Support.euro.dell.com Web Address Tech_support_central_europe@dell.
Chile (Santiago) Country Code: 56 City Code: 2 China (Xiamen) Web Address E-Mail Address Sales and Customer Support Technical Support Web Address Technical Support E-Mail Address Country Code: 86 Customer Service E-Mail Address City Code: 592 Technical Support Fax Technical Support – Dimension and Inspiron Technical Support – OptiPlex, Lattitude and Dell Precision Technical Support – Servers and Storage Technical Support – Projectors, PDAs, Switches, Routers, etc Technical Support – Printers Customer Ser
Dominican Republic Ecuador El Salvador Finland (Helsinki) International Access Code: 990 Country Code: 358 City Code: 9 France (Paris) (Montpellier) International Access Code: 00 Country Code: 33 City Codes: (1) (4) Web Address E-Mail Address Technical Support, Customer Service, Sales Web Address E-Mail Address Technical Support, Customer Service, Sales (Calling from Quito) Technical Support, Customer Service, Sales (Calling from Guayaquil) Web Address E-Mail Address Technical Support, Customer Servic
Guatemala Guyana Hong Kong International Access Code: 001 Country Code: 852 India Web Address E-Mail Address Technical Support, Customer Service, Sales E-Mail Address Technical Support, Customer Service, Sales Web Address Technical Support E-mail Address Technical Support - Dimension and Inspiron Technical Support - OptiPlex, Latitude, and Dell Precision Technical Support - Servers and Storage Technical Support - Projectors, PDAs, Switches, Routers, etc .
Ireland (Cherrywood) International Access Code: 00 Country Code: 353 City Code: 1 Italy (Milan) International Access Code: 00 Country Code: 39 City Code: 02 Jamaica Web Address Technical Support E-mail Address Business computers Home computers At Home Support Sales Home Small Business Medium Business Large Business E-mail Address Customer Service Home and Small Business Business (greater than 200 employees) General Fax/Sales fax Switchboard U.K. Customer Service (dealing with U.K.
Japan (Kawasaki) International Access Code: 001 Country Code: 81 City Code: 44 Korea (Seoul) International Access Code: 001 Country Code: 82 City Code: 2 Latin America Luxemborg International Access Code: 00 Country Code: 352 Macao Country Code: 83 Web Address Technical Support - Dimension and Inspiron Technical Support outside of Japan - Dimension and Inspiron Technical Support - Dell Precision, OptiPlex, and Latitude Technical Support outside of Japan - Dell Precision, OptiPlex, and Latitude Techni
Malaysia (Penang) International Access Code: 00 Country Code: 60 City Code: 4 Mexico International Access Code: 00 Country Code: 52 Montserrat Netherlands Antilles Netherlands (Amsterdam) International Access Code: 00 Country Code: 31 City Code: 20 New Zealand International Access Code: 00 Country Code: 64 Nicaragua Norway (Lysaker) International Access Code: 00 Country Code: 47 Panama Peru Support.ap.dell.
Poland (Warsaw) International Access Code: 011 Country Code: 48 City Code: 22 Portugal International Access Code: 00 Country Code: 351 Puerto Rico St. Kitts and Nevis St. Lucia St.
Spain (Madrid) International Access Code: 00 Country Code: 34 City Code: 91 Sweden (Upplands Vasby) International Access Code: 00 Country Code: 46 City Code: 8 Switzerland (Geneva) International Access Code: 00 Country Code: 41 City Code: 22 Web Address Home and Small Business Technical Support Customer Service Sales Switchboard Fax Corporate Technical Support Customer Service Switchboard Fax Web Address Technical Support Relational Customer Service Home/Small Business Customer Service Employee Purchas
U.K.(Bracknell) International Access Code: 00 Country Code: 44 City Code: 1344 Uruguay U.S.A.
U.S. Virgin Islands Venezuela Web Address E-mail Address Technical Support, Customer Service, Sales Web Address E-mail Address Technical Support, Customer Service, Sales www.dell.com/vi la‐techsupport@dell.com toll‐free: 1‐877‐702‐4360 www.dell.com/ve la‐techsupport@dell.
1 Getting Started with vFoglight This chapter gives an introduction to the main dashboards and views in the vFoglight browser interface. It also describes the icons and other screen elements that you will see in most cartridges. Note vFoglight displays dynamic data that is updated regularly. For this reason it is not recommended that you use your browser’s Back and Forward buttons, as this may cause cached views to be displayed or result in an error message.
vFoglight User Guide Logging in to vFoglight vFoglight runs in Internet Explorer 6 and 7 and Mozilla Firefox 2.0x and 3.0x. Your administrator will provide you with a link to the login page, where you enter your user name and password. Figure 1 Introducing the Browser Interface The following sections describe the main pages that you will see in a default installation. Note Your administrator may have configured vFoglight so that the actual displays are different from those in this section.
Getting Started with vFoglight Introducing the Browser Interface 31 Figure 2 The Welcome page contains helpful links to vFoglight Getting Started documentation and tips, vFoglight demonstrations, online help, and support links. The Welcome to vFoglight page will remain your default home page unless you set a different home page. For instructions on changing your home page to a dashboard of your choice, see “Home Page” on page 39. The instructions are also on the Welcome to vFoglight page.
vFoglight User Guide Figure 3 Figure 4 Navigation Panel The navigation panel contains all the dashboards that are available for viewing by the current user. You can expand a module and select a dashboard to view it in the display area. This panel also provides access to the administration and configuration pages. Note If you do not see any dashboards in the navigation panel, the user you signed in as may not have been assigned to a group.
Getting Started with vFoglight Introducing the Browser Interface 33 • A home page that you have selected (for details, see “Screen Elements” on page 31). • The first bookmark listed under Bookmarks; the default bookmark is the Welcome page (for details about creating bookmarks, see “Creating a Bookmark” on page 43). Filter Icon Select the Filter icon to filter by role to control which group role can access different parts of vFoglight.
vFoglight User Guide Header The header contains the following icons: Function Description Click the product name to take you back to the Home page. username Sign Out The user name of the current user. Logs out the current user and reclaims all resources that it used in the current session. This is the recommended way to exit vFoglight, rather than just closing the browser.
Getting Started with vFoglight Introducing the Browser Interface 35 • Data tab—contains a list of data objects that can be displayed in chart or table format by dragging them into the display area. Display Area In the display area you can view current dashboards and reports, as well as create new or custom dashboards and reports. See “Creating a Custom Dashboard” on page 76 and “Creating a Custom Report Template” on page 213 for more information.
vFoglight User Guide Contact Us Links to local contact information on the Vizioncore web site. About Displays product, contact, and support information. Delete Icon A bookmarked page provides easy access to navigation items. Click the Delete icon beside the bookmark to remove it. See Chapter 2, “Deleting a Bookmark in the Bookmarks view”. Zonar and Time Range vFoglight uses a bar chart to indicate the average of all collected metrics within the range of the zonar.
Getting Started with vFoglight Customizing vFoglight 37 Figure 7 The following table describes the User Preferences settings. Setting Description or Options Language This setting controls the language that is used in the vFoglight browser interface. The default is the language set in the browser. Refresh Interval To ensure that the views display current data, vFoglight automatically refreshes the pages. This setting enables you to choose the length of the interval. The default is 300 seconds.
vFoglight User Guide Setting Description or Options Themes Themes are format settings that affect the look of dashboards and reports. You can override this setting for individual dashboard and reports using the Themes options in the action panel. For details, see “Themes” on page 39. You can only change the look of your PDF reports (Create PDF) in User Preferences. To change the theme used in generating (printing) reports to color, choose Report (Color) for the Print theme.
Getting Started with vFoglight Customizing vFoglight 39 indicated in the Map field that points to a target view will be redirected instead to the view indicated in the To field. Caution This requires knowledge of how views are created, and should only be set by a view or dashboard designer. For more information, see the Web Component Guide. Home Page You can choose any dashboard to be your personal home page. Other dashboards can also be designated as home pages by a dashboard developer.
vFoglight User Guide The following table describes the options. Option Result Application - Default White background in all dashboards and views Monitoring - Default Dark blue background in all dashboards and views Report (Monochrome) Reports are printed in black and white Report (Color) Reports are printed in color Note To print PDF reports in color, the theme must be changed in the User Preferences dashboard.
2 Navigation in vFoglight This chapter provides an introduction to the navigation tools used in the vFoglight browser interface and also an introduction to roles. This chapter contains the following sections: Introduction to Navigation............................................................................................................42 Understanding Roles in vFoglight................................................................................................
vFoglight User Guide Introduction to Navigation In addition to the navigation panel, other navigational aids are located in dashboards and views. These include: • Data views (charts, tables, cylinders) provide links to more detail about the data that is selected (service > service detail) or to diagnose a problem (alarm > alarm detail). • Selector views (trees, drop-down lists) allow you to change the context (domain, host, etc.) of what you are viewing.
Navigation in vFoglight Introduction to Navigation 43 Table Links Content in tables can be links to views. For example, in a table that contains a list of hosts, each host name may be a link to a page with more information about that host. Tables also have icons and functions for sorting, paging, and filtering. These are discussed in “Working With Tables” on page 91. Icon Links Icons may be links to other views or dashboards. Linked icons and non-linked icons look the same.
vFoglight User Guide 3 Type a unique name in the Name field. 4 Select one of the Keep for options to indicate whether you want to keep the bookmark indefinitely or for a specified number of days. If you choose the latter, type the number of days in the text field. 5 Select Send an email with a link to this bookmark if you want to send someone a link to the new bookmark. 6 Select Preserve state if you want to keep the context input of the dashboard.
Navigation in vFoglight Introduction to Navigation 45 Emailing a Link to a Bookmark This option is also available when you create a bookmark. To email a link to a bookmark: 1 In the Bookmarks area of the navigation panel, select a bookmark to display it. 2 Select Email from the action panel. An email window opens, containing a link to the bookmark. 3 Fill in the required information and click Send. Changing Bookmark Properties You can change the expiry time and the description of an existing bookmark.
vFoglight User Guide 3 On the confirmation dialog, click Delete to delete the bookmark. Understanding Roles in vFoglight vFoglight controls access to dashboards and views by means of roles. A vFoglight administrator assigns users to groups and then assigns roles to those groups. When you try to access a dashboard or view, the roles of the groups to which you belong are matched against the relevant roles and the allowed roles that were set for that dashboard or view.
Navigation in vFoglight Understanding Roles in vFoglight 47 Role Permissions Cartridge Developer Ability to load cartridges, create rules and derived metrics, and perform other tasks related to creating a cartridge. Administrator Access to all administrative functions, particularly the ability to deploy, create, and control agents. See the vFoglight Administration and Configuration Guide for additional information on users, groups and roles.
vFoglight User Guide
3 Working with Dashboards This section describes how to work with vFoglight dashboards, and provides a description of the common elements that are found on most dashboards. Note For information about the options in the Administration module, see the Administration and Configuration Guide. For information about the Definitions dashboard, see the Web Component Guide.
vFoglight User Guide Introduction to Dashboards vFoglight displays monitoring data in views that group, format, and display it. Dashboards are top-level views that do not need to receive data from other views. Dashboards usually contain a number of lower-level views. The dashboards supplied with vFoglight, as well as those created by users, are available in the navigation panel. Lower-level views in vFoglight can be added to dashboards or can be accessed by drilling down from a dashboard.
Working with Dashboards Introduction to Dashboards 51 Tooltips and dwells disappear when you move the mouse, but a popup remains open until you close it by clicking outside it or clicking the close icon in the corner. You can also maximize some popups by clicking the maximize icon in the upper right corner. Figure 1 Time Range The time range at the top of a dashboard indicates the current time range for all the views on the page.
vFoglight User Guide arrow beside Precision Control expands the dialog to display the Precision Control options. Clicking the browse button to the right of the date fields displays the calendars.
Working with Dashboards Introduction to Dashboards 53 You can disconnect from real time and “freeze” a dashboard at a specified time range. When this occurs, the views on the dashboard will not receive any new data. To freeze a time range: 1 Select the dashboard for which you want to freeze the time range. 2 Click the icon to the left of the displayed time range at the top right of the dashboard.
vFoglight User Guide The diagnostic time range function works as follows: • For any alarm that is not in the current time range, if you click on a drill down, places you into a diagnostic time range. • Some drill-downs indicate that you are in diagnostic time range as shown in the dialog box below. Note The diagnostic time range function is not available for all drill-downs. Zonar At the top of the dialog is a sliding bar called the Zonar.
Working with Dashboards Introduction to Dashboards 55 Precision Control The Precision Control section is collapsed when the dialog opens. To display it, click the down arrow to the right of Precision Control. Date and Time Fields Type specific dates and times for the range. If you enter an incorrect date or time, a red exclamation mark is displayed at the right of the field and you cannot apply the changes. You can also use the Earliest Available or Current Date check box to set the time range.
vFoglight User Guide Splitter Composite views may have a moveable bar, or splitter, between the two views. It can be either horizontal or vertical. You can move it back and forth to resize the views on either side. Figure 5 The splitter has two arrows facing in opposite directions. When you click an arrow, the view it is facing collapses, the splitter moves to the edge of the remaining view, and only the other arrow is visible. You can restore the hidden view by clicking the other arrow.
Working with Dashboards Introduction to Dashboards 57 Customizer The Customizer icon is available for charts and tables. Note To access the customizer it needs to be enabled. Customizers are not enabled by default. If the Customizer icon is enabled you can: • Change the chart type dynamically. See “Changing the Chart Type” on page 81. • Export charts and tables to PDF or CSV format. See Exporting Data from Charts and Tables.
vFoglight User Guide Common Views vFoglight makes use of common views in most of the standard dashboards. Using common views in pre-declared dashboards is an effective way to enable and create easy workflows. Examples of views used in most of the dashboards include the Alarm list display and the Host summary display. Alarm List When a list of alarms is shown, the same alarm list view appears as a popup or fixed path depending on the navigation path.
Working with Dashboards Common Views 59 • Related Agent(s) Current Alarm(s) By default, you see the list of alarms with the ability to sort the alarms by different elements (Severity, Time, Ack’ed, Cleared, Host, Instance, Message, Origin, Agent, Agent Type). Error Instance(s) The Error Instances option lists the agents containing data that triggered an alarm in the Outstanding Alarms table.
vFoglight User Guide Select To Health History Hover over the Health History bar to see the percentage and duration of time that the alarm source was at a certain severity level. Related Host(s) A convenient way to isolate issues related to systems is to show the alarms organized by the originating host. You can expand each host to see the source of the alarm. In the example below, all alarms are coming from a single host instance.
Working with Dashboards Common Views 61 Related Agent(s) A useful way to understand which agent is causing an alarm to fire is to show alarms organized by the agent that collected the data. You can expand each agent node to see where the agent is gathering data. The example below shows that the Application Monitor agent is firing fatal alarms and critical alarms are coming from the Windows System agent. Figure 10 Drilldowns The following drilldowns are available from the Related Agent(s) table.
vFoglight User Guide Filtering the Alarms View You can filter the list in the Outstanding Alarms view using one or more of the following criteria: • Severity (Undefined, Normal, Fire, Warning, Critical, Fatal) • Time (range, earliest available, current date) • Is Acknowledged (true or false) • Is Cleared (true or false) • Host name • Instance • Message • Origin (source of an alarm) • Whether or not the alarm has been acknowledged (True or False) • Agent name • Agent type To filter the alarm list: 1 Cli
Working with Dashboards Common Views 63 2 Select or enter your filter criteria. If you want to use a calendar to choose a date or date range, click the browse button to display two calendars. The dates that you choose in the calendars appear above in the From and To fields. 3 If applicable, select the Use Regex checkbox to search for a regular expression (regex). Regex is a special text string that describes a search pattern using wildcards. For example: .*\.txt$ 4 Click Find.
vFoglight User Guide The Alarm status in the Ack’ed column changes to Y to indicate the alarm has been acknowledged. If you hover over the Y, your user name appears in the By user column for that alarm. Note Alternatively, you can acknowledge an alarm using the Alarm Details dialog box. a In the Outstanding alarms view, click N beside the alarm that you want to acknowledge. The Alarm Details dialog box appears.
Working with Dashboards Common Views 65 b Click Acknowledge. Your user name appears in the Ack’ed column for that alarm. The Alarm status in the Ack’ed column changes to Y to indicate the alarm has been acknowledged. If you want to acknowledges the current alarm and all consecutive alarms fired by the same rule on the same instance, click Acknowledge Until Normal. This option is available to an outstanding (not-yet-cleared) alarm only. You can also apply a note to alarm. See “Alarm Notes” on page 70.
vFoglight User Guide 2 Click Clear above the table. The Alarm Status in the Cleared column changes to indicate the alarm has been cleared and the cleared alarm is dimmed out. The alarm is removed from the count for outstanding alarms. Alternatively, you can clear an alarm from the Alarms Details dialog box. Instance When you select the instance of the alarm (e.g.
Working with Dashboards Common Views 67 Figure 11 The health summary: • shows the number of alarms by severity and the overall health of the selected alarm source. • provides links to the agents and host for the alarm source. • provides a list of related views that show quick drilldowns to help identify the root cause. This list is based on the views that match the type of the alarm source. The related views are often provided by cartridges. If no related views are available, then the default views (e.g.
vFoglight User Guide The alarm details view also shows the full alarm history. This includes all consecutive alarms fired by the same rule on the same instance regardless of the time range. The default for 'consecutive' is 5 seconds. Figure 12 Figure 13 Drilldowns The following drilldowns are available from the Alarm Details with Actions popup. Select To Instance The data that triggers an alarm. See “Instance” on page 66. Host see the Host Summary as described on page 74.
Working with Dashboards Common Views Select To Origin (by rule) displays the origin of the alarm. You can access links to: • Rule Details—to view a short synopsis about the rule • Edit Rule—to edit the rule definition • Rule Help—to display online help about the rule To edit a rule, select the rule name and then select Edit Rule Definition. The Rule Editor appears. For further information on editing rules, refer to the vFoglight Administration and Configuration Guide.
vFoglight User Guide Select To Notes tab Displays a list of all alarm notes added to the alarm. Alarm notes allow you to record information about an alarm for yourself and for others. For example, after acknowledging an alarm you can include a note and details as to the alarm. All users can view and create a note but only the author of the note can edit or delete an existing note. Notes can be added to any alarm at any time even after the alarm has cleared.
Working with Dashboards Common Views 71 • Notes tab. In the Notes tab, new notes are automatically attached to the most recent alarm in the alarm history. You can also search for a note by using the Find button or Advanced button. See “Filtering Notes” on page 73. Creating an Alarm Note Alarm notes consist of freeform non-localizable text, a user name and a timestamp.
vFoglight User Guide • Acknowledge the current alarm. See “Acknowledging an Alarm” on page 63. • Acknowledge Until Normal. Selecting this option acknowledges the current alarm and all consecutive alarms fired by the same rule on the same instance. This option is available to an outstanding (not-yet-cleared) alarm only. • Clear the selected alarm. See “Clearing an Alarm” on page 65. Editing an Alarm Note Only the creator of the note can edit the note.
Working with Dashboards Common Views 73 The selected notes are removed. Filtering Notes You can filter notes by clicking the Find button or the Advanced button in the Notes tab of the Alarm Details dialog box. Using the Regular Expressions option when filtering notes enables you to search substrings. To filter a note using the Find button: 1 In the Alarm Details view, click the Notes tab for a particular alarm. 2 Click in the textbox and type a string.
vFoglight User Guide 3 Click Find. Host Summary When a host summary or Host object is shown in the browser interface, you can view a host summary popup or dwell. Figure 14 A diagnostic time range is displayed at the top of the popup summary. This time range indicates the period during which the alarm was fired. It is usually in the past and is sometimes different from the time range that appears on a dashboard.
Working with Dashboards Common Views 75 Figure 15 Drilling down from here retains the time range during which the alarm occurred. To go back to the monitoring time range you last used, "unfreeze" the range by following the procedures in “Freezing a time range” on page 52. Drilldowns The following drilldowns are available from the Host Summary popup.
vFoglight User Guide Select To Alarms see a list of alarms according to alarm severity. Click on a particular alarm severity to view: • • • number of alarms for the particular severity the alarm error instance on a particular agent or host summary table of the time, instance, rule name and ack’d by details. CPU, memory, disk, and network see a detailed drilldown of that part of the host’s performance. Host Monitor Host Browser see a real-time monitoring view of the host.
Working with Dashboards Creating a Custom Dashboard 77 2 Type a unique name for the dashboard in the Name field. This is the only information required to create a new dashboard. 3 By default, a dashboard you create is not available to any vFoglight roles. You can select the default roles to control how people gain access to different parts of the browser interface. To do this, click the edit icon beside Relevant Role(s) and/or Allowed Role(s) and select the appropriate roles.
vFoglight User Guide Deleting a Custom Dashboard You can delete any custom dashboard that you have created. You may also be able to delete dashboards created by other users, although this is not recommended. You cannot delete any default dashboards or dashboards created by dashboard developers in your organization. To delete a custom dashboard: 1 Select the dashboard that you want to delete from the list under My Dashboards. 2 Click Delete this page in the action panel. A confirmation dialog appears.
Working with Dashboards Working with Charts 79 Figure 16 2 You can also add one or more metrics to an existing chart. Figure 17 • The metrics in the chart are indicated by different-colored lines at the left side of the chart under count and percentage (%). • The line for the currently displayed metric (by default, the first one chosen) is bold. To highlight other metrics in the chart, click on the lines in the legend. The legend below the chart changes to indicate the name of the highlighted metric.
vFoglight User Guide The Y axis shows the units for the metric. If there is more than one metric in the chart, the Y axis shows the units for the first metric that was charted, unless you have unchecked the Layout check box in the Metric Chart Default dialog (see “Setting Metric Chart Labels” on page 88 for details). By using the Customizer function you have the option to export metric data for charts to CSV format. See “Exporting Data from Charts and Tables” on page 57.
Working with Dashboards Working with Charts 81 2 The chart will zoom into the range selected and will locally change the time range so vFoglight displays all data points. Now you can view the data for the selected metric at a more granular level. 3 To zoom out and return the line chart to its original view, click the Reset Zoom icon in the top right corner.
vFoglight User Guide To export the chart to CSV or PDF format, see Exporting Data from Charts and Tables. Chart Options You can edit, save, maximize, restore, or close a chart by clicking the icons in the title bar. The editing options are described under “Metrics Chart Editor” on page 83. Note All other charts are hidden when you maximize a chart. To save a chart: 1 Click the save icon in the title bar of the chart that you want to save. The Save Individual View dialog box appears.
Working with Dashboards Working with Charts 83 Pagelets and Reportlets are listed under Configuration > Definitions in the navigation panel. If you have access to the Definitions area, you can use them when building a dashboard. For information about building dashboards, see the Web Component Tutorial. 3 Click OK.
vFoglight User Guide Figure 19 The settings you can change are described in the following table. Note that not all the options are available in both dialogs. Setting Description Options/Limits Title Allows you to rename the chart. No specific limits, but keep display space in mind. Metric Label Allows you to choose another label for the metric. Only available when editing a single chart. Parent Label Allows you to choose another label for the parent metric.
Working with Dashboards Working with Charts Setting Description Options/Limits Chart Lists the available types of chart. • • • • Height Sets the height for all charts or this chart. The default chart height is 300 pixels. Layout Select “Only show metric of selected chart” to show only one axis is used in the chart, regardless of how many metrics are displayed. (For examples, see “Setting Metric Chart Labels” on page 88.) Check box.
vFoglight User Guide Setting Description Options/Limits Metric Value Controls the type of value that is displayed for one metric or all metrics in a chart. • • • • • • None Average: The chart displays the average value for the metric per interval. Minimum: The chart displays the actual lowest value for the metric per interval. Maximum: The chart displays the actual highest value for the metric per interval.
Working with Dashboards Working with Charts Setting Description Options/Limits Show Baseline Min/Max As Displays the baseline minimum and maximum. • • • Show Standard Deviation As Similar to the Min/Max setting; lets you highlight a range per interval. You determine the high and low values by setting the deviation from the average. If a metric has a threshold, it is displayed.
vFoglight User Guide Figure 20 Setting Metric Chart Labels The Layout option enables you to choose the layout of the metric chart axes. Figure 21 • Select the Layout check box for a chart to indicate only one axis is used in the chart, regardless of how many metrics are displayed, as shown below.
Working with Dashboards Viewing Dashboard Properties 89 Figure 22 • Clear the Layout check box to display all the axes in the chart, as shown below. Figure 23 Viewing Dashboard Properties When you are viewing a dashboard, you can edit some or all of its properties and definition if you have the appropriate role(s). You can also use this procedure to publish a dashboard that you have created. To view the properties of a dashboard: 1 Select the dashboard whose properties you want to view or change.
vFoglight User Guide 3 Click Edit basic Properties. The Edit View Properties dialog appears. Depending on your role(s), you may be able to change some or all of the properties. To make available a dashboard that you have created, it is recommended that you choose Operator for both the Relevant Role and Allowed Role. 4 Click OK to close the dialog and save any changes.
Working with Dashboards Working With Tables 91 Working With Tables You can sort and filter data in a table, if these functions are enabled on the table. Sorting Tables If a table is sortable, you can sort it by clicking the column-header text. A down ( up ( ) icon in the table header indicates the current sort order. ) or Filtering Tables Some tables have a filter option in the title bar. When you click it, a dialog opens in which you select filtering criteria.
vFoglight User Guide Printing Views You can print vFoglight views using the Print option in the actions panel. The view is displayed in a separate browser with a standard print dialog. Note To generate a PDF file for a table that exceeds the number of rows to fit on a single page, the table should be specified as either a top level view with the Purpose = report in Configuration > Definitions, or it should be included in the Report Layout container.
4 Working with Services and Alarms A service is a collection of objects that you want to monitor. Some services are created automatically (such as Hosts and Databases) as part of the vFoglight Management Server or as part of the cartridges you deployed. However, most services are created by users based on what they find interesting, and are typically organized around what a user needs to monitor. Different groups of users can define their own services.
vFoglight User Guide Overview In vFoglight, a service is defined as a grouping of one or more monitored components. Typical examples of monitored components include a host, a database, a VirtualCenter server, etc. Services can be nested within other services, each with their own monitored components. All vFoglight services are listed on the Services dashboard, which can be accessed from the navigation panel.
Working with Services and Alarms Overview 95 Severity Icons Severity icons indicate the severity level of alarms that have fired. Icon Description Normal Warning Critical Fatal The normal icon indicates that there have been no critical, warning, or fatal events fired. vFoglight does not record events that are successful; it can only determine that there are no events that had problems. State Icons State icons indicate the status of a domain, server, application, or process.
vFoglight User Guide Availability Icons Availability icons indicate the availability of an application, service, or process. Icon Description Available Not available Monitoring Services You can monitor services using the Services dashboard. This dashboard shows the state of a selected set of services. From this dashboard you can see the alarms for all selected services, alarms for a specific service, the SLA state for a service, and the contents of a service.
Working with Services and Alarms Monitoring Services 97 Figure 1 Figure 2 This dashboard contains two views: • Categories and Services • Outstanding Alarms for Selected Categories Categories and Services The Categories and Services view lists all the monitored services by category. For each category and service it displays the following information for the current time range. Select To display A category or service the view that is described in “Viewing Details about a Service” on page 99.
vFoglight User Guide Select To display A Service Level Compliance icon further details about the related Service Level Agreement. A service can have one or more service level policies. The compliance icon of a given service shows the worst state of all the service level policies that are defined for the service. For example, in the above screen, the Windows service has a Fatal SLA state because one of its components has a Fatal state, even though the others are in a Critical state.
Working with Services and Alarms Monitoring Services 99 The Categories and Services view displays only the services that you selected. Viewing Details about a Service The Categories and Services view provides a number of ways to see more detailed information. • From the Services and Category list, select a category or service to see details by service and host. The popup also provides links to more detailed views, which are described in the table below. Click this link If you are interested in seeing..
vFoglight User Guide Click this link If you are interested in seeing.. Scan for a Root Cause a diagram that shows the composition of a service and the state of each component in the service. It allows a user to quickly scan for the root cause of a problem reported on the service. For details, see “Root Cause Analyzer” on page 102. Service Builder the Service Builder for the selected service or all monitored services. For details, see “Building a Service” on page 108.
Working with Services and Alarms Monitoring Services 101 Select To display A Service Level Compliance icon further details about the related Service Level Agreement. The Service Level Compliance for a category or service is determined by the component in the worst state. A health icon links to: • health of all alarm sources • health of current alarm source • all outstanding alarms for that alarm source An alarm icon a list of alarms for components that are being monitored.
vFoglight User Guide Click this link To display Monitored Component(s) a list of the components that are being monitored by a specific service. To quickly find a component, enter the component name in the search text box at the bottom of the dashboard. For example, enter CPU in the text box to find all CPU components in the service. Related Host(s) a list of hosts that are being monitored by a specific service.
Working with Services and Alarms Monitoring Services 103 Figure 5 You can move the depth control in the upper right corner back and forth to set the number of levels (1-6) in the diagram. The default setting is three levels. The dots above the depth control determine the scale of the diagram. • Click the smaller dot to reduce the scale for easier navigation of large diagrams. • Click the medium dot to restore the diagram to its original scale. • Click the largest dot to zoom to the highest zoom level.
vFoglight User Guide Figure 6 You can filter the list in the Outstanding Alarms view using several criteria. For details, see “Filtering the Alarms View” on page 62. Viewing System-Wide Alarms and Service Details The Services (All Alarms) dashboard is a summary dashboard that contains views with information from other dashboards such as service levels, alarms, and system changes.
Working with Services and Alarms Examining Details on a Single Service 105 Figure 7 The Categories and Services view is described under “Categories and Services” on page 97. The All System Alarms and Changes and Outstanding Alarm(s) for the Entire System views are described under “Monitoring System-Wide Alarms” on page 118. Examining Details on a Single Service The Service Details dashboard contains views that provide detailed information about a service.
vFoglight User Guide Figure 8 To see data for another service, select Service Selector in the action panel to open the Service Selector dialog, where you can choose another service. To choose another service: 1 From the action panel, select Service Selector. The Service Selector popup appears. 2 Navigate to the service for which you want to see details. The Service Details dashboard is refreshed with data about the chosen service. 3 Click to close the popup.
Working with Services and Alarms Viewing Service Levels 107 To examine service levels: 1 From the navigation panel, under Dashboards, click Services > Service Levels. The Service Levels dashboard appears. This dashboard lists the current status, recent availability (used to determine the status), and health history. Other information that is displayed is listed under the following headings.
vFoglight User Guide Choosing Another Service Level To see service levels for another service, select Service Level Selector in the action panel. To choose another service level: 1 From the action panel, select Service Level Selector. The Service Level Selector popup appears. By default, the Service Level Agreements for all the monitored services are listed. 2 Select the Service Level Agreement for which you want to view details.
Working with Services and Alarms Building a Service 109 Creating a New Category Use the Service Builder dashboard to create categories that will be used as inputs on many other dashboards. To create a new category: 1 In the Service Builder dashboard, click Add and then select Add Category. The New Category dialog appears. 2 Type a name for the category. Note You can change the name of a service at a later date, without losing all history for a service. See “Editing a Service Name” on page 114.
vFoglight User Guide 2 Type a name that is unique to vFoglight for the application and click Create. The new application is added as a service to the Applications service category. An application topology component is added below the service. For example in the screen shot below, test app has been added as a service to the Application service category. A corresponding application topology component has been added below the new application.
Working with Services and Alarms Building a Service 111 Use Find, Clear, and Advanced to locate a component. Select All and Unselect All quickly chooses the listed components that you want to add. To locate a component by name and type, click Advanced. You can also use regular expressions. 4 When you have chosen the components, click Add. 5 To add a new service, click New Service, and then enter a name and description for the service. The service is added to the component that you chose in step 1.
vFoglight User Guide In another example, if you create a service called “FX” on the infrastructure that monitors a webservice, you can create a rule to include another infrastructure that is used for extra capacity during peak times. When the other infrastructure for high capacity is used, it shows up in the service. To add a dynamic managed component: 1 From the navigation panel, under Dashboards, click Services > Service Builder.
Working with Services and Alarms Building a Service 113 Adding an Application Tier When you create an application using Application Builder or Service Builder, you specify the application tier that you want to use. In the Service Builder dashboard you can also do this when you build an application. To add an application tier: 1 Click Add for the application topology component for which you want to add a tier. The Applications Tier dialog box appears.
vFoglight User Guide 5 Type a name for the tier and click Create. The name of the new tier is added to the Application Tiers list. 6 Use Find, Clear, and Advanced to locate an application tier. To locate a tier by name and type, click Advanced. You can also use regular expressions. 7 Continue to add tiers to the application. After you have added all tiers, you can then add other components to the tier by following the steps outlined in “Building a Service” on page 110.
Working with Services and Alarms Filtering Alarms 115 To edit a service name: 1 On the Service Builder dashboard, click Edit for the service name you want to change. The Edit Service Descriptions dialog box appears. 2 Change the name and click Update. The service name is changed but the service state is not altered. Editing a Service Description You can change the service description that is displayed when you hover over a service that is listed on a dashboard.
vFoglight User Guide service. If you look at the host alarms none of the alarms apply to the Retail service. As a result, you can use an alarm filter to filter out all host rules. In another example, you can use an alarm filter to ignore the state of a service that appears as unavailable when the file system component for the D: drive fills up. vFoglight is monitoring an application that uses a host for the Siebel database and you want to filter out the Oracle database.
Working with Services and Alarms Filtering Alarms 117 4 Select one or more filtering options: • By Rule—select the By Rule check box and choose a rule to monitor one or more of the nested children added to the service. You can define more than one alarm filter for the same rule. • Alarms—select the state of alarms to include or exclude: - Include: all alarms are excluded except those specified in the include filters. - Exclude: all alarms are included except those specified in the exclude filters.
vFoglight User Guide Figure 9 Deleting an Alarm Filter To delete an alarm filter: 1 Drill down to the component from the Service Builder dashboard and click the Alarm Filters button. 2 In the Alarm Filters dialog, select the filter and click .
Working with Services and Alarms Monitoring System-Wide Alarms 119 The Alarms dashboard has two views that display data for the time range indicated at the top right of the dashboard. For information about changing the time range, see “Time Range” on page 51. • All System Alarms and Changes • Outstanding Alarm(s) for the Entire System All System Alarms and Changes This view contains charts that summarize the alarm and change activity for the current time range.
vFoglight User Guide You can see more detailed information about an alarm by hovering over or clicking a column to display a dwell or a popup. The content of the dwells and popups varies according to the column you choose. For information on working with the different alarm views, refer to “Alarm List” on page 58.
5 Monitoring Agents and Hosts This section describes how to view monitor agents and hosts. Several dashboards are available in vFoglight to help you with this activity. This chapter contains the following sections: Overview....................................................................................................................................122 Viewing Agents..........................................................................................................................
vFoglight User Guide Overview Agent and host dashboards are monitored by Operators (for example, Unix System Operators) whose primary responsibility is availability of those hosts. From these dashboards you can perform the following tasks: • Viewing Agents • Viewing Host Performance • Viewing Host Details Viewing Agents The Agents dashboard lists the agents that are available for each host. It is useful for monitoring from the perspective of hosts and agents.
Monitoring Agents and Hosts Viewing Agents 123 The Monitored Hosts and Agents and the Outstanding Alarms views are displayed. Drilldowns for each of the columns on this dashboard are explained below. Drilldowns for the Agents on All Hosts View Select To display Agent or a host a popup that provides a summary of the host, service, or application. This summary includes the number of alarms by severity, health status, and related links. This is a common view in vFoglight.
vFoglight User Guide You can filter the hosts by clicking Service Selector in the action panel to open the Service Selector dialog. For more information on working with the Service Selector, refer to “Examining Details on a Single Service” on page 105.
Monitoring Agents and Hosts Viewing Host Performance 125 Figure 2 The name of the current host is at the top left of the dashboard. To see data for another host, click Host Selector in the action panel to open the Host Selector dialog, where you can choose another host. Viewing Performance on All Monitored Hosts The Hosts Table dashboard is the best high-level summary of host performance. It summarizes information on alarms and CPU, memory, disk, and network utilization for active hosts.
vFoglight User Guide Figure 3 You can remove one or more of the columns in the table by clicking the edit icon at the right-hand end of the title bar to open a list of columns, where you can de-select the column(s) that you want to remove. You can filter the list of hosts by clicking Host Filter in the action panel to open the Host Filter dialog. Figure 4 You can choose to display all hosts or only active hosts and filter the information from each host by service.
Monitoring Agents and Hosts Viewing Host Performance 127 Figure 5 Drilling Down to Detail Views The dwells in this dashboard are mostly charts, such as the one in the Host Monitor dashboard. This dashboard also has a number of areas from which you can drill down to more detailed dashboards. For example, clicking the Processes button in the CPU view takes you to a dashboard that displays detailed information about CPU utilization and processes for the current host, as shown below.
vFoglight User Guide Viewing Host Details You can view details on: • a single host • a host (in portlet format) Viewing Details on a Single Host The Host Browser dashboard is similar to the Agents browser, except that it shows the agents for only one host at a time. It contains two views: Agents Running on and Outstanding Alarm(s) for . To view details on a single host: • From the navigation panel, under Dashboards, click Hosts > Host Browser. The Host Browser dashboard appears.
Monitoring Agents and Hosts Viewing Host Details 129 The Outstanding Alarms view displayed at the bottom half of the dashboard is a common view in vFoglight. For further information, refer to “Alarm List” on page 58. Viewing Host Details in Portlet Format The Active Hosts Summary dashboard displays information about each active host in a separate view. This dashboard is useful when you have a small number of hosts and want to see a visual summary of them.
vFoglight User Guide
6 Monitoring the vFoglight Management Server The vFoglight Management server is used to perform tasks such as host data sent from agents, run rules, and provides web-based UI access for monitoring servers. The vFoglight Management Server also contains various tools to monitor database schema and data objects and view diagnostic dashboards. This chapter contains the following sections: Overview....................................................................................................................
vFoglight User Guide Overview The vFoglight module contains various tools to monitor schema and data objects as well as to monitor the vFoglight Management Server.
Monitoring the vFoglight Management Server Viewing Logs • To view the list of log messages in this dashboard, click Log Selector dialog select the server. 133 . In the • To download a log, select the appropriate log from the Log Overview dashboard and click to open and view the log messages.
vFoglight User Guide Viewing Performance-related Dashboards vFoglight includes a set of diagnostic dashboards which are useful for analyzing the performance of a vFoglight Management Server as well as diagnosing problems relating to the Management Server, agents, database, etc. The following performance-related dashboards are available: • Overview Tab Displays database activity, data service performance, JVM performance and server load on one dashboard.
Monitoring the vFoglight Management Server Viewing Performance-related Dashboards 135 • Agents Tab Displays a list of agents by type. This dashboard is useful for understanding the agents connected to the management server. Select the Plot feature to view the appropriate agent connectivity. To plot agent connectivity: 1 In the Plot tab, drill-down to the agent type. 2 Select the check box for the agent that you want to plot. Alternatively, click Select All, to view all agent types.
vFoglight User Guide • Connectivity Tab Shows the vFoglight connectivity for the JDBC Connection Pool and the User Session count.
Monitoring the vFoglight Management Server Viewing Performance-related Dashboards 137 • Database Tab Shows database activity such as data Input/Output, database buffer pool, and the number of inserts/deletes. • Java Virtual Memory Tab Contains information on Java Virtual Memory such as usage, initialization, committed, and maximized.
vFoglight User Guide
Monitoring the vFoglight Management Server Viewing Performance-related Dashboards 139 • Topology and Agent Manager Tab Shows the number of topology changes, skipped messages, and total messages. This dashboard is useful for understanding the topology structure relating to agent activity. • Server Load Tab Shows vFMS load metrics and JVM performance.
vFoglight User Guide • Rulette and Topology Tab Shows the number of rulettes and the number of topology objects in the vFoglight Management Server. This dashboard is useful for understanding model complexity. • Messages and Data Tab Highlights whether data and metrics are being processed in time or getting discarded.
Monitoring the vFoglight Management Server Inspecting Object Types 141 • Derivation and Query Tab Shows activity in the derivation and query service such as the number of evaluations, rulettes, errors, and cache performance. Inspecting Object Types Use the Schema Browser dashboard located in vFoglight > Schema to view information about data object types such as check which types are available, search for specific types, understand the relationship between types, and view instances of a particular type.
vFoglight User Guide Figure 1 Viewing a Data Object The Schema Browser dashboard allows you to browse through the vFoglight Management Server connections and view the structure of the database and the schema objects to understand the structure and dependencies of the objects. To view an object: 1 On the navigation panel, under Dashboards, click vFoglight > Schema > Schema Browser. 2 Find the data type in the list.
Monitoring the vFoglight Management Server Cleaning up Data Objects 143 Cleaning up Data Objects The vFoglight Data Management dashboard is useful for inspecting and deleting data objects, and particularly for cleaning up objects that are no longer needed. For instance, if a set of agents is no longer required, the objects created by those agents will still be visible in the user interface.
vFoglight User Guide Selecting Metrics to Compare You can select host metrics in the chart on the vFoglight Data Management dashboard to compare metric data in chart form. To select other metrics to compare: 1 On the navigation panel, under Dashboards, click vFoglight > Servers > vFoglight Data Management. 2 Click a host object in the table to display a popup with additional information, such as the following: 3 Click Select Metrics to Compare.
Monitoring the vFoglight Management Server Selecting Metrics to Compare 145 Adding Other Metrics to the Chart Using the Metric Viewer you can add other metrics to view in a chart. This Viewer also contains a table that lists the start and end times when data was collected and the average for each collection period. To add other metrics to the chart: 1 On the navigation panel, under Dashboards, click vFoglight > Servers > vFoglight Data Management.
vFoglight User Guide 4 To display another metric, select the metric from the drop-down list. For example, interrupts. 5 The selected metrics (i.e. availablePagingSpace and interrupts) displays in the chart.
Monitoring the vFoglight Management Server Viewing Server Metrics 147 Viewing Server Metrics The Management Server Metrics dashboard consists of a tree view and a display area. You can select a server or data object from the tree view and view the metrics of particular objects by drag and drop. To view the vFMS metrics: 1 On the Navigation panel, under Dashboards, click vFoglight > Servers > Management Server Metrics.
vFoglight User Guide For details on viewing charts, see “Tooltips, Dwells, and Popups” on page 50.
Monitoring the vFoglight Management Server Looking at Server Details 149 Looking at Server Details The Management Server View dashboard is useful for examining the performance of vFMS (vFoglight Management Server). You can also use this dashboard to look for root causes of performance problems with vFoglight. To view details of the vFMS: 1 On the Navigation panel, under Dashboards, click vFoglight > Servers > Management Server View.
vFoglight User Guide • JDBC Connection Pool view—shows how many connections are in use at any time. • FSM Database Size view—shows the size of the database. The combination of these five views gives a good overview of the performance of the vFoglight environment. For details on viewing charts, see “Tooltips, Dwells, and Popups” on page 50. Viewing MySQL Database Details The MySQL Database Overview dashboard contains charts that display data about the embedded or external MySQL database.
Monitoring the vFoglight Management Server Viewing Persistence Handler Details 151 2 Consult the views on this dashboard, which display the following information: • Row Operations • Database Buffer Pool Status • Database Data I/O • Database Pare I/O For details on viewing charts, see “Tooltips, Dwells, and Popups” on page 50.
vFoglight User Guide To view details on the Persistence Handler Dashboard: 1 In the navigation panel, under Dashboards, click vFoglight > Servers > Persistence Handler. 2 Consult the views on this dashboard, which display the following information: • Number of rows in the table • Size of the table • Batch insert time • Query time For details on viewing charts, see “Tooltips, Dwells, and Popups” on page 50.
7 Working with Applications This section describes the Applications module dashboard. This chapter contains the following sections: Monitoring an Application ..........................................................................................................154 Building an Application ..............................................................................................................
# vFoglight User Guide Monitoring an Application You use the Application Details dashboard to monitor the details of a single application. It shows the structure of the application (tiers and flows), as well as the alarms for the application and its service impact. Figure 1 The following views appear on the Application Details dashboard: • Tier Overview view contains an icon for each tier. Clicking an icon opens a view with details of that tier and links to related views.
Running H/F 1 Running H/F 2 # • Outstanding Alarms view lists alarm information for the selected application. For a description of this view, see “Alarm List” on page 58. • Service Impact view lists services that may be affected by a problem with the selected application. Building an Application An application is a set of tiers in which each tier contains a set of monitored elements, such as hosts and servers.
# vFoglight User Guide • In the Step Two view, you create tiers and define the flows and components for tiers. • In the Step Three view, you inspect the application. Note A new service is automatically created for a new application. Step 1: Adding Tiers to an Application Adding an application involves creating a set of application tiers that make up the different logical layers of the application. After the tiers are identified and created, they can be linked to show a logical flow of information.
Running H/F 1 Running H/F 2 # Step 2: Creating Tiers, Defining Tier Flows and Tier Components Creating Tiers The following steps describe the procedure to create new tiers. If the tier already exists, you can add the tier to the application. See “Step 3: Adding Tiers to Preview the New Application and Tier Flows” on page 159. To create a tier flow: 1 To create a new tier for the application, in the Step Two view click the Add icon . The Tier Creator dialog box appears. 1 Select the Tier Type (e.
# vFoglight User Guide 2 Click the Add icon beside the tier which the flow. 3 The tier flow is added and appears under Current Flows. 4 Continue to add tier flows for the application if required. Defining Tier Components When defining tier components, you choose the components to add to the selected tier. To define a tier component: 1 In the Step 2 view, choose the tier from the drop-down list . 2 Click Define Tier Components. 3 Drill-down to the component(s) you want to add and click Add component.
Running H/F 1 Running H/F 2 # 4 The component that you added appears under the Current Components list. Step 3: Adding Tiers to Preview the New Application and Tier Flows When you have finished adding tiers to the application, you can preview the new application in the Stepand tier flows in the Step 3 view. To add Tiers to the Application: 1 Under Add a Tier, click Add for each tier(s) you want to add to the new application.
# vFoglight User Guide 3 Click the icon for each tier and choose one of the links to view its monitored hosts and agents, a summary of metrics by host and agent, or a list of its properties. When you have finished building the application, you can check the Services dashboard to confirm that the service that was created for the application is listed in the Categories and Services view.
8 Working with Reports The Reports feature provides the ability to share data outside of vFoglight. In vFoglight, the tasks of report scheduling and report browsing/viewing are separated into the Report Manager dashboard and the Reports dashboard. This chapter contains the following sections: Introducing the Reports Module ................................................................................................162 Supplied Report Templates .............................................................
vFoglight User Guide Introducing the Reports Module Most users can use the Reports dashboard to run and schedule reports; however, the use of the Report Manager dashboard to work with scheduled reports as well as test (preview) report templates, and create a new schedule should be limited to those with advanced operator permissions. You can create reports based on: • Pre-defined, standard reports—out-of-the-box templates for a high-level, overview perspective of the data.
Working with Reports Introducing the Reports Module 163 • All—displays all available reports. The Module column indicates the module in which the report was defined. • The upper right pane displays the Scheduled Reports view with the scheduled reports that have been created on the basis of the template. • The Name, Template, and Schedule columns for each scheduled report is listed. Click on a template or schedule to view details. • The User column lists who created the report.
vFoglight User Guide Reports Dashboard The Reports dashboard is available to Operators and lists the reports which have been generated. You can sort the list according to date, scheduled report, size, template, schedule, or message. The Reports dashboard has the same view as the Generated Reports area that is in the Report Manager dashboard, except that the Reports dashboard shows all reports that were generated in the Generated Reports view.
Working with Reports Supplied Report Templates 165 vFoglight contains a number of pre-defined, overview type reports based on default templates that you can use as they are or edit to meet your requirements. Each one serves a particular purpose however, there are multiple report templates that have the same expected inputs. The predefined report templates allow you to quickly generate reports with the option of setting and changing the values in the report inputs.
vFoglight User Guide
Working with Reports Supplied Report Templates 167 Report Inputs Report Input Description of Values timeRange Specify a period of time to report from. TimeRange for a metric observation can be specified in various ways, but it is always composed of a range of date-time objects, and a granularity. Select: • TimeRange Type: Choose one: - Last N (to display the time range for the last ) For example, last 2 months.
vFoglight User Guide Report Input Description of Values topology objects Required. Use the Topology layout to define different views for up to four zoom levels of combinations to display a tree of objects descending from a defined Root Object, which is either: • Data (for a single object of that data type) • List (specifying a list of objects for that data type) Select an object by navigating to the data node to find the data source for the object.
Working with Reports Supplied Report Templates 169
vFoglight User Guide Report Inputs Report Input Description of Values timeRange Specify a period of time to report from. TimeRange for a metric observation can be specified in various ways, but it is always composed of a range of date-time objects, and a granularity. Select: • TimeRange Type: Choose one: - Last N (to display the time range for the last ) For example, last 2 months.
Working with Reports Supplied Report Templates 171 Report Input Description of Values maxHosts Returns a list of objects representing the maximum hosts. Choose either: • Integer—enter an integer value • Data—displays a tree of objects descending from a defined Root Object, for a single object of that data type. Drill-down to the object and select a node. • Query Selection—uses WCF queries that are similar to SQL queries to select a subset of information in a data source.
vFoglight User Guide Report Inputs Report Input Description of Values nMonths Type an integer value to denote the number of months. fsmService Returns a list of objects representing the FSM service by using one of the following: • Data—displays a tree of objects descending from a defined Root Object, for a single object of that data type. Drill-down to the object and navigate to the data node to find the data source for the object.
Working with Reports Supplied Report Templates 173 Report Inputs Report Input Description of Values nMonths Type an integer value to denote the number of months. fsmService Returns a list of objects representing the FSM service by using one of the following: • Data—displays a tree of objects descending from a defined Root Object, for a single object of that data type. Drill-down to the object and navigate to the data node to find the data source for the object.
vFoglight User Guide Physical Host - Network Utilization Monthly Summary Report Provides a monthly summary of host network utilization.
Working with Reports Supplied Report Templates 175 Report Inputs Report Input Description nMonths Type an integer value to denote the number of months. fsmService Returns a list of objects representing the FSM service by using one of the following: • Data—displays a tree of objects descending from a defined Root Object, for a single object of that data type. Drill-down to the object and navigate to the data node to find the data source for the object.
vFoglight User Guide Report Inputs Report Input Description timeRange Specify a period of time to report from. TimeRange for a metric observation can be specified in various ways, but it is always composed of a range of date-time objects, and a granularity. Select: • TimeRange Type: Choose one: - Last N (to display the time range for the last ) For example, last 2 months.
Working with Reports Supplied Report Templates 177 Report Input Description maxHosts Returns a list of objects representing the maximum hosts. Choose either: • Integer—enter an integer value • Data—displays a tree of objects descending from a defined Root Object, for a single object of that data type. Drill-down to the object and select a node. • Query Selection—uses WCF queries that are similar to SQL queries to select a subset of information in a data source.
vFoglight User Guide Figure 1
Working with Reports Supplied Report Templates 179 Report Inputs Report Input Description timeRange Specify a period of time to report from. TimeRange for a metric observation can be specified in various ways, but it is always composed of a range of date-time objects, and a granularity. Select: • TimeRange Type: Choose one: - Last N (to display the time range for the last ) For example, last 2 months.
vFoglight User Guide Report Input Description currentTime Use the calendar to specify the current time of the report. Physical Host Load Summary Report The Hosts Summary report provides a host summary for the CPU, memory, file system, and network usage.
Working with Reports Supplied Report Templates 181 Figure 2
vFoglight User Guide Report Inputs Report Input Description of Values timeRange Specify a period of time to report from. TimeRange for a metric observation can be specified in various ways, but it is always composed of a range of date-time objects, and a granularity. Select: • TimeRange Type: Choose one: - Last N (to display the time range for the last ) For example, last 2 months.
Working with Reports Supplied Report Templates 183 Report Input Description of Values maxHosts Returns a list of objects representing the maximum hosts. Choose either: • Integer—enter an integer value • Data—displays a tree of objects descending from a defined Root Object, for a single object of that data type. Drill-down to the object and select a node. • Query Selection—uses WCF queries that are similar to SQL queries to select a subset of information in a data source.
vFoglight User Guide Figure 3 Figure 4
Working with Reports Supplied Report Templates 185 Figure 5 Figure 6
vFoglight User Guide Report Inputs Report Input Description of Values timeRange Specify a period of time to report from. TimeRange for a metric observation can be specified in various ways, but it is always composed of a range of date-time objects, and a granularity. Select: • TimeRange Type: Choose one: - Last N (to display the time range for the last ) For example, last 2 months.
Working with Reports Supplied Report Templates 187 Report Input Description of Values maxHosts Returns a list of objects representing the maximum hosts. Choose either: • Integer—enter an integer value • Data—displays a tree of objects descending from a defined Root Object, for a single object of that data type. Drill-down to the object and select a node. • Query Selection—uses WCF queries that are similar to SQL queries to select a subset of information in a data source.
vFoglight User Guide
Working with Reports Supplied Report Templates 189 Report Inputs Report Input Description of Values timeRange Specify a period of time to report from. TimeRange for a metric observation can be specified in various ways, but it is always composed of a range of date-time objects, and a granularity. Select: • TimeRange Type: Choose one: - Last N (to display the time range for the last ) For example, last 2 months.
vFoglight User Guide Report Input Description of Values maxHosts Returns a list of objects representing the maximum hosts. Choose either: • Integer—enter an integer value • Data—displays a tree of objects descending from a defined Root Object, for a single object of that data type. Drill-down to the object and select a node. • Query Selection—uses WCF queries that are similar to SQL queries to select a subset of information in a data source. • Invoke Function—invokes a function run-time value.
Working with Reports Supplied Report Templates 191 Report Inputs Report Input Description of Values timeRange Specify a period of time to report from. TimeRange for a metric observation can be specified in various ways, but it is always composed of a range of date-time objects, and a granularity. Select: • TimeRange Type: Choose one: - Last N (to display the time range for the last ) For example, last 2 months.
vFoglight User Guide Working with Reports This section describes the functions that are available to work with reports such as run a report, schedule a report, test a report template, and add a new schedule to the default report schedules list. The tasks of running a report and scheduling a report are available in both the Reports dashboard and Report Manager dashboard. The Test and New Schedule buttons are only accessible in the Report Manager dashboard.
Working with Reports Working with Reports 193 a Report Template—click Please click here to select template and drill-down to the report template on which to base your report. To help you focus on the source of the report, when choosing a report you can select by module, role or all. • Click the report template you want to use. The dialog box populates with the data for the template you selected.
vFoglight User Guide enter a list of comma-separated email addresses however, you must restart the vFoglight Management Server. Note To send reports to email recipients from the Report Manager, you must configure the e-mail server by enabling the “Email Reports Sample” rule. By default, this rule is disabled. When enabling the rule you may also have to edit the “Fire” condition to filter the reports before sending them to email recipients.
Working with Reports Working with Reports 195 If you chose this option, when clicking Schedule Report, the Create Scheduled Report populates automatically with data for the selected template. • Choosing Schedule Report from the top pane of the Reports dashboard or Reports Manager dashboard. If you chose this option you will need to click Please select report template.
vFoglight User Guide Drill-down to the report template on which to base your report. Select a template on which to base your report from the Report Template column. To help you focus on the source of the report, choose a report based on their classification: By Module, By Role, or All. If you choose this option, the dialog automatically populates with the data for the template you selected.
Working with Reports Working with Reports 197 • Name—type a unique name for the report. This is a required value. Note If you are using a template in which the host name is required, you must enter the host name in the text field exactly as it appears at the top of the reports. • Schedule—choose when to run the report. For example, choose “End of day” to run the report on an end-of-day schedule. To create a schedule that is not in the list, see “Adding a New Schedule” on page 198.
vFoglight User Guide To test a selected report template: 1 In the navigation panel under Dashboards, click Reports > Report Manager. 2 Create a report based on a pre-defined or custom template. For a pre-defined report template, see “Supplied Report Templates” on page 164. For custom report templates, see “Creating a Custom Report Template” on page 213. 3 Click Test. A test dialog box with the context inputs for the selected report appears.
Working with Reports Working with Reports 199 4 Click Next to go to the Details of Schedule page. 5 Set the Start Date using the fields and drop-down menu, or click the browse button ( ) to open a calendar where you can select the start date. 6 Enter a Start Time and End Time, or select the Whole Day check box if you want the schedule to cover the whole day. The Whole Day check box may or may not be available depending on the Recurrence Pattern you select.
vFoglight User Guide 9 Click Add to create the schedule. Managing Scheduled Reports After you scheduled a report, the report appears in the Scheduled Reports view in the Reports Manager dashboard where you can edit, copy, enable/disable, and delete scheduled reports. For information on creating a report with a schedule, see “Scheduling a Report” on page 194. Editing a Scheduled Report You can change any or all the parameters of a scheduled report.
Working with Reports Managing Scheduled Reports 201 2 Make your changes (see “Supplied Report Templates” on page 164 to create a report using the report template list. You have the option to leave the report values as is or tailor the report by specifying the input values according to your business requirements. 3 Click Save to save your changes. Copying a Scheduled Report You can create a new scheduled report by copying an existing one and changing one or more of the parameters.
vFoglight User Guide 2 Make your changes (see “Supplied Report Templates” on page 164 for details about the parameters). 3 Click Create to create a copy of the report. Disabling/Enabling a Scheduled Report When a scheduled report is created, it is enabled by default. You can disable a report, which means that it will not run at the scheduled time until it is enabled again.
Working with Reports Managing Scheduled Reports 203 Deleting a Scheduled Report When you delete a scheduled report, any generated reports that are associated with it are also deleted. To delete a scheduled report: 1 In the Scheduled Reports with Filter view of the Report Manager dashboard, select the check box(es) beside the report(s) that you want to delete. 2 Click Manage > Delete.. 3 In the popup menu, click Delete. A dialog prompts you to confirm the deletion. 4 Click Delete.
vFoglight User Guide 3 Enter the criteria for the filter based on criteria such as a report name, template, schedule (such as “day” for end of day reports), or enabled (True or False). 4 Click Find to output the reports that match the filter condition. 5 If you want to apply another filter, click Clear and repeat steps 2 to 3. Managing Generated Reports Reports that have generated appear in the Generated reports view in both the Reports dashboard and Report Manager dashboard.
Working with Reports Managing Generated Reports 2 To view the PDF output of the report, click the PDF link next to the report. 3 Click View Report. The PDF output of the report is displayed.
vFoglight User Guide Applying a Filter to Generated Reports Creating a filter on a generated report helps you find reports based on criteria such as the report name, template, schedule or the date range for which the report was run. To apply a filter to a generated report: 1 In the navigation panel, under Dashboards, click Reports > Report Manager. If you do not have access to the Report Manager dashboard, in the navigation panel, under Dashboards, click Reports > Reports.
Working with Reports Managing Generated Reports 207 • If you select the Earliest Available check box, enter the period end date in the To fields. • If you select the Current Date check box, enter the start date in the From fields. 4 To have the report filter generate manually, select the True check box. 5 Click Find to output the reports that match the filter condition. 6 If you want to apply another filter, click Clear and repeat steps 2 to 5.
vFoglight User Guide Scheduling a Generated Report You can re-schedule or add another schedule to a report that has generated. To schedule a generated report: 1 In the navigation panel under Dashboards, click Reports > Report Manager. If you do not have access to the Report Manager, in the navigation panel, under Dashboards, click Reports > Reports. 2 In the Generated Reports view, click the check box beside the report(s) that you want to schedule.
Working with Reports Managing Generated Reports 209 2 To edit the image on the top left of the report, click Configuration > Definitions on the left-hand panel. In the content page, expand Reports and click Canned Reports. From the list of Views in the lower left-hand pane, select CPU Utilization (Rolling N Month Summary). 3 Scroll down on the right-hand pane for the CPU Utilization (Rolling N Month Summary) view and click the hyperlink for the embedded view Header: Logo, Title, Time Range.
vFoglight User Guide The Header Logo view opens. 4 To upload the image you want to use for your reports, return to the lower left- hand pane and click the Files tab. Click Add and then click Browse... to upload the image.
Working with Reports Managing Generated Reports 211 5 Click the Header: Logo, Title, Time Range tab. Click Edit and select the Configuration tab. 6 Select the drop-down icon next to the Value for the row Left Image. Select the Image Reference link.
vFoglight User Guide 7 In the pop-up window, locate the image you just uploaded. It should be located under Reports > Canned Reports. 8 Click Save to keep this change and the Header: Logo, Title, Time Range view. 9 Select the tab showing CPU Utilization (Rolling N Month Summary) and click the Test PDF button. The new report appears with the image you recently uploaded. Note Most of the reports share 1 or 2 header views.
Working with Reports Working with Custom Reports 213 Working with Custom Reports If you have the appropriate permissions, the Report Manager dashboard enables you to create a custom report at a more specific level than what is available on the set of supplied report templates. By creating your own report templates you can customize the content and presentation of a report. Creating a Custom Report Template The process of creating a custom report is similar to creating a dashboard.
vFoglight User Guide report. For example, choosing "Operator" publishes your dashboard to everyone with the Operator role. • Relevant Role—this option is only valid for super users who may have multiple roles. For example, a Java administrator who also has an operator role can choose the Cartridge Developer role to restrict the Operator role from accessing the report. • Allowed Role—determines which user role is allowed to see the dashboard.
Working with Reports Working with Custom Reports 215 in the Report Manager, where it can be scheduled. To schedule the report, see “Scheduling a Report” on page 194. To run and generate a report without scheduling it, see “Running a Report” on page 192. If you want to preview the report template without scheduling or generating the report, see “Adding a New Schedule” on page 198.
vFoglight User Guide 3 Click in a text box to add text, or click Page Number, Report Title, Current Time, or Time Range to add those variables to a box. You can add both text and variables to a box. 4 If you want to add your own graphic to the report, click the icon to the right of Select an Image to open the Select an Image dialog. 5 From the drop-down selector for the left image, navigate to an image that was previously uploaded and click OK.
Working with Reports Working with Custom Reports 217 To delete a report: 1 Select the report that you want to delete from the list under My Dashboards. 2 Click Delete this Report in the Actions panel. A confirmation dialog box appears. 3 Click Delete to confirm the deletion. Deleting a report removes the report from the My Dashboards view and the Report Template list. For details about how to work with charts in a dashboard, see “Working with Charts” on page 78.
vFoglight User Guide c To make text appear in a tooltip when you hover over the report name in the navigation panel, type a description of the report in the Context Help text box. 4 Click OK. 5 Click the Data tab. 6 Drag a Host object (Windows_Host) into the Parameterized Input section.
Working with Reports Working with Custom Reports 219 7 Drag host elements (i.e. VirtualMemory) from the data or input trees of the Parameterized Input section onto the display area to the left. 8 On the navigation panel, under Dashboards, click Reports > Report Manager. Notice that the report is added to the list of report templates. 9 From the Report Template, choose the report you created. 10 To test (i.e. preview) your report template before generating the report.
vFoglight User Guide 12 Enter the report inputs for the time range and Windows host. This step is optional. 13 Click Create to schedule the report. 14 After an hour, the report appears under Generated Reports view. 15 Click pdf to view the generated report. Example: Create an SLA Availability Report In the following example workflow, you will create a report showing SLA availability data for the workweek from 8 am to 8 pm.
Working with Reports Working with Custom Reports To create a new schedule: 1 In the Report Manager dashboard, click Add New Schedule. 2 Create the schedule. Type a Schedule Name and Description/Comments. 3 Click Next. 4 Add the schedule details. 5 Click Add. 6 View the details of the schedule.
vFoglight User Guide Step 2: Create the report To create the report: 1 In the navigation panel under Dashboards, click Reports > Report Manager. If you do not have access to the Report Manager, in the navigation panel, under Dashboards, click Reports > Reports. 2 Click the Create Report icon or click Create Report in the action panel. 3 Type a report Name. 4 If you want to enable this report to be included in other reports, click the Allow this report to be included in another report checkbox.
Working with Reports Working with Custom Reports 223 6 You can enter a description of the report in the Context Help text box. This text appears in a tooltip when you hover over the report name in the navigation panel. 7 Click OK. 8 Click Set metric chart defaults. 9 In the Chart drop-down choose Stacking Area and click OK. 10 Create two derived metrics for a specific FSMServiceLevelPolicy: • Outage - every minute, if previously available and currently not, return 1.
vFoglight User Guide 6 Click Create to schedule the report. 7 Check that the report appears under Generated Reports with Filter on Friday after 8:00 pm. 8 Click PDF to view the generated report.
9 Working with Data and Data Sources In vFoglight you can create custom views using the framework that is available in the Configuration module. This type of work is primarily focused on those users who are advanced dashboard designers. This chapter contains the following sections: Overview....................................................................................................................................226 Data Dashboard ......................................................................
vFoglight User Guide Overview The dashboards listed under the Configuration module include the following: • Data Dashboard • Data Sources Dashboard • Definitions • User Preferences The Definitions dashboard is where you create and edit views. For information about these functions, see the Web Component Guide and the Web Component Tutorial. The options in the User Preferences page are described under “User Preferences” on page 36. This section briefly describes the Data and Data Sources dashboards.
Working with Data and Data Sources Data Dashboard 227 Figure 1 You can expand the nodes in the left-hand pane and follow a path to find objects. For example, you can find a Host object by expanding the Hosts object, expanding All Hosts, then finding the Host of interest (as in the above screen). The right-hand pane is a display area. You can choose from a number of views, which are listed under Views in the action panel. The most useful view for inspecting an object is the Property Viewer.
vFoglight User Guide A metric is a type of observation that is concerned with numeric observations. For example, the CPU usage of a host. All observation objects have the following properties: • latest—the value of the last recorded sample. • current—the same as the latest value except if the latest value is considered stale (not fresh), the current value is considered null. • history—contains a historical list of values for the selected time range.
Working with Data and Data Sources Data Sources Dashboard 229 Data Sources Dashboard The Data Sources dashboard is where you choose a data source for vFoglight. The default (and only current) option is the foglight-5 data source. Click a data source to display its ID, name, and topology and UI query service JNDI names. To display the Data Sources dashboard: • From the navigation panel, under Dashboards, click Configuration > Data Sources. The Data Sources dashboard appears.
vFoglight User Guide
Index Index an application 156 A about vFoglight 10 Acknowledge Until Normal 72 acknowledging an alarm 63 action panel 32 adding logo to reports 208 new schedule to reports 198 advanced setting 38 Agents dashboard 122 alarms acknowledging 63 clearing 65 filtering 115 notes 70 view, filtering 62 Alarms dashboard 118 alarms view hiding columns 63 application previewing tier flows 159 removing 160 Application Builder dashboard 155 Application Detail dashboard 154 availability graphs 107 B bookmarks 43 chang
vFoglight User Guide printing 216 customizer 57 D dashboards default 49, 93, 121, 131, 153, 161, 225 Data dashboard 226 Data Sources dashboard 229 data sources settings 38 data tab 35 default dashboards 49, 93, 121, 131, 153, 161, 225 Agents 122 Alarms 118 Application Builder 155 Application Detail 154 Data 226 Data Sources 229 Host Browser 128 Host Resource 124 Hosts Table 125 Management Server Metrics 147 Management Server View 149 MySQL Database Overview 150 Persistence Handler Overview 151 Report
Index exporting data, from charts and tables 57 F filter by role 33 filtering alarm notes 73 alarms 115 by roles 33 generated reports 203, 206 footer 35 G general tab 34 generated report, deleting 207 grouping, metrics 87 H help tab 34 historical value 228 home page 39 Host Browser dashboard 128 Resource dashboard 124 Hosts Table dashboard 125 I M Management Server Metrics dashboard 147 View dashboard 149 Management Server Performance Summary Report 177 managing scheduled report 194 metric viewer 145
vFoglight User Guide PDF export 57 Persistence Handler Overview dashboard 151 Physical Host - CPU Utilization Monthly Summary Report 171 Physical Host - Memory Utilization Monthly Summary Report 172 Physical Host - Network Utilization Monthly Summary Report 174 Physical Host Load Summary Report 180 Physical Host Performance Details Report 183 Physical Host Performance Summary Report 187 Physical Host Utilization Summary - Last 10 Days Report 175 portlets 82 previewing new application 159 report templa
Index testing report template 197 text conventions 13 themes 39 tier creating 157 defining application flows 157 defining components 158 time range 37, 51 calendars 55 date and time fields 55 diagnostic 53 freezing, freezing time range 52 granularity 55 precision control 55 zonar 54 time ranges custom 51 standard 51 time zone setting 37 U user preferences, setting 36 V vFoglight Data Management dashboard 143 overview 29, 41 viewing a bookmark 44 views tab 34 W Welcome page 30 Z zooming, into charts 80
