Added reference doc for Occurrences and Check_Dependencies #498

Blue0ctober · 2018-06-14T19:24:56Z

Description

Adding references in core docs for built-in filters:

occurrences
check_dependencies

Closes #310

Motivation and Context

We have built-in filters, extensions included in official Sensu Core packages, which should be mentioned along site native or configuration-defined filters.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
New doc/guide
Fixing errata
Update (Add missing or refresh existing content)

Checklist:

My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
All tests have passed.

rgeniesse · 2018-06-14T19:33:50Z

content/sensu-core/0.29/reference/filters.md

+
+The `check_dependencies` filter is included in every install of Sensu. This 
+filter can be applied to a handler using the "filter" or "filters" handler definition
+attribute. The `check_dependencies` filter matches events when an even already exisits,


events when an event instead of events when an even
and
exists instead of exisits

asachs01 · 2018-06-14T19:35:17Z

content/sensu-core/0.29/reference/filters.md

+### Built-in Filters - check_dependencies {#built-in-filters-check-dependencies}
+
+The `check_dependencies` filter is included in every install of Sensu. This 
+filter can be applied to a handler using the "filter" or "filters" handler definition


I'm leery of putting "filter" in here. Best practice would be for customers to use "filters".

asachs01 · 2018-06-14T19:36:11Z

content/sensu-core/0.29/reference/filters.md

+### Built-in Filters - occurrences {#built-in-filters-occurrences}
+
+The `occurrences` filter is included in every install of Sensu. This filter can 
+be applied to a handler using the "filter" or "filters" handler definition attribute.


Didn't notice this at first, but yeah, I'd recommend enforcing "filters"

apaskulin · 2018-06-14T22:30:22Z

This looks great! I love the examples you've used, especially the progression of example for dependencies. I'd recommend:

breaking out "Built-in Filters" into its own section (if that makes sense to you) instead of embedding it within "Filter configuration"
adding the new headings to the TOC at the top of the page
using tables for the occurrences and refresh attributes

asachs01 · 2018-06-15T02:10:31Z

Sidenote, I feel like this would satisfy the #374 issue. It's not a full-blown guide, but it adds the requisite material.

cwjohnston · 2018-06-21T16:52:27Z

content/sensu-core/0.29/reference/filters.md

+}
+{{< /highlight >}}
+
+Lastly we can specify a dependency on any `mysql` check in the `mysql_nodes` subscription:


The subscription: prefix functionality added in sensu/sensu-extensions-check-dependencies#12 has been merged, but we haven’t cut a new release of check_dependencies extension since that time.

This means that the feature hasn’t yet shipped to customers, so we shouldn’t describe it in these versions of the docs.

@cwjohnston was this for only 0.29 or everything including 1.4?

@Blue0ctober we'll need to remove references to subscription/check pairs and the subscription: prefix for all current versions. Ideally we'll ship that feature in Sensu 1.5.

cwjohnston · 2018-06-21T16:53:27Z

content/sensu-core/0.29/reference/filters.md

+{{< /highlight >}}
+
+
+The `occurrences` filter uses two custom check definition attributes, `occurrences` 


Let’s drop the adjective “custom” here. They are more or less part of the spec IMO.

cwjohnston

I think a couple of changes are needed. Please have a look.

cwjohnston · 2018-07-05T21:23:38Z

content/sensu-core/0.29/reference/filters.md

+
+The `check_dependencies` filter uses a custom check definition attribute `dependencies`.
+`dependencies` is defined as an array with attributes such as `checks`, Sensu client/check
+pairs or subscription/check pairs. 


@Blue0ctober lets rephrase this to remove or subscription/check pairs.

asachs01 · 2018-07-12T15:08:20Z

@Blue0ctober is this all set?

re-organized placement added to index created tables for attributes

apaskulin

Super excited about this! Left a few comments here and in Slack. We'll also need to get an approval from @cwjohnston before GitHub will let us merge.

apaskulin · 2018-07-18T23:11:36Z

content/sensu-core/0.29/reference/filters.md

