Welcome to docs.opsview.com


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

opsview4.6:keyword [2014/09/09 12:19] (current)
Line 1: Line 1:
 +====== Keywords ======
 +Keywords are a way of tagging specific services. It is a convenient way of grouping a subset of services together for viewing overall status in a [[opsview4.6:quickstart#viewport_summary|viewport]] and for [[opsview4.6:contact#authorised_for_keywords|access permissions]].
 +A keyword needs to exist on the [[opsview4.6:host#keywords|host]] and the [[opsview4.6:servicecheck#keywords|service check]] to apply.
 +You can assign multiple keywords to each host and service check, comma separated.
 +Keywords are case-insensitive.
 +====== List Keywords ======
 +These columns are displayed when listing keywords:
 +  * Keyword - this is the keyword name
 +  * Viewport Style - if the viewport is enabled for this keyword, this will show the name of the default viewport style. You can click on the name to jump to the viewport
 +  * Description - this is the default description when looking at the viewport
 +  * Contacts - the number of contacts specifically assigned to this keyword
 +  * Hosts - the number of hosts assigned to this keyword
 +  * Service Checks - the number of service checks assigned to this keyword
 +  * Total Services - this is the number of services that match the host name AND the service name. This is from the live configuration, so you will need to reload if you have made changes
 +====== Editing Keywords ======
 +===== Name =====
 +This sets the name of the keyword.
 +You can only use alphanumerics, underscore or a hyphen for the name.
 +===== Viewport =====
 +You can enable a viewport to see all the services associated with this keyword. The URL will be http://opsviewserver.example.com/viewport/{keyword}.
 +If a viewport is enabled, it will be available on the Viewport Summary link on the left hand navigation.
 +On the keyword list page, you can click on the style to see the viewport for this service.
 +===== Public =====
 +Available from Opsview 3.11.3.
 +If enabled, then all users, including unauthenticated users, can see this viewport.
 +If disabled, then a user must have in their [[opsview4.6:role|role]] either:
 +  * VIEWALL access
 +  * all keywords set or
 +  * the specific keyword
 +Otherwise, they will not be able to see this viewport.
 +**Note**: Having [[opsview4.6:access#selection_of_objects|All host groups and All service groups]] is not sufficient.
 +===== Description =====
 +This is free form text that can describe the purpose of the keyword. It is used in the viewport displays.
 +===== Style =====
 +There are different style templates available for display a viewport:
 +  * Errors and host cells - displays a list of the failures (order by severity), then a list of hosts
 +  * Group by host - like a normal status view for a host
 +  * Group by service - grouped by service. Useful for clustered services
 +  * Host summary - summarises the services in the keyword, grouped by host
 +===== Show Contextual Menus =====
 +From Opsview 3.15.0.
 +This defines whether the viewport detail pages will include a contextual menu for each host and service.
 +===== Exclude Handled =====
 +From Opsview 4.2.0
 +This defines whether the viewport summary page will set overall status for keyword excluding handled host and services.
 +===== Hosts =====
 +**Note**: This option and others below are available from Opsview 3.7.1.
 +You can amend the list of hosts that the keyword is associated with. Select from the box on the right and click to bring to the active list on the left.
 +===== All Service Checks =====
 +If this is selected, then all service checks on the hosts listed above will be tagged this keyword. This means you do not have to associate the keyword against the service checks to select the service.
 +===== Service Checks =====
 +You can amend the list of service checks that the keyword is associated with. Select from the box on the right and click to bring to the active list on the left.
 +From Opsview 3.11.0, you can click on the //Filter by hosts// checkbox and this will reduce the number of items in the service checks list on the right by only showing items based on what the hosts selected above have (either directly or via a host template). If you update the list of hosts, this will also update the list of service checks.
 +===== All Hosts =====
 +If this is selected, then all hosts with the service checks above will be tagged with this keyword.
 +===== Contacts =====
 +You can amend the list of contacts that have this keyword associated. If keywords are removed, then notification profiles for these contacts will be stripped of the keyword as well.
 +==== Examples ====
 +As mentioned earlier, a keyword must exist on both the host and servicecheck for it to apply.
 +A good way to visualize this is to think of two overlapping circles and the area that is shared by both.  One of our circles will contain a list of keywords for our host and the other circle will contain a list of keywords for our servicecheck.  The overlapping section will thus be the keywords that are on both the host and servicecheck.
 +In the above image, our host has the keywords keyword1, keyword2, and keyword4, while our servicecheck has keywords keyword2, keyword3, and keyword4.
 +The applied keywords are therefore going to be keywords keyword1 and keyword4.