-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
117 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| # SignalFx Detectors | ||
| [](https://www.claranet.fr/) | ||
| [](LICENSE) | ||
| [](https://github.com/claranet/terraform-signalfx-detectors/releases) | ||
| [](https://github.com/claranet/terraform-signalfx-detectors/actions?query=workflow%3ADetectors) | ||
| [](https://github.com/hashicorp/terraform) | ||
| [](https://registry.terraform.io/modules/claranet/detectors/signalfx) | ||
|
|
||
| > Most alerting rules are common to every users. Here is a place to "rule" them all! :gift: :rotating_light: :metal: | ||
| <!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
| <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
| :link: **Contents** | ||
|
|
||
| - [:loudspeaker: Goal](#loudspeaker-goal) | ||
| - [:bell: Modules](#bell-modules) | ||
| - [:running: Usage](#running-usage) | ||
| - [:handshake: Contributing](#handshake-contributing) | ||
| - [:construction: Roadmap](#construction-roadmap) | ||
| - [:warning: Changelog](#warning-changelog) | ||
| - [:memo: License](#memo-license) | ||
|
|
||
| <!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
|
||
| ## :loudspeaker: Goal | ||
|
|
||
| This aims to speed up alerting deployment and apply infrastructure as code process | ||
| to monitoring. It could also be a place to collect, share and improve alerting rules | ||
| on popular tools and environments through SignalFx and Terraform. | ||
|
|
||
| __Note__: These templates implementation is opinionated and enforce best practices | ||
| which ensure homogeneity but will also restrict the usage and capabilities even if | ||
| it tries to provide as much flexibility as possible. | ||
|
|
||
| ## :bell: Modules | ||
|
|
||
| This repository consists in a collection of generic pre-built detectors for SignalFx | ||
| broken down into multiple terraform modules in [modules](./modules/README.md) directory. | ||
|
|
||
| Each module is fully independent and it is dedicated to monitor one service | ||
| thanks to the metrics and information it provides. It contains: | ||
|
|
||
| - Terraform source code to be use as module | ||
| - Readme file containing instructions and notes specific to work with the module. | ||
| - Source, dependencies and sample configuration for metrics collection. | ||
|
|
||
| ## :running: Usage | ||
|
|
||
| A module is a collection of [detectors | ||
| resource](https://registry.terraform.io/providers/splunk-terraform/signalfx/latest/docs/resources/detector) | ||
| with global and per-detector variables available to adapt the default alerting | ||
| behavior to suit your requirements chaning underlying detectors configuration | ||
| at deployment thanks to Terraform. | ||
|
|
||
| [Instructions in Wiki](https://github.com/claranet/terraform-signalfx-detectors/wiki). | ||
|
|
||
| ## :handshake: Contributing | ||
|
|
||
| Contributions from community are most welcome! | ||
|
|
||
| There are many ways to contribute: writing code, add or improve detectors, | ||
| documentation, reporting issues, discussing better error tracking... | ||
|
|
||
| [Instructions in CONTRUBITING.md](CONTRIBUTING.md). | ||
|
|
||
| ## :construction: Roadmap | ||
|
|
||
| You can go to [github | ||
| milestones](https://github.com/claranet/terraform-signalfx-detectors/milestones) | ||
| to know what is planned in future versions browsing [available | ||
| issues](https://github.com/claranet/terraform-signalfx-detectors/issues). | ||
|
|
||
| ## :warning: Changelog | ||
|
|
||
| Read carefully release notes of each [github | ||
| release](https://github.com/claranet/terraform-signalfx-detectors/releases) | ||
| before upgrading to a new version. | ||
|
|
||
| ## :memo: License | ||
|
|
||
| [Mozilla Public License](https://www.mozilla.org/en-US/MPL/) |