Welcome to docs.opsview.com

Differences

This shows you the differences between two versions of the page.

opsview-mobile-android [2012/04/30 15:38]
127.0.0.1 external edit
opsview-mobile-android [2015/10/14 08:38] (current)
tvoon
Line 1: Line 1:
-===== Opsview Mobile for Android =====+====== Opsview Mobile for Android (v2.0) ======
==== Introduction ==== ==== Introduction ====
-Opsview Mobile for Android is a native mobile application for the [[http://www.android.com/|Android]] platform that gives you on-the-go access to live monitoring data from your [[http://www.opsview.com|Opsview]] system.  It uses the Opsview [[:opsview-community:restapi|REST API]] to retrieve the status data from Opsview.+Opsview Mobile for Android is a native mobile application for the [[http://www.android.com/|Android]] platform that gives you on-the-go access to live monitoring data from your [[https://www.opsview.com|Opsview]] system.  It uses the Opsview [[:opsview-latest:restapi|REST API]] to retrieve the status data from Opsview.
==== Pre-requisites ==== ==== Pre-requisites ====
-  * A device running the Android operating system, version 2.1 or later (2.2 for "install to SD card" support) +  * A device running the Android operating system, version 4.1 or later. 
-  * Opsview 3.13.0 or later+  * Opsview Core/Pro/Enterprise 3.13.0 or later
==== Installation ==== ==== Installation ====
Line 16: Line 16:
{{:opsview-mobile-android:opsview-mobile-android-qr.png|}} {{:opsview-mobile-android:opsview-mobile-android-qr.png|}}
-==== Views ==== 
-The following views are available within the application.+You can add push notifications to Opsview 3.14.X, 4.0.X, 4.1.0 and 4.1.1 by following instructions on [[opsview-mobile-android:custom_setup|this page]].
-=== Settings ===+==== List of Features ====
-When you open the application for the first time, the Settings view is shown and you will be able to enter the settings for your Opsview system.  To return to the Settings at any time, navigate to the Hostgroup Hierarchy view, press 'Menu' and select 'Settings'.+  * View Keywords, Hostgroups, Hosts & Services. 
 +  * Android Push Notifications. 
 +  * View, add and remove downtime on hosts and services. 
 + * Acknowledge host and service problems. 
 +  * Run rechecks on hosts and services.  
 +  * View events and graphs. 
 +  * Configure the application to your needs.
-{{:opsview-mobile-android:settings-cropped.png|}}+==== Quick Start Guide ==== 
 + 
 +In the settings view of the app, under the system authentication heading, enter your Opsview username and password and under the Opsview System Connection, enter the address of the Opsview system that you are connecting to. 
 + 
 +That's it! You should be good to go.  
 + 
 +==== App Configuration ==== 
 + 
 +When you open the application for the first time, the Settings view is shown and you will be able to enter the settings for your Opsview system.  To return to the Settings at any time, navigate to the main view, press 'Menu' and select 'Settings'. 
 + 
 +== Opsview System Authentication == 
 +In this section you can enter the username and password you use to connect to Opsview.
-  * **API URL** - The URL you use to access your Opsview system. Examples might be http://opsview.mycompany.com/ or https://www.mycompany.com/opsview \\ 
  * **Opsview Username** - The username you use when logging into Opsview (or the account you wish to use with Opsview Mobile, if different) \\   * **Opsview Username** - The username you use when logging into Opsview (or the account you wish to use with Opsview Mobile, if different) \\
  * **Opsview Password** - The password associated with the above username \\   * **Opsview Password** - The password associated with the above username \\
-  * **Request Timeout**  - The length of time the application should wait for a response from Opsview before giving up.  The default of 5 seconds should typically be sufficient, but you may need to increase this value if you often use the application over a slow link (e.g. GPRS) or experience frequent timeout messages. 
-To exit this view, press 'Back'.+== Opsview System Connection == 
 +Here you can enter the URL of the Opsview system that you wish to connect to. Examples might be http://opsview.mycompany.com/ or https://www.mycompany.com/opsview \\
-=== Hostgroup Hierarchy ===+If you have not entered http in the address than http will be appended after entering your Opsview URL.
-This is the default view when opening the application, once you have configured your settings.+You can use the SSL option for https connections if your Opsview system is configured to do so. If you enter https in front of your opsview URL the SSL option will be set to enabled.
-{{:opsview-mobile-android:hh-cropped.png|}}+In this sub heading you'll find options for configuring your system for HTTP Authentication. These aren't required unless you have HTTP Authentication setup in front of your Opsview installation, i.e when going to your Opsview system you are presented with a screen like this:
-To the left of each hostgroup name are four colour coded squares which give a summary of the state of hosts and services in that hostgroup.  The first column represents 'handled' states (denoted by the 'H' column header) and the second column represents 'unhandled' states.  The top row refers to hosts, and the bottom row refers to services, as indicated by the 'Hst' and 'Svc' titles to the left.  Finally, the colour of the square indicates the 'highest' (most severe) state of any objects (hosts or services) in that category, whilst the number shows the total number of objects.  Below is an example to illustrate this.+\\
-In the above screenshot, in the 'Production Systems' hostgroup the following information is being shown:+{{:opsview-mobile-android:http-auth-example.png|}}
-  * There are 16 handled hosts.  All of these hosts are in an up state. +\\
-  * There is 1 host in an unhandled state, and this host is down (indicated by the red background) +
-  * There are 153 handled services.  The 'highest' state of any of these 153 services is critical. +
-  * There is 1 service in an unhandled state.  The state of this unhandled service is 'Unknown' (indicated by the orange background)+
-To refresh this view, press 'Menu' and then select 'Refresh'.+Before you reach the Opsview login screen, which will look something like this
 + 
 +\\ 
 + 
 +{{:opsview-mobile-android:opsview-login-example2.png|}} 
 + 
 +\\ 
 + 
 +== Push Notifications == 
 +Here you can enable or disable push notifications. The application will not register with the push servers unless you have enabled push notifications and if you turn push notifications off, any messages received will not be displayed. However your Android device will still be receiving data so it’s best to stop the notifications from sending on your Opsview system as well. 
 + 
 +In this sub heading you will also find settings for push username and password. These details will be an account that you can log onto www.opsview.com with. This is so we can uniquely identify devices and systems to send notifications from one to the other.  
 + 
 +If you have entered your push details incorrectly then you will be notified once push starts to connect, which will be once you return to the main section of the application. Please note that you should enter your username, not your email address. Logging into www.opsview.com and checking your account should tell you what your username is.  
 + 
 +== App Configuration (Sub-Heading) == 
 +The following is few brief words on the available settings and what they do.  
 + 
 +  * **Confirm Acknowledgements** – This option when enabled will ask the user if they want to confirm acknowledgements before submitting them.  
 +  * **Pagination Values** – This refers to the number of services that will load each call. Default value is around 2000 services after which you can scroll to the bottom and select “Load More” to load the next 2000 services.  
 +  * **Enable Caching** – This will enable the storing of data for an amount of time before refreshing the information from your Opsview. By default this will be set to on, turning this off will mean each tab switch the old data will be thrown away and the new data will be retrieved regardless of the timeout.  
 + 
 +Please note that in the application the api will only be polled when the user is interacting with the application i.e when a user loads a new screen or switches to another tab. No data is used in the background. 
 + 
 +  * **Cache Timeout** – The time between refreshing the data in the view.  By default this is around 60 seconds. 
 + 
 +== App Configuration v2.1 and above == 
 + 
 +Version 2.1 of the android application has the following extra settings:  
 + 
 +  * Hostgroup Drilldown - Here you can configure the application to show either hosts or services once a hostgroup is selected.  
 +  * Default start tab - Here you can configure the default tab that the application shows when the application is started.  
 +  * Hostgroups minimal view - This option will enable a more compact view for hostgroups. 
 + 
 + 
 +\\ 
 + 
 +==== Navigation ==== 
 + 
 +Navigation through the application is provided using a tabbed interface. The outer tabs will allow you to select Keywords, Hostgroups, Hosts and Services. You can scroll left and right on the tabs if your phone cannot see them all in one go.   
 + 
 +{{:opsview-mobile-android:out-tab-example.png|}} 
 + 
 +\\ 
 + 
 +Inner or sub tabs like these, will allow you to filter the view. Pressing unhandled will show you the list of unhandled items in the view that you are currently in. 
 + 
 +The error tab will show you anything that has a problem, i.e the following states for services “Critical, Warning and Unknown” and the following for hosts; “Down" regardless or whether the issue is handled or unhandled.  
 + 
 +\\ 
 + 
 +{{:opsview-mobile-android:inner_tab_example.png|}} 
 + 
 +\\ 
 + 
 +From version 2.1 and when drilling down the next inner tab will be selected based on the highest severity of the items with the keyword or hostgroup, for example if you click on a hostgroup with unhandled services or hosts within it then the unhandled tab will be automatically selected, however if you click a hostgroup where all the items within it are OK then the all tab will be selected instead.  
 + 
 +=== Keywords === 
 + 
 +This is the default start view. Any defined Keywords that you have permission to view will be displayed like this: 
 + 
 +{{:opsview-mobile-android:keyword.png|}} 
 + 
 +From here you can click on a keyword and be shown a list of hosts/services within that keyword.  
 + 
 + 
 +=== Hostgroups === 
 + 
 +Hostgroups view will look like the following:  
 + 
 +{{:opsview-mobile-android:hostgroup-example.png|}}
To navigate down a level in the hierarchy, touch the name of the hostgroup you wish to navigate to. To navigate down a level in the hierarchy, touch the name of the hostgroup you wish to navigate to.
Line 54: Line 136:
To navigate up a level in the hierarchy, press the 'Back' button. To navigate up a level in the hierarchy, press the 'Back' button.
-=== Host List ===+=== Hosts === 
 + 
 +To open this view, select a the hosts tab.  
 + 
 +{{:opsview-mobile-android:host-view-example.png|}} 
 + 
 +Clicking on a host will allow you to view more information about that host and submit commands to it. Hosts are sorted in alphabetical order.  
 + 
 +Long press on a host to display a context menu, which will include various options that can be performed on the host.  
 + 
 +=== Services === 
 + 
 +To open this view, select the services tab.  
 + 
 +{{:opsview-mobile-android:services-example.png|}} 
 + 
 +Services are grouped by hosts, select a host to see the list of services on that host. Clicking on a service will allow you to drill down into another view that displays more information on. 
 + 
 +Long press on a service to display a context menu, which includes options to Acknowledge or Re-check a service. You can also long press on a host item to get options to for that host object too. 
 + 
 + 
 +See here an example of long pressing on a service:  
 + 
 +{{:opsview-mobile-android:long-press-example.png|}} 
 + 
 +\\ 
 + 
 +==== Host & Service Detail ==== 
 + 
 +Here you can see detail about hosts or services depending on which item was clicked - see below for an example.  
 + 
 +{{:opsview-mobile-android:control-view-example.png|}} 
 + 
 +Various commands are supported on the Android application. These commands can also be accessed by selecting a host or service (the result is show below) or by long pressing on a host or service as shown above.  
 + 
 +==== Graphing ==== 
 + 
 +Graphing is now supported in the new android application. Either long press on a service that has graph data, or drill down to a specific service and select the graphing option.  
 + 
 +Within the graphing view there are four tabs that will allow you to select the time range you want to see. You can pinch and swipe to zoom in and move the graph.  
 + 
 + 
 +==== Downtime ==== 
 + 
 +Downtime can be viewed, added and removed. To view downtime select the downtime option in either the long press menu or on the service/host control view. Downtime that is scheduled for the future will be displayed in white, downtime that is currently activity will be displayed in green.  
 + 
 +You can also delete downtime by long pressing on a downtime item once in the view, or by select the trash/bin icon to the right of each downtime item.  
 + 
 + 
 +==== Events ==== 
 + 
 +Events can be viewed on hosts and services by drilling down and selecting the events button, or by using one of the long press menus. They are sorted by most recent, events for hosts will show events on related services and vice versa.  
 + 
 + 
 +==== Searching ==== 
 + 
 +The search mechanism provided will allow you to search for items within the tab you are looking at. This is a local search and will not search the Opsview system for items, but rather look at what is currently loaded on the android device. Therefore please be careful with pagination as you cannot search for something that has not been polled and displayed on the android device.  
 + 
 +This search is not case sensitive.  
 + 
 +Here is an example below:  
 + 
 +{{:opsview-mobile-android:help_search_example.png|}} 
 + 
 +==== Push Notifications: Setup ==== 
 + 
 +Push notifications are sent a form of notification method you can configure on your Opsview system.  
 + 
 +1.  To begin setting up Push notifications you need to configure the notification method for Android Notifications.   
 + 
 +You find this under “Settings -> Notifications Methods” in the Opsview UI 
 + 
 +{{:opsview-mobile-android:notification-method-list-3.png|}} 
 + 
 +You will need to enter your username and password that you use to login into www.opsview.com. If you do not have account signing up is quick and simple just head over to https://www.opsview.com/user/register. 
 + 
 +Your login details are needed so that the Opsview installation can connect to our push server.  This part of setting up push will only need to be configured once per Opsview system.   
 + 
 +You will need to ensure that the Activate checkbox has been ticked. Please take care entering your username and password.  
 +  
 + {{:opsview-mobile-android:android-notification-method-example-1.png|}} 
 + 
 +2. Setup a Personal Notification Profile/Shared Notification Profile that uses the method.
-To open this view, select a 'leaf' hostgroup in the Hostgroup Hierarchy, i.e. one which contains one or more hosts.+In this example we will configure a shared profile that uses the method however you can configure the method using a personal profile to.
-{{:opsview-mobile-android:hostlist-cropped.png|}}+Go to “Settings -> Shared Notifications Profiles”
-The list of hosts is sorted by their state, with Down and Unhandled hosts appearing above hosts which are Up.  The colour tab next to each host indicates the 'highest' (most severe) state of all the services on that host.  For example if the colour tab is red, there is at least one service on that host in a critical state. 
-Long press on a host to display a context menu, which includes options to Acknowledge or Re-check a host.+ {{:opsview-mobile-android:notification-profile-1.png|}}
-=== Host Detail === 
-To open this view, long press on a host in the host view, and select "View host detail"+And enable push notifications for Android by ticking it.  
 +
-{{:opsview-mobile-android:host-detail-cropped.png|}}+{{:opsview-mobile-android:contact-notification-edit.png|}}
-Currently on the hostname and host state is displayed here, as further information is not yet available via the Opsview REST API.  In future releases, more information will be displayed here. 
-To view a context menu, press the 'Menu' button.  Options available are 'Refresh', 'Re-check host' and 'Acknowledge host'.+Make sure to apply this to a contact in “Settings -> Contacts -> Notifications”
-To exit this view, press the 'Back' button.+{{:opsview-mobile-android:contact-notification-edit.png|}} 
 +  
 +Finally enter your Opsview.com account details into your android device in the push notifications section on the settings page of the mobile app.
-=== Service List ===+The account details you used to configure the push settings do not need to be the same ones that you used to configure the notification method. However the contact that you applied the notification profile to will need to be the same one that you are connecting to Opsview with on your mobile.
-To open this view, touch a host whilst in a host view.+It should be noted that you need to use your opsview.com username, not your email. Log on to opsview.com using your email to find out what your username is if you are not sure.
-{{:opsview-mobile-android:servicelist-cropped.png|}}+You should start receiving notifications soon.
-The list of services is sorted by their state, and then alphabetically.  The colour tab next to each service indicates the state of that service.  If the service is in an error state but is 'handled', then a green/purple tick will be displayed next to it to indicate this. 
-Long press on a service to display a context menu, which includes options to Acknowledge or Re-check a service.+==== Receiving Push Notifications ====
-To exit this view, press the back button.+Once your push notifications have been configured you should start receiving push notifications. There are two stages of notifications. The first stage is notifications appearing in the android notification bar. Here you will see up to 5 notifications, these 5 will be sorted by the most recent notifications that you have been sent. Because the maximum you can see is 5 there will be a number at the bottom of the notification describing how many more notifications you have received but cannot see. See below for a reference.
-=== Service Detail ===+{{:opsview-mobile-android:help_notifications_example2.png|}}
-To open this view, touch a service whilst in a service list view.+Clicking the notification when there are 2 or more will remove the notifications from the notification bar and show the notifications view where you can see notifications that you have not cleared yet and select them to get more information. You can clear a notification fully by clicking on the cross at the end of the notification or you can clear all the notifications on the screen by using the option in the menu.
-{{:opsview-mobile-android:host-detail-cropped.png|}}+If a single notification has appeared, pressing the notification will bypass the notification view and go straight to the related host or service in question.
-To view a context menu, press the 'Menu' button.  Options available are 'Refresh', 'Re-check service' and 'Acknowledge service'.+The notification view activity can be viewed at any time within the app by pressing "Menu -> Notifications", this way you can view previous notifications if you are not done reviewing them.
-To exit this view, press the back button. 
 +==== Push Notifications: How They Work ====
-=== Viewport Status ===+Very briefly:
-To open this view, from the Hostgroup Hierarchy view, press Menu and select "Viewports".  Any defined viewports that you have permission to view will be displayed like this:+  - Your android device once setup with username and password will register with GCM: Google’s Cloud Messaging server receiving a unique ID for the device and then submit than back to our push servers here at Opsview. 
 + - Your Opsview system that will have been configured previously (see above) will then send notifications to our push servers.  
 +  - Our push servers using the unique details passed from the phone and system will tie the notifications to the right devices and then pass them to GCM.  
 +  - GCM will then send push notifications to the device, which will then be shown to the user.
-{{:opsview-mobile-android:viewports-cropped.png|}}+An android device can therefore be connected to one Opsview system at a time for push notifications to work.
-The viewports are sorted by severity ('highest' state first), and then alphabetically.  Any viewports in an error state but with all hosts/services handled will show a green/purple tick next to their name just as they do in the Opsview UI.+==== Push Notifications: Troubleshooting ====
-To refresh this view, press 'Menu' and then select 'Refresh'. 
-To exit this view, press 'Back'.+  * On your Opsview system under “Monitoring -> Notifications” you can see notifications that are sent including the method that they are using. However please bare in mind that this page only shows notifications being sent by the master. 
 +  * Check the following logs, push production logs, nagios logs and apache logs on your Opsview system.  
 +  * Contact Opsview Support or post in the [[https://www.opsview.com/resources/forums/basic-monitoring/androidiphone-application|Opsview Mobile for Android Forum]]
==== Feedback ==== ==== Feedback ====
-Any feedback you might have about the application can be left in the [[http://www.opsview.com/forums/opsview-community-edition/opsview-mobile|Opsview Mobile for Android Forum]]+Any feedback you might have about the application can be left in the [[https://www.opsview.com/resources/forums/basic-monitoring/androidiphone-application|Opsview Mobile for Android Forum]]
Navigation
Print/export
Toolbox