Releases: claranet/terraform-signalfx-detectors
v1.2.0
1.2.0 (February 23, 2021)
NEW FEATURES:
common
: addteams
atglobal
level only. it could be used to link detectors to teams (#239)generator
: supports disabling all alert rules of a detector (#244)generator
: supportslasting
definition for rule (#248)smart-agent_cassandra-nodetool
: new module (#227)smart-agent_couchbase
: new module (#236)integration_azure-storage-account-blob
: new module (#245)integration_azure-datafactory
: new module (#242)integration_azure-functions
: add error detector based on wrapper metric (#246)
ENHANCEMENTS:
generator
: use lasting for reverse rule also (#250)
BUG FIXES:
smart-agent_kubernetes-common
: fix oomkilled detector to avoid triggering alert repeatedly (#241)
v1.1.0
1.1.0 (January 11, 2021)
NOTES:
- The full list of detectors and severity is available on: https://github.com/claranet/terraform-signalfx-detectors/blob/master/docs/severity.md
make
targets are all be renamed and reworked, please check the development manual.
NEW FEATURES:
common
: addrunbook
variable atglobal
anddetector
levels. it could be used to link a documentation or dashboard link to help to understand the anomaly.common
: addtip
variable atdetector
level only. it could be used to insert mardown text to explain the check,possible causes of alert and even some tips to troubleshoot or resolve.common
: addteam_writers
atglobal
level only. it could be used to restrict permissions of detectors to a list of teams (#117)generator
: supportsunit
in alerting rules (#207)generator
: set theunit
asviz_options
(#107)generator
: supportsrollup
definition for metric (#211)generator
: supports additionalfilter
for metric (#231)generator
: supports custom ruledescription
and==
/!=
comparison logic (#233)smart-agent_cassandra-nodetool
: new module (#227)smart-agent_couchbase
: new module (#236)integration_azure-container-instance
: new module (#226)integration_azure-storage-account
: new module (#209)integration_azure-api-management-service
: new module (#199)integration_azure-event-hub
: new module (#204)integration_azure-application-gateway
: add capacity detector (#202)
ENHANCEMENTS:
makefile
bunch of improvements (see #223 for more detail) including module filter (#203)make
targets reworked to be clearer and easier to use (#230)smart-agent_nagios-status-check
: now uses the new nagios monitor adding events support (#201)integration_aws-elasticache
: lower free memory alerts severity (#219)
BUG FIXES:
- fix github issues templates broken caused by TOC comments
- fix severity detectors list sort (#238)
smart-agent_kubernetes-common
: fix typo in id (#224)integration_azure-app-service
: heartbeat uses fill instead of extrapolation to avoid wrong aggregation resultintegration_azure-storage-account-capacity
: fixUsedCapacity
scaling unit (#200)integration_azure-app-service
: fix false result replacing extrapolation byfill
(#198)
DOCUMENTATION:
- the environment, usage and development docs have been updated on commands usage (#237)
- add global severity matrix and replaces the detectors list in modules readmes (#234)
- the development manual has been updated including a TLDR and aims to be easier to start contributing.
- modules readme now includes all required metrics with a config sample for smart agent (#228)
- windows and macos requirements added to environment manual
v1.0.0
1.0.0 (December 7, 2020)
UPGRADE NOTES:
- The terraform modules
source
path in your stack configuration requires to be updated to use to new module path in/modules
root directory to meet terraform registry requirements.
Please follow this doc to update any existing configuration. - You can use, if you prefer, the terraform registry from now as source instead of the
git
orgithub
source types.
BREAKING CHANGES:
- All existing stack configuration using path from the old tree structure will fail for every modules using
v1+
tag with the error "no module found"
The tagv0.4.1
contains exactly same features thanv1.0.0
on the detectors scope and it will be the last one supporting tree structure.
NOTES:
- It has the same functional scope than https://github.com/claranet/terraform-signalfx-detectors/releases/tag/v0.4.1 and if resource is preserved in the state file after upgrade you should not see any diff. Its changes mainly focus move from tree to flat structure, enrich documentation, improve CI and provide tooling to help developer to contribute
- It is the first version compatible with the terraform registry using a flat structure. All modules are now available here as a flat directories list.
NEW FEATURES:
- provide full modules list and one
stack
example in terraform registry which become the documentation start point to use a module. - rework and refactor
scripts
splitting them into 2 directoriesmodule
to work on modules changes as dev orstack
to generate terraform source to use by end user. - modules readmes are all generated from a template with a jinja based generator
- detector generator: add support for extrapolation, vm filters, heartbeat subject
- convert most of the detectors from
system-common
module into yaml configuration as example of using yaml config files and the generator to create new detectors - add a new makefile which help to setup the tooling environment and perform automation tasks like generate detectors from config files, auto update readme, bootstrap a new module or a new stack..
DOCUMENTATION:
Documentation exist in 2 locations: inside this repository and inside its wiki. Each one has a different purpose.
-
In the repo and especially
docs
root directory, the documentation provides an operational quick start. The users can learn how to deploy detectors easily to test before to go deeper.
The developers will find tasks to do for every common types of changes known like creating a new detector or a new module. -
Wiki has been improved to provides a conceptual understanding with everything useful to go further in the usage or the development of this project. Users will find advanced usages tricks or tips and more detailed procedures. Developers could learn how it works under the hood to propose global enhancements which could impact all modules.
v0.4.1
v0.4.0
0.4.0 (November 27, 2020)
NOTES:
- the generator has been improved and the same logic has been used to generate modules readme in addition to the detectors.
- this version reworks the
scripts
andcommon
root directories organization which is used only internally (i.e. by the CI) so there is not breaking change for the user - more "common" files have been used to "share" same code with symlink from detectors modules like for
version.tf
ormodules.tf
.
NEW FEATURES:
- add MPL Licence (#138)
- add Code of conduct (#140)
- add how to contribute (#160)
- add issues templates for users reporting (#136)
- generate readme of all detectors modules from yaml config (#97)
- aws-ecs-*: add readme with note about fargate/ec2 split (#97)
- tomcat: add new detectors module (#162)
- memcached: add new detectors module (#170)
- mongodb: add new detectors module (#120)
- varnish: add heartbeat detector (#169)
- azure-cosmosdb: add ru capacity detector (#163)
- azure-servicebus: add throttling detector (#167)
ENHANCEMENTS:
- CI speed up, refactor, upgrade setup modules and limit execution to changes scope only (#109)
- azure-cosmosdb: cleanup unused dependencies (#166)
- elasticsearch: remove not relevant evictions detectors (#173)
- rabbitmq-broker: aggregate per broker by default (#176)
- http: handle the case where different monitors produce datapoints on the same MTS (#178)
- haproxy: filter only on
server
andfrontend
by default to avoid unnecessary alerts (#189)
BUG FIXES:
v0.3.0
0.3.0 (October 27, 2020)
NOTES:
- This version provides a beta generator for heartbeat and thresholds based detectors. More documentation and a script to bootstrap a whole new module will come in v1.0.0.
NEW FEATURES:
- provide a jinja template based generator for new detectors (#156)
- azure-virtual-machine-scaleset: add new detectors module (#144)
- cassandra: add new detectors module (#152)
- genericjmx: add new detectors module (#151)
- azure-postgresql: add serverlog storage detector (#135)
- mysql: add slave_io_running status detector (#147)
ENHANCEMENTS:
v0.2.0
0.2.0 (October 13, 2020)
UPGRADE NOTES:
notifications
global variable assignation should be updated usingobject
and defining every severities. This is a requirement to avoid undesired or missing binding caused by old behavior. Please check this change to see an example of upgrade.
BREAKING CHANGES:
notifications
global variable is now anobject
where attributes represents every SignalFx severities (Critical
,Major
,Minor
,Warning
,Info
) for safer assignation[my_detector]_notifications
is now amap(string)
to ease overriding- Most of the existing
Warning
rules (from Datadog legacy) have been changed toMajor
NOTES:
- exception on AWS API Gateway v2 which does not sync tags
NEW FEATURES:
- use rich types for easier and safer notifications assignation (#94)
- subject message template from locals symlink (#114)
- detector name prefix from locals symlink (#114)
- heartbeat / not running vm filters from locals symlink (#114)
- generate outputs and auto check them in CI (#92)
- add code owners / default reviewers with @cvauvarin @Shr3ps @BzSpi and @xp-1000
- aggregation variable for heartbeat detectors (#95)
- body message template from symlink (#114)
- add
common-locals.tf
file to share locals from symlink (#114) - add
common-variables.tf
file to share variables from symink (#114) - newrelic: add new detectors module (#17)
ENHANCEMENTS:
- upgrade
setup-terraform
tov1.2.0
in github actions CI - severities have been reordered to follow SignalFx levels convention (
Critical
>Major
>Warning
) (#93) - azure-*: harmonize azure heartbeat filters
- aws-apigateway: support AWS API Gateway v2 from
is_v2
flag variable (#130) - azure-mysql: add replication lag detector (#125)
- nagios-status-check: change unknown alert to use existing
Major
severity
BUG FIXES:
- fix typo on transformation functions descriptions removing trailing
)
- fix bad naming changing
system not reporting
byheartbeat
- azure-app-service: exclude
Instance
in aggregation function - elasticsearch: swapping red and yellow for status detector
- varnish: make variables declaration and notifications overrides compliant
- varnish: fix missing value in rules subjects
- docker: fix aggregation on heartbeat detector missing array
- kubernetes-* fix heartbeat detectors changing
ruleName
toreadableRule
v0.1.1
0.1.1 (September 25, 2020)
ENHANCEMENTS:
- kubernetes-common: update agent config with job extra metrics
- kubernetes-common: exclude (cron)job from pod phase detector redundant with job detector
BUG FIXES:
- fix terraform 0.13 compat using new provider name
- velero: removing missing
kubernetes_namespace
dimension - kubernetes-common: job detector dropping aggregation, adding lasting and extrapolation
- docker: fix kubernetes link in readme
- nginx-ingress: fix chart on latency detector adding missing publish
v0.1.0
0.1.0 (September 11, 2020)
First release 🎉 which integrates the entire perimeter from https://github.com/claranet/terraform-datadog-monitors and more!
- all modules from original repos has been reworked (not simply translated)
- fixes multiple bugs from original repo (i.e. elasticsearch latencies, azure metrics changes ..)
- lot of improvements taking advantages of our experience but also the richness of signalflow (i.e. lasting function)
- add new modules like http, ntp, haproxy, rabbitmq and more
- terraform code updated to take advantage of HCL 2 features
- more variables and more overriding capabilities to increase the level of customization
- modules compatible with terraform >= 0.12.26 (including 0.13)
Next release will come soon focusing on homogenization, documentation and organization:
- publish on the terraform registry
- reorganize the repo as flat modules list
- modules doc auto generated
- CI improvements
- a main README to explain the purpose of this repo and provide tips and guidance about modules usage