====== The Opsview Quick Start Guide ======
This document will introduce you to using Opsview.
===== Prerequisites =====
  * Opsview software [[opsview3.0:#installation_and_initial_configuration|installed]]
  * A [[opsview3.0:platforms#supported_web_browsers|web browser]]
  * A host in your network to monitor

We assume your Opsview server is at http://opsviewserver

===== Login =====
Goto http://opsviewserver. This will bring up the login screen. The default user is:

  * Username: admin
  * Password: initial

{{:opsview3.0:login_page.png|Login Page}}

===== Screen Elements =====
There are 3 main areas: the main content, the side navigation and the status bar.

{{:opsview3.0:hh_sections.png|Screen Elements}}

==== Main Content ====
This will change dependening on the page being requested.

==== Side Navigation ====
The side navigation holds menu options which are expandable. Click on the name to expand out. Each link will take you to a different part of Opsview. The Search Host box provides a quick way of accessing a specific host in Opsview. Type here an ''o'' here and an autocomplete list will appear. 

Under User -> Preferences, you can change your password and other attributes based on your [[opsview3.0:access|access role]]. If you click on the Version text, it will show you the build number for the version of Opsview installed.

==== Status Bar ====
The status bar holds three pieces of information:
  * The Server Status which will be:
    * green if everything is okay
    * yellow if Opsview is reloading
    * red if Opsview is not running
  * The Configuration Status will be:
    * green if all the configuration is applied to the running system
    * yellow if there are configuration changes pending an Opsview reload
    * red if there was a failure in the last Opsview reload
  * The refresh counter, which will only display for pages that have an automatic refresh, will count down until the next refresh. You can click on the //Refresh// text to force an immediate refresh 



===== Status Views =====
==== Hostgroup Hierarchy ====
The initial view is called Hostgroup Hierarchy. This displays a top level view of all your hosts and services, organised in a hierarchy based on host groups.

{{:opsview3.0:hh.png|Hostgroup Hierarchy}}

This allows you to drill down and find any particular service that may have a problem.

You can click on the various headings or statuses to get a filtered view of the hosts and services.

There is the concept of Handled and Unhandled. Handled problems are ones that have been acknowledged or have scheduled downtime. This allows you to see problems that you know about versus problems that you don't.

Next to most objects is the popup menu button. This will popup and show extra options available.

=== Host Detail ===
When you drill down, you can see a summarised view at the host level.

{{:opsview3.0:hh_host_detail.png|Host Detail}}

=== Service Detail ===
You can also see a service detail view which shows you the results of the service checks.

{{:opsview3.0:hh_service_detail.png|Service Detail}}

=== Performance Graphs ===

You can click on the graph to get performance graphs for that particular service.

{{:opsview3.0:perf_graph.png|}}

==== Viewport Summary ====
Viewports are a way of seeing a small set of services, for public access.

The viewport pages are available at http://opsviewserver/viewport. This gives you a summarised state of all the services in the detailed viewport.

{{:opsview3.0:viewport_summary.png|Viewport Summary}}

You define viewports based on keywords for [[opsview3.0:host#keywords|hosts]] and service checks.

=== Viewport Detail ===

Click on the viewport name to get a list of all the services associated in that viewport.

{{:opsview3.0:viewport.png|}}

The URLs under http://opsviewserver/viewport do not require login access.

==== Alerts views ====
Under the Alerts menu section, you can filter the alerts based on various filters. 

{{:opsview3.0:alert.png|}}

=== Mass Acknowledgements ===
You can click on the Mass Acknowledgements link to get to a special screen where you can [[opsview3.0:acknowledgements#mass_acknowledgements|acknowledge]] lots of hosts and services in one action.

{{:opsview3.0:mass_acks.png|}}

===== Configuration =====
==== Listing Hosts ====
From the Configuration -> Hosts link, you will get a list all the hosts in Opsview.

{{:opsview3.0:host_list.png|}}

You can delete hosts (when possible) or clone hosts with the buttons on the left. Click on the name of the host to edit.

==== Add a New Host ====
Under Configuration -> Hosts, there is an option to //Create new Host// in the main content area.

{{:opsview3.0:host_edit.png|}}

There are other tabs, such as Monitors and SNMP, but these tabs are not available until you enter the initial information.

Fill in the information about the host. If you hover over the field names, an underline will appear: clicking on them will take you to the contextual help in this documentation wiki.

=== Associating Service Checks to a Host ===
When you click Next, you can then enter the list of Monitors to associate with this host.

{{:opsview3.0:host_edit_monitors.png|}}

Just click the service checks that you want to associate to this host.

If you want to run checks that need access to the remote host, you will need to install an [[opsview3.0:agents|agent]].

When you submit your changes, you will be returned to the host list page. The host that you have just changed will turn yellow and the Configuration Status light at the bottom will be yellow.


==== Configure Service Checks ====
The Configuration -> Service Checks link will show you a list of all the service checks. These are displayed with headings based on their service group.

{{:opsview3.0:servicechecks_list.png|}}

There are 4 different types of service checks you can create:
  * Active check, based on running a Nagios plugin
  * SNMP Polling, for running a check against a specific OID in the SNMP tree for a host
  * Passive check - this is left to you to setup sending results to Opsview
  * SNMP traps, for raising alerts based on snmp traps received


==== Add a Host Template ====
The Configuration -> Host Templates link will show a list of all the host templates. A host template holds 2 sets of information:
  * a list of service checks 
  * a list of management URLs

=== Service check monitors ===
The service checks are used instead of defining the service checks manually on a host. You can layer on the host templates for a host instead, thus allowing you to make a single change in one host template that can effect lots of hosts at the same time. 

=== Listing all services for a host ===

You can list all the services, and which template they came from, by clicking on a host and listing all the service checks.

{{:opsview3.0:management_url.png|Popup menu with number of service checks}}

This will then resolve all the host templates to give a list of services that would be defined for this host.

{{:opsview3.0:resolve.png|Resolving list of services for a host}}

=== Management URLs ===
The management URLs provide a way of creating a URL that can be accessed for the host.

For the opsview host, there is an SSH url, so clicking on this will tell your browser to run the ''<nowiki>ssh://</nowiki>'' protocol. You need to configure your browser to take the correct action.

{{:opsview3.0:management_url.png|Popup menu for management URLs}}

==== Add a New Contact ====
Contacts act as users of Opsview and also define methods of receiving notifications.

The Configuration -> Contact link will take you to the list of contacts for Opsview.

You can create a new contact and set their password. Administrators can change what hosts or services a contact is allowed to see or act upon based on the role and the access controls.

{{:opsview3.0:contact_edit.png|Contact Edit}}

==== Reloading Opsview ====
Changes made to Opsview are batched. To apply the changes, goto Server -> Reload or you click on the Configuration Status light to get to the Reload page.

{{:opsview3.0:reload.png|Opsview Reload Page}}

When you select //Reload configuration//, Opsview will recreate the Nagios configurations, synchronise with any distributed slaves, validate the configuration and tell Nagios to reload.

Congratulations! You're on your way to monitoring your systems!