kennel 1.53.0 → 1.53.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/Readme.md +16 -12
  3. data/lib/kennel/version.rb +1 -1
  4. data/template/Readme.md +19 -14
  5. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 95c82242166781e34d9132c511942a71c45c480951cb4b986702479cca60e271
4
- data.tar.gz: 44ab3de5ad5709b6be941bfc8706ae4b712f94a3d1b9ae75a2f028a4e2c42926
3
+ metadata.gz: 6a39dd7d2e69ff27625b450457e54c3e57ff2e0950e10f239f6b14d28dc0826b
4
+ data.tar.gz: 4effd0e4f0428a9e065e7b1e272115356aa352749a7dc11b1aaadf657a6cd81e
5
5
  SHA512:
6
- metadata.gz: eb2bf40bccca3072b58c6eb7e7342de8ed51f6a716eba29eb5d717aeb013da18e082fdc0b4565fa666d6a7146d8dd77bc085f343b06d08fb81a285da7d64d520
7
- data.tar.gz: be449f1b2c32d1f5996d16d17baa3e215c4446ae2ce4c865bd3cb160baece6bd8f56049cc7e29a56f025339a660ba474b6258fc042d808222a156cc2eb90f8e5
6
+ metadata.gz: '0930a5440d6c4d7ced1f838d8c5489f8899064b4a7ba8b12dba2a3c7daea71eab51e797667ee8ede2e496200316fe1244f230ed95f9aa12bbcc1ceb5d361ecad'
7
+ data.tar.gz: 56e685b04a6fb73cfb273d6af73fab31f8daf901266acd7934892fff2dc17113c99cf0f4b70e5d9cca9f4f208fce36bc98f6702b3d027fdb059fe058c40d78d0
data/Readme.md CHANGED
@@ -42,8 +42,9 @@ Keep datadog monitors/dashboards/etc in version control, avoid chaotic managemen
42
42
  - `gem install bundler && bundle install`
43
43
  - `cp .env.example .env`
