1,774
edits
Changes
Initial page
[[Welcome_to_Veloopti_help|Home]] > [[:Category:Using|Using]] > [[:Category:Web_User_Interface|Web User Interface]] > [[:Category:Views|Views]] > [[Policy:Log File_Policy_Page|Log File policy]]
----
== Overview ==
The Log File policy enables ???
A policy is an instructions run on one or more of your monitored servers looking for an event that could lead to loss of, or disruption to, an organisation's operations, services or functions. Each policy is found in an application
A [[policy|policy]] is represented in Veloopti by the policy icon: <sup>[[file:icon_policy.png|30px]]</sup>
Log File policies must be added to a [[Group|Policy Group]] for automated deployment onto one or more managed nodes.
=== Creating or editing a policy ===
[[File:Log File page.png|thumb|350px|The Log File policy page is found by selecting a policy from the policy view.]]
Log File policies are created and edited from within an [[Application|application]]. A policy is only visible from within the application that it was created in. After entering an application select 'Policies' from the application breadcrumb to view the list of policies that are available in the application.
# Click on the Application menu item
# Click on the Application
# Select the Policies breadcrumb as shown below to view the [[Policy_view|Policy view]]
# From here you can either click on the [[Policy_Wizard|Policy Wizard]] to create a new Policy or select a HTTP Response policy to modify it.
[[File:Breadcrumb application policy.png|500px]]
== Navigating the policy page ==
Tabs run down the left hand side of the view. Clicking on a tab will change the page that allows for a particular part of the policy to be modified.
They are: [[Policy:Log_File_Policy_Page#Overview_2|Overview]], [[Policy:Log_File_Policy_Page#Attributes|Attributes]], [[Policy:Log_File_Policy_Page#Conditions|Conditions]], [[Policy:Log_File_Policy_Page#Node_Overrides|Node Overrides]], [[Policy:Log_File_Policy_Page#Schedule|Schedule]], [[Policy:Log_File_Policy_Page#Audit_Log|Audit Log]] and [[Policy:Log_File_Policy_Page#View_Data|View Data]].
=== Log File Policy Page ===
'''NAME'''
The title of the policy that can be used to tell the policy apart from others
'''DESCRIPTION'''
Describes the policy and explains what it does
'''TYPE'''
HTTP Response
'''NODE OVERRIDES CONDITIONS'''
Enabling this slider makes the Node Overrides tab visible.
=== Attributes ===
'''URL'''
The full web page URL that is to have the page request sent to. It can be either a HTTP or HTTPS web request.
'''HTTP Version'''
Select either version 1.0 or 1.1
'''Auth Username'''
The username to send to the webserver to authenticate using Basic Authentication
'''Auth Password'''
The password to send to the webserver to authenticate using Basic Authentication
'''Proxy Host'''
The hostname of the proxy server that should be used to connect to the webpage to be tested
#'''Port''' The port of the Proxt Host that is listening
'''Proxy Credentials'''
#'''Username''' The username to authenticate with the proxy server
#'''Password''' The password to authenticate with the proxy server
'''Timeout(seconds)'''
The number of seconds after the webpage request is sent until the policy is considered to have failed. This will generate a failure event.
=== Conditions ===
Either add a new row by clicking on the [Add] button or click on an existing row to enter the edit condition dialogue box.
The rules may be moved up and down by selecting and holding the rule to change its position.
Click on the [Add] button to bring up the dialogue to add a condition to the policy.
NOTE: Currently changing the position of order of the rules does not do anything as they are evaluated in order of severity.
::'''EVALUATE'''
:::'''Timed out''' True if the entire page loading time took longer than the entered Timeout duration
:::'''Response Code''' The status code issued by the web server in response to the page request
:::'''Size in bytes''' The total page size measured in bytes
:::'''Keep-Alive'''
:::'''Round trip Delay Time''' The period from when the response was first sent to when the first byte was received back from the web server
:::'''Certificate Expires (days)''' The number of days until the SSL certificate expires
:::'''Certificate Expired''' 'Yes' if the SSL certificate is expired, 'No' otherwise
:::'''Content Match''' a textual string that is to be evaluated against the webpage
:::'''Operator''' Select an operator to perform against the Metric above. Different options are available for different metrics.
::::Equals
::::Less than
::::Less than or equal to
::::Greater than or equal to
::::Greater than
::::Does not equal
::::Contains - Compares the text in 'Content Match' with the web page and is a match if they are exactly the same
::::Doesn't contain - Compares the text in 'Content Match' with the web page and is a match if they are exactly the same
::::Regular Expression Match - Compares the text in 'Content Match' with the web page as a Regular Expression and is true if the Regular Expression matches
::::Regular Expression Suppress Matches - Compares the text in 'Content Match' with the web page as a Regular Expression and is false if the Regular Expression matches
:::'''Value''' Enter a value to compare the metric against using the operator.
::'''BREACH AND RESET'''
:: May not appear depending upon the Metric selected above.
:::'''Breach duration''' Enter the number of consecutive breaches that need to occur for an event to be raised. Note this is breaches for a policy run, not individual HTTP page failures.
:::'''Reset Duration''' Enter the number of consecutive successful policy runs, the number that the metric must be (usually) below, for the event severity to be set to Normal.
::'''CREATE EVENT'''
::'''Event Severity''' The severity that appears on the event that is raised by a threshold violation of the rule
::'''Event Short Description''' The short event description that appears on the event that is raised
::'''Event Long Description''' The long description that appears in the event
::'''Auto Action''' Select an action to run automatically when the condition of raising an event is met. These are [[Action|actions]] that have been created for the Application.
::'''Close event if auto action runs successfully''' This check box closes the event if the command exits with a successful 'error code'. For instance, the ping command on a Mac returns an error code of 0 for success and 2 for a ping failure. And the ping command on a windows OS in a command prompt returns 0 for success and 1 for failure.
:::On Windows, after running the command, run the below command to see the error code that the command exited with
::: <pre style="color: silver; background: black;">C:\users\Muuss\echo %ERRORLEVEL%</pre>
::'''EVENT ACTIONS''' These actions are available to be run by any user that has the "Run Action from Event" permission. Unlike normal actions it does not rely on the Action "Level" permission of Operator, Power User or Administrator
::'''HELP TEXT''' This text appears on the event in the "Help" section.
::'''NOTIFICATION WORKFLOW''' Select the Notification Workflow that will be used for notifications and escalations.
=== Node Overrides ===
One policy can run on multiple nodes using the same conditions to create events. Individual nodes may require different threshold values in these conditions for effective monitoring. This is known as a "Node override condition".
This is currently not enabled.
=== Schedule ===
'''TYPE'''
::'''Basic''' Run the policy once per minute or once per hour
::'''Time of day''' Run the policy once her day
::'''Custom''' Run the policy on a complex schedule
'''EVERY'''
::'''Basic''' Select "Minutes" or "Hours" and type when on the minute or hour the policy should run.
::'''Time of day''' Select hour and minute and the weekday(s) that the policy should run.
::'''Custom''' Select "Minutes" or "Hours" and type when on the minute or hour the policy should run. Select the time range when the policy should be active: e.g. 9:00am - 5:00pm. Select the weekday(s) that the policy should run.
=== Audit Log ===
'''DATE/TIME''' The date/time that the audit event occurred
'''USER''' The user that initiated the audited event
'''EVENT''' A description of what happened to the policy. Blue text indicates that it is a link to the described item.
'''ACTION''' If an action is available for the audit item it can be initiated here. For instance, roll back the policy to the previous version or restore the accidentally deleted policy.
=== View Data ===
'''SELECT YOUR NODE''' Use the drop down list box to select the node that it is deployed to. Graphs will then be visible in the below space that contains the metrics that have been collected over the last hour.
NOTE: Only nodes with this policy currently deployed are able to be selected.
[[Category:Views]] [[Category:Policies]]
----
== Overview ==
The Log File policy enables ???
A policy is an instructions run on one or more of your monitored servers looking for an event that could lead to loss of, or disruption to, an organisation's operations, services or functions. Each policy is found in an application
A [[policy|policy]] is represented in Veloopti by the policy icon: <sup>[[file:icon_policy.png|30px]]</sup>
Log File policies must be added to a [[Group|Policy Group]] for automated deployment onto one or more managed nodes.
=== Creating or editing a policy ===
[[File:Log File page.png|thumb|350px|The Log File policy page is found by selecting a policy from the policy view.]]
Log File policies are created and edited from within an [[Application|application]]. A policy is only visible from within the application that it was created in. After entering an application select 'Policies' from the application breadcrumb to view the list of policies that are available in the application.
# Click on the Application menu item
# Click on the Application
# Select the Policies breadcrumb as shown below to view the [[Policy_view|Policy view]]
# From here you can either click on the [[Policy_Wizard|Policy Wizard]] to create a new Policy or select a HTTP Response policy to modify it.
[[File:Breadcrumb application policy.png|500px]]
== Navigating the policy page ==
Tabs run down the left hand side of the view. Clicking on a tab will change the page that allows for a particular part of the policy to be modified.
They are: [[Policy:Log_File_Policy_Page#Overview_2|Overview]], [[Policy:Log_File_Policy_Page#Attributes|Attributes]], [[Policy:Log_File_Policy_Page#Conditions|Conditions]], [[Policy:Log_File_Policy_Page#Node_Overrides|Node Overrides]], [[Policy:Log_File_Policy_Page#Schedule|Schedule]], [[Policy:Log_File_Policy_Page#Audit_Log|Audit Log]] and [[Policy:Log_File_Policy_Page#View_Data|View Data]].
=== Log File Policy Page ===
'''NAME'''
The title of the policy that can be used to tell the policy apart from others
'''DESCRIPTION'''
Describes the policy and explains what it does
'''TYPE'''
HTTP Response
'''NODE OVERRIDES CONDITIONS'''
Enabling this slider makes the Node Overrides tab visible.
=== Attributes ===
'''URL'''
The full web page URL that is to have the page request sent to. It can be either a HTTP or HTTPS web request.
'''HTTP Version'''
Select either version 1.0 or 1.1
'''Auth Username'''
The username to send to the webserver to authenticate using Basic Authentication
'''Auth Password'''
The password to send to the webserver to authenticate using Basic Authentication
'''Proxy Host'''
The hostname of the proxy server that should be used to connect to the webpage to be tested
#'''Port''' The port of the Proxt Host that is listening
'''Proxy Credentials'''
#'''Username''' The username to authenticate with the proxy server
#'''Password''' The password to authenticate with the proxy server
'''Timeout(seconds)'''
The number of seconds after the webpage request is sent until the policy is considered to have failed. This will generate a failure event.
=== Conditions ===
Either add a new row by clicking on the [Add] button or click on an existing row to enter the edit condition dialogue box.
The rules may be moved up and down by selecting and holding the rule to change its position.
Click on the [Add] button to bring up the dialogue to add a condition to the policy.
NOTE: Currently changing the position of order of the rules does not do anything as they are evaluated in order of severity.
::'''EVALUATE'''
:::'''Timed out''' True if the entire page loading time took longer than the entered Timeout duration
:::'''Response Code''' The status code issued by the web server in response to the page request
:::'''Size in bytes''' The total page size measured in bytes
:::'''Keep-Alive'''
:::'''Round trip Delay Time''' The period from when the response was first sent to when the first byte was received back from the web server
:::'''Certificate Expires (days)''' The number of days until the SSL certificate expires
:::'''Certificate Expired''' 'Yes' if the SSL certificate is expired, 'No' otherwise
:::'''Content Match''' a textual string that is to be evaluated against the webpage
:::'''Operator''' Select an operator to perform against the Metric above. Different options are available for different metrics.
::::Equals
::::Less than
::::Less than or equal to
::::Greater than or equal to
::::Greater than
::::Does not equal
::::Contains - Compares the text in 'Content Match' with the web page and is a match if they are exactly the same
::::Doesn't contain - Compares the text in 'Content Match' with the web page and is a match if they are exactly the same
::::Regular Expression Match - Compares the text in 'Content Match' with the web page as a Regular Expression and is true if the Regular Expression matches
::::Regular Expression Suppress Matches - Compares the text in 'Content Match' with the web page as a Regular Expression and is false if the Regular Expression matches
:::'''Value''' Enter a value to compare the metric against using the operator.
::'''BREACH AND RESET'''
:: May not appear depending upon the Metric selected above.
:::'''Breach duration''' Enter the number of consecutive breaches that need to occur for an event to be raised. Note this is breaches for a policy run, not individual HTTP page failures.
:::'''Reset Duration''' Enter the number of consecutive successful policy runs, the number that the metric must be (usually) below, for the event severity to be set to Normal.
::'''CREATE EVENT'''
::'''Event Severity''' The severity that appears on the event that is raised by a threshold violation of the rule
::'''Event Short Description''' The short event description that appears on the event that is raised
::'''Event Long Description''' The long description that appears in the event
::'''Auto Action''' Select an action to run automatically when the condition of raising an event is met. These are [[Action|actions]] that have been created for the Application.
::'''Close event if auto action runs successfully''' This check box closes the event if the command exits with a successful 'error code'. For instance, the ping command on a Mac returns an error code of 0 for success and 2 for a ping failure. And the ping command on a windows OS in a command prompt returns 0 for success and 1 for failure.
:::On Windows, after running the command, run the below command to see the error code that the command exited with
::: <pre style="color: silver; background: black;">C:\users\Muuss\echo %ERRORLEVEL%</pre>
::'''EVENT ACTIONS''' These actions are available to be run by any user that has the "Run Action from Event" permission. Unlike normal actions it does not rely on the Action "Level" permission of Operator, Power User or Administrator
::'''HELP TEXT''' This text appears on the event in the "Help" section.
::'''NOTIFICATION WORKFLOW''' Select the Notification Workflow that will be used for notifications and escalations.
=== Node Overrides ===
One policy can run on multiple nodes using the same conditions to create events. Individual nodes may require different threshold values in these conditions for effective monitoring. This is known as a "Node override condition".
This is currently not enabled.
=== Schedule ===
'''TYPE'''
::'''Basic''' Run the policy once per minute or once per hour
::'''Time of day''' Run the policy once her day
::'''Custom''' Run the policy on a complex schedule
'''EVERY'''
::'''Basic''' Select "Minutes" or "Hours" and type when on the minute or hour the policy should run.
::'''Time of day''' Select hour and minute and the weekday(s) that the policy should run.
::'''Custom''' Select "Minutes" or "Hours" and type when on the minute or hour the policy should run. Select the time range when the policy should be active: e.g. 9:00am - 5:00pm. Select the weekday(s) that the policy should run.
=== Audit Log ===
'''DATE/TIME''' The date/time that the audit event occurred
'''USER''' The user that initiated the audited event
'''EVENT''' A description of what happened to the policy. Blue text indicates that it is a link to the described item.
'''ACTION''' If an action is available for the audit item it can be initiated here. For instance, roll back the policy to the previous version or restore the accidentally deleted policy.
=== View Data ===
'''SELECT YOUR NODE''' Use the drop down list box to select the node that it is deployed to. Graphs will then be visible in the below space that contains the metrics that have been collected over the last hour.
NOTE: Only nodes with this policy currently deployed are able to be selected.
[[Category:Views]] [[Category:Policies]]