Skip to content

Commit

Permalink
Remove the graphite checks
Browse files Browse the repository at this point in the history
This is a breaking change. We're removing the various health check types
that rely on reading Graphite metrics because, as of Q3 2024, we will no
longer be able to read this data.

For now we recommend removing these checks from your apps. The alerts
aren't very commonly-used and we have better ways of monitoring uptime
now. If you still need alerts based on Graphite metrics then you can do
so by creating a dashboard in the grafana monorepo and adding alerts:

https://github.com/Financial-Times/grafana/tree/main/terraform/dashboards

See-Also: https://financialtimes.atlassian.net/browse/CPREL-1056
  • Loading branch information
rowanmanning committed May 13, 2024
1 parent a3fff51 commit 88c6fae
Show file tree
Hide file tree
Showing 15 changed files with 29 additions and 1,440 deletions.
26 changes: 6 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,34 +96,20 @@ Reports on the status of other checks. Useful if you have a multi-region service
- `'atLeastOne'` the check succeeds if at least one of its subchecks succeeds

#### `graphiteSpike`
Compares current and historical graphite metrics to see if there is a spike

* `numerator`: [required] Name of main graphite metric to count (may contain wildcards)
* `divisor`: [optional] Name of graphite metric to divide by (may contain wildcards)
* `normalize`: [optional] Boolean indicating whether to normalize to adjust for difference in size between sample and baseline timescales. Default is `true` if no divisor specified, `false` otherwise.
* `samplePeriod`: [default: `'10min'`] Length of time to count metrics for a sample of current behaviour
* `baselinePeriod`: [default: `'7d'`] Length of time to count metrics for to establish baseline behaviour
* `direction`: [default: `'up'`] Direction in which to look for spikes; 'up' = sharp increase in activity, 'down' = sharp decrease in activity
* `threshold`: [default: `3`] Amount of difference between current and baseline activity which registers as a spike e.g. 5 means current activity must be 5 times greater/less than the baseline activity
> [!CAUTION]
> The `graphiteSpike` check type has been removed. If you need to create alerts based on Graphite data you must now do so in the [grafana repo](https://github.com/Financial-Times/grafana).
#### `graphiteThreshold`
Checks whether the value of a graphite metric has crossed a threshold

* `metric`: [required] Name of graphite metric to count (may contain wildcards)
* `threshold`: [required] Value to check the metrics against
* `samplePeriod`: [default: `'10min'`] Length of time to count metrics for a sample of current behaviour
* `isConsistentBreach`: [default: `false`] Boolan value to dictate whether all data points need to have breached the defined threshold to fail the check
* `direction`: [default: `'above'`] Direction on which to trigger the healthcheck:
- `'above'` = alert if value goes above the threshold
- `'below'` = alert if value goes below the threshold
> [!CAUTION]
> The `graphiteThreshold` check type has been removed. If you need to create alerts based on Graphite data you must now do so in the [grafana repo](https://github.com/Financial-Times/grafana).
#### `graphiteWorking`

Checks if the value of a graphite metric has received data recently.

* `metric`: [required] Name of graphite metric to count (may contain wildcards)
- Use `summarize` if the metric receives data infrequently, e.g. `summarize(next.heroku.next-article.some-infrequent-periodic-metric, '30mins', 'sum', true)`
* `time`: [default: `'-5minutes'`] Length of time to count metrics
> [!CAUTION]
> The `graphiteWorking` check type has been removed. If you need to create alerts based on Graphite data you must now do so in the [grafana repo](https://github.com/Financial-Times/grafana).
#### `cloudWatchThreshold`
Checks whether the value of a CloudWatch metric has crossed a threshold
Expand Down
175 changes: 0 additions & 175 deletions src/checks/graphiteSpike.check.js

This file was deleted.

144 changes: 0 additions & 144 deletions src/checks/graphiteThreshold.check.js

This file was deleted.

Loading

0 comments on commit 88c6fae

Please sign in to comment.