44
44
  - open [Datadog API Settings](https://app.datadoghq.com/account/settings#api)
45
- - find or create your personal "Application Key" and add it to `.env` as `DATADOG_APP_KEY=` (will be on the last page if new)
46
45
  - copy any `API Key` and add it to `.env` as `DATADOG_API_KEY`
46
+ - find or create your personal "Application Key" and add it to `.env` as `DATADOG_APP_KEY=` (will be on the last page if new)
47
+ - change the `DATADOG_SUBDOMAIN=app` in `.env` to your companies subdomain if you have one
47
48
  -->
48
49
 
49
50
  ### Adding a team
@@ -53,8 +54,8 @@ Keep datadog monitors/dashboards/etc in version control, avoid chaotic managemen
53
54
  module Teams
54
55
  class MyTeam < Kennel::Models::Team
55
56
  defaults(
56
- slack: -> { "my-alerts" },
57
- email: -> { "my-team@example.com" }
57
+ slack: -> { "my-alerts" }, # where to send alerts
58
+ email: -> { "my-team@example.com" } # optional
58
59
  )
59
60
  end
60
61
  end
@@ -62,13 +63,14 @@ end
62
63
 
63
64
  ### Adding a new monitor
64
65
  - use [datadog monitor UI](https://app.datadoghq.com/monitors#create/metric) to create a monitor
65
- - get the `id` from the url
66
- - `RESOURCE=monitor ID=12345 bundle exec rake kennel:import`
67
66
  - see below
68
67
 
69
68
  ### Updating an existing monitor
69
+ - use [datadog monitor UI](https://app.datadoghq.com/monitors#create/metric) to find a monitor
70
+ - get the `id` from the url
71
+ - run `RESOURCE=monitor ID=12345 bundle exec rake kennel:import` and copy the output
70
72
  - find or create a project in `projects/`
71
- - add a monitor to `parts: [` list
73
+ - add the monitor to `parts: [` list, for example:
72
74
  ```Ruby
73
75
  # projects/my_project.rb
74
76
  class MyProject < Kennel::Models::Project
@@ -83,7 +85,8 @@ end
83
85
  kennel_id: -> { "load-too-high" }, # make up a unique name
84
86
  name: -> { "Foobar Load too high" }, # nice descriptive name that will show up in alerts and emails
85
87
  message: -> {
86
- # Explain what behavior to expect and how to fix the cause. Use #{super()} to add team notifications.
88
+ # Explain what behavior to expect and how to fix the cause
89
+ # Use #{super()} to add team notifications.
87
90
  <<~TEXT
88
91
  Foobar will be slow and that could cause Barfoo to go down.
89
92
  Add capacity or debug why it is suddenly slow.
@@ -98,21 +101,22 @@ end
98
101
  )
99
102
  end
100
103
  ```
101
- - `bundle exec rake plan` update to existing should be shown (not Create / Delete)
102
- - alternatively: `bundle exec rake generate` to only update the generated `json` files
104
+ - run `PROJECT=my_project bundle exec rake plan`, an Update to the existing monitor should be shown (not Create / Delete)
105
+ - alternatively: `bundle exec rake generate` to only locally update the generated `json` files
103
106
  - review changes then `git commit`
104
107
  - make a PR ... get reviewed ... merge
105
108
  - datadog is updated by travis
106
109
 
107
110
  ### Adding a new dashboard
108
111
  - go to [datadog dashboard UI](https://app.datadoghq.com/dashboard/lists) and click on _New Dashboard_ to create a dashboard
109
- - get the `id` from the url
110
- - `RESOURCE=dashboard ID=abc-def-ghi bundle exec rake kennel:import`
111
112
  - see below
112
113
 
113
114
  ### Updating an existing dashboard
115
+ - go to [datadog dashboard UI](https://app.datadoghq.com/dashboard/lists) and click on _New Dashboard_ to find a dashboard
116
+ - get the `id` from the url
117
+ - run `RESOURCE=dashboard ID=abc-def-ghi bundle exec rake kennel:import` and copy the output
114
118
  - find or create a project in `projects/`
115
- - add a dashboard to `parts: [` list
119
+ - add a dashboard to `parts: [` list, for example:
116
120
  ```Ruby
117
121
  class MyProject < Kennel::Models::Project
118
122
  defaults(
data/lib/kennel/version.rb CHANGED
@@ -1,4 +1,4 @@
1
1
  # frozen_string_literal: true
2
2
  module Kennel
3
- VERSION = "1.53.0"
3
+ VERSION = "1.53.1"
4
4
  end
data/template/Readme.md CHANGED
@@ -25,8 +25,9 @@ Keep datadog monitors/dashboards/etc in version control, avoid chaotic managemen
25
25
  - `gem install bundler && bundle install`
26
26
  - `cp .env.example .env`
27
27
  - open [Datadog API Settings](https://app.datadoghq.com/account/settings#api)
28
- - find or create your personal "Application Key" and add it to `.env` as `DATADOG_APP_KEY=` (will be on the last page if new)
29
28
  - copy any `API Key` and add it to `.env` as `DATADOG_API_KEY`
29
+ - find or create your personal "Application Key" and add it to `.env` as `DATADOG_APP_KEY=` (will be on the last page if new)
30
+ - change the `DATADOG_SUBDOMAIN=app` in `.env` to your companies subdomain if you have one
30
31
 
31
32
  ### Adding a team
32
33
 
@@ -35,8 +36,8 @@ Keep datadog monitors/dashboards/etc in version control, avoid chaotic managemen
35
36
  module Teams
36
37
  class MyTeam < Kennel::Models::Team
37
38
  defaults(
38
- slack: -> { "my-alerts" },
39
- email: -> { "my-team@example.com" }
39
+ slack: -> { "my-alerts" }, # where to send alerts
40
+ email: -> { "my-team@example.com" } # optional
40
41
  )
41
42
  end
42
43
  end
@@ -44,13 +45,14 @@ end
44
45
 
45
46
  ### Adding a new monitor
46
47
  - use [datadog monitor UI](https://app.datadoghq.com/monitors#create/metric) to create a monitor
47
- - get the `id` from the url
48
- - `RESOURCE=monitor ID=12345 bundle exec rake kennel:import`
49
48
  - see below
50
49
 
51
50
  ### Updating an existing monitor
51
+ - use [datadog monitor UI](https://app.datadoghq.com/monitors#create/metric) to find a monitor
52
+ - get the `id` from the url
53
+ - run `RESOURCE=monitor ID=12345 bundle exec rake kennel:import` and copy the output
52
54
  - find or create a project in `projects/`
53
- - add a monitor to `parts: [` list
55
+ - add the monitor to `parts: [` list, for example:
54
56
  ```Ruby
55
57
  # projects/my_project.rb
56
58
  class MyProject < Kennel::Models::Project
@@ -65,7 +67,8 @@ end
65
67
  kennel_id: -> { "load-too-high" }, # make up a unique name
66
68
  name: -> { "Foobar Load too high" }, # nice descriptive name that will show up in alerts and emails
67
69
  message: -> {
68
- # Explain what behavior to expect and how to fix the cause. Use #{super()} to add team notifications.
70
+ # Explain what behavior to expect and how to fix the cause
71
+ # Use #{super()} to add team notifications.
69
72
  <<~TEXT
70
73
  Foobar will be slow and that could cause Barfoo to go down.
71
74
  Add capacity or debug why it is suddenly slow.
@@ -80,21 +83,22 @@ end
80
83
  )
81
84
  end
82
85
  ```
83
- - `bundle exec rake plan` update to existing should be shown (not Create / Delete)
84
- - alternatively: `bundle exec rake generate` to only update the generated `json` files
86
+ - run `PROJECT=my_project bundle exec rake plan`, an Update to the existing monitor should be shown (not Create / Delete)
87
+ - alternatively: `bundle exec rake generate` to only locally update the generated `json` files
85
88
  - review changes then `git commit`
86
89
  - make a PR ... get reviewed ... merge
87
90
  - datadog is updated by travis
88
91
 
89
92
  ### Adding a new dashboard
90
93
  - go to [datadog dashboard UI](https://app.datadoghq.com/dashboard/lists) and click on _New Dashboard_ to create a dashboard
91
- - get the `id` from the url
92
- - `RESOURCE=dashboard ID=abc-def-ghi bundle exec rake kennel:import`
93
94
  - see below
94
95
 
95
96
  ### Updating an existing dashboard
97
+ - go to [datadog dashboard UI](https://app.datadoghq.com/dashboard/lists) and click on _New Dashboard_ to find a dashboard
98
+ - get the `id` from the url
99
+ - run `RESOURCE=dashboard ID=abc-def-ghi bundle exec rake kennel:import` and copy the output
96
100
  - find or create a project in `projects/`
97
- - add a dashboard to `parts: [` list
101
+ - add a dashboard to `parts: [` list, for example:
98
102
  ```Ruby
99
103
  class MyProject < Kennel::Models::Project
100
104
  defaults(
@@ -138,8 +142,9 @@ to unblock use the `validate: -> { false }` option.
138
142
 
139
143
  ### Monitor re-notification
140
144
 
141
- Monitors inherit the re-notification setting from their projects team.
142
- By default this is `renotify_interval: -> { 120 }` minutes, which will make alerts not get ignored by popping back up.
145
+ Monitors inherit the re-notification setting from their `project.team`.
146
+ Set this to for example `renotify_interval: -> { 120 }` minutes,
147
+ to make alerts not get ignored by popping back up if they are still alerting.
143
148
 
144
149
  ### Linking with kennel_ids
145
150
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: kennel
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.53.0
4
+ version: 1.53.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Michael Grosser