+    - [occurrences Filter Attributes](#occurrences-filter-attributes)
+  - [check_dependencies Filter](#check-dependencies-filter)
+    - [Defining Check Dependencies](#defining-check-dependencies)
+    - [check_dependencies Attributes](#check-dependencies-attributes)


Recommend reducing this to just:

[Built-in Filters](#built-in-filters)

apaskulin · 2018-07-18T23:13:18Z

content/sensu-core/0.29/reference/filters.md

+
+
+The `occurrences` filter uses two check definition attributes, `occurrences` 
+and `refresh`. 


Looks like this sentence is a duplicate of line 327

apaskulin · 2018-07-18T23:16:31Z

content/sensu-core/0.29/reference/filters.md

+The `dependencies` attribute should define an array containing names of checks or
+client/check pairs.
+
+This example showcases a check configured to depend on any check called `mysql`:


Recommend changing "showcases" to "shows"

apaskulin · 2018-07-24T16:43:56Z

content/sensu-core/0.29/reference/filters.md

+
+The occurrences filter lets you configure the number of occurrences and the refresh interval at the check level using two check definition attributes: `occurrences` and `refresh`.
+
+Here's an example of a check definition that passes events to the `email` handler starting with the third occurrence every 60 minutes:


Needs review

apaskulin · 2018-07-24T16:46:06Z

content/sensu-core/0.29/reference/filters.md

+    }
+  }
+}
+{{< /highlight >}}


Not sure I understand this behavior. Which event is being filtered: mysql or web_application_api?

If mysql check for this client is in a non-OK state, events from this client for web_application_api check from will be filtered.

rgeniesse · 2018-07-24T16:58:59Z

content/sensu-core/0.29/reference/filters.md

+
+The occurrences filter lets you configure the number of occurrences and the refresh interval at the check level using two check definition attributes: `occurrences` and `refresh`.
+
+Here's an example of a check definition that passes events to the `email` handler starting with the third occurrence every 60 minutes:


Wouldn't this be starting with the second occurrence every 60 minutes? The JSON example has occurrences set to 2, so I believe it would be handled after 2 occurrences. I can test this if we aren't sure.

Thanks for clarifying! That was exactly what I was wondering

rgeniesse · 2018-07-24T17:05:07Z

content/sensu-core/0.29/reference/filters.md

+
+The check dependencies filter is included in every install of Sensu.
+This filter can be applied to a handler using the `filters` handler definition attribute.
+The check dependencies filter lets you reduce notification noise by matching events when an event already exists, thereby only notifying for the root cause of a given failure.


This part I think needs changed: by matching events when an event already exists.
The point of dependencies is to get to the root cause quicker. So if a tomcat process isn't running, a check that tries to get to the API for an application inside of tomcat would not work. API depends on tomcat, if tomcat down only handle that event.

Maybe something like by looking to see if an event higher up in the dependency tree already exists

rgeniesse

LGTM 👍

Added reference doc for Occurrences and Check_Dependencies

2b500a2

Blue0ctober requested a review from a team as a code owner June 14, 2018 19:24

amdprophet added the in progress Currently being worked label Jun 14, 2018

Blue0ctober added ready for review PR is ready to review and removed in progress Currently being worked labels Jun 14, 2018

rgeniesse reviewed Jun 14, 2018

View reviewed changes

asachs01 reviewed Jun 14, 2018

View reviewed changes

typos

e52df82

asachs01 and others added 4 commits June 18, 2018 10:36

Merge branch 'master' into update/built-in-filters

755502b

Merge branch 'master' into update/built-in-filters

e74a84c

Merge branch 'master' into update/built-in-filters

8290cab

removed reference to 'filter'

ed47f84

This was referenced Jun 21, 2018

Filters reference doc should describe built-in filters #310

Closed

Guide Wanted: Using built-in occurrences filter #374

Closed

cwjohnston reviewed Jun 21, 2018

View reviewed changes

cwjohnston suggested changes Jun 21, 2018

View reviewed changes

cwjohnston and others added 5 commits June 21, 2018 12:35

Merge branch 'master' into update/built-in-filters

1290960

removed custom

34410c8

Merge branch 'master' into update/built-in-filters

000eb26

removed example with subcriptions

77ed57f

Merge branch 'master' into update/built-in-filters

016cd05

cwjohnston reviewed Jul 5, 2018

View reviewed changes

Blue0ctober and others added 3 commits July 5, 2018 14:30

changed definition of check d ependencies

e565a6e

spacing fix

a846114

Merge branch 'master' into update/built-in-filters

5a65ada

apaskulin requested review from apaskulin and removed request for apaskulin July 9, 2018 16:31

asachs01 mentioned this pull request Jul 12, 2018

Guide Wanted: Scaling Sensu #228

Closed

apaskulin changed the title ~~Added reference doc for Occurrences and Check_Dependencies~~ [WIP] Added reference doc for Occurrences and Check_Dependencies Jul 16, 2018

Edgar Valdes added 3 commits July 18, 2018 15:37

Re-org

d22e7d4

re-organized placement added to index created tables for attributes

Merge branch 'master' into update/built-in-filters

2e0ed3e

added email to example, fixed example in attribute

1c1b03c

apaskulin reviewed Jul 18, 2018

View reviewed changes

cwjohnston assigned apaskulin Jul 23, 2018

formatting and wording updates

40f2458

apaskulin reviewed Jul 24, 2018

View reviewed changes

apaskulin changed the title ~~[WIP] Added reference doc for Occurrences and Check_Dependencies~~ Added reference doc for Occurrences and Check_Dependencies Jul 24, 2018

rgeniesse reviewed Jul 24, 2018

View reviewed changes

apaskulin changed the title ~~Added reference doc for Occurrences and Check_Dependencies~~ [WIP] Added reference doc for Occurrences and Check_Dependencies Jul 24, 2018

apaskulin added 2 commits July 24, 2018 12:45

condense table of contents

6429506

formatting and wording changes

c5f0daf

apaskulin changed the title ~~[WIP] Added reference doc for Occurrences and Check_Dependencies~~ Added reference doc for Occurrences and Check_Dependencies Jul 24, 2018

rgeniesse approved these changes Jul 24, 2018

View reviewed changes

cwjohnston approved these changes Jul 24, 2018

View reviewed changes

Merge branch 'master' into update/built-in-filters

895f2bf

apaskulin merged commit bbc30d1 into master Jul 24, 2018

apaskulin deleted the update/built-in-filters branch July 24, 2018 22:22

Blue0ctober removed the ready for review PR is ready to review label Jul 24, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added reference doc for Occurrences and Check_Dependencies #498

Added reference doc for Occurrences and Check_Dependencies #498

Blue0ctober commented Jun 14, 2018 •

edited

rgeniesse Jun 14, 2018 •

edited

asachs01 Jun 14, 2018

asachs01 Jun 14, 2018

apaskulin commented Jun 14, 2018

asachs01 commented Jun 15, 2018

cwjohnston Jun 21, 2018

Blue0ctober Jul 5, 2018

cwjohnston Jul 5, 2018

cwjohnston Jun 21, 2018

cwjohnston left a comment

cwjohnston Jul 5, 2018

asachs01 commented Jul 12, 2018

apaskulin left a comment

apaskulin Jul 18, 2018

apaskulin Jul 18, 2018

apaskulin Jul 18, 2018

apaskulin Jul 24, 2018

apaskulin Jul 24, 2018

cwjohnston Jul 24, 2018

rgeniesse Jul 24, 2018

apaskulin Jul 24, 2018 •

edited

rgeniesse Jul 24, 2018

rgeniesse left a comment

		{{< /highlight >}}


		The `occurrences` filter uses two custom check definition attributes, `occurrences`



		The `occurrences` filter uses two check definition attributes, `occurrences`
		and `refresh`.


		The occurrences filter lets you configure the number of occurrences and the refresh interval at the check level using two check definition attributes: `occurrences` and `refresh`.

		Here's an example of a check definition that passes events to the `email` handler starting with the third occurrence every 60 minutes:

Added reference doc for Occurrences and Check_Dependencies #498

Added reference doc for Occurrences and Check_Dependencies #498

Conversation

Blue0ctober commented Jun 14, 2018 • edited

Description

Motivation and Context

Types of changes

Checklist:

rgeniesse Jun 14, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

apaskulin commented Jun 14, 2018

asachs01 commented Jun 15, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cwjohnston left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

asachs01 commented Jul 12, 2018

apaskulin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

apaskulin Jul 24, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rgeniesse left a comment

Choose a reason for hiding this comment

Blue0ctober commented Jun 14, 2018 •

edited

rgeniesse Jun 14, 2018 •

edited

apaskulin Jul 24, 2018 •

edited