From 0034d8a9fe0e58ad0ae2ceb5d587d1412115466f Mon Sep 17 00:00:00 2001 From: Patrick de Ruiter Date: Sat, 1 Nov 2025 10:43:45 +0100 Subject: [PATCH] Initial commit with README and module files --- .gitignore | 0 CHANGELOG.md | 0 LICENSE | 201 --------------------- README.md | 299 ++++++++++++++++++++++++++++++-- examples/main.tf | 0 examples/outputs.tf | 0 external.tf | 0 main.tf | 0 outputs.tf | 0 providers.tf | 0 terraform-cloud-ci/main.tf | 0 terraform-cloud-ci/outputs.tf | 0 terraform-cloud-ci/variables.tf | 0 variables.tf | 0 14 files changed, 286 insertions(+), 214 deletions(-) mode change 100644 => 100755 .gitignore mode change 100644 => 100755 CHANGELOG.md delete mode 100644 LICENSE mode change 100644 => 100755 README.md mode change 100644 => 100755 examples/main.tf mode change 100644 => 100755 examples/outputs.tf mode change 100644 => 100755 external.tf mode change 100644 => 100755 main.tf mode change 100644 => 100755 outputs.tf mode change 100644 => 100755 providers.tf mode change 100644 => 100755 terraform-cloud-ci/main.tf mode change 100644 => 100755 terraform-cloud-ci/outputs.tf mode change 100644 => 100755 terraform-cloud-ci/variables.tf mode change 100644 => 100755 variables.tf diff --git a/.gitignore b/.gitignore old mode 100644 new mode 100755 diff --git a/CHANGELOG.md b/CHANGELOG.md old mode 100644 new mode 100755 diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 261eeb9..0000000 --- a/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/README.md b/README.md old mode 100644 new mode 100755 index 2df2f2a..fd9cd0b --- a/README.md +++ b/README.md @@ -1,19 +1,292 @@ -# terraform module for autogenerating dashboards based on prefixed metrics +# Terraform Datadog Dashboard Module -The Terraform Datadog provider does not offer a way to autodiscover metrics, however, -Datadog API can do this via [GET /v1/metrics](https://docs.datadoghq.com/api/?lang=python#get-list-of-active-metrics) +## Overview -This terraform module uses an external data source [list_metrics.sh](https://github.com/borgified/terraform-datadog-dashboard/blob/master/list_metrics.sh) to fetch a list of -all available metrics filtered by a prefix so that this subset of metrics can be used as input to the [datadog_dashboard](https://www.terraform.io/docs/providers/datadog/r/dashboard.html) -resource. +This Terraform module creates dynamic Datadog dashboards from metrics discovered in Datadog, with flexible filtering and aggregation options. It uses an external script to query available metrics and automatically generates dashboard widgets. -For example, if you have these metrics in Datadog: +## Features + +- **Dynamic Metric Discovery**: Queries Datadog API for available metrics by prefix +- **Auto-Generated Widgets**: Creates timeseries widgets automatically from metrics +- **Template Variables**: Interactive filtering via dashboard variables +- **Dual Creation Modes**: Metric discovery vs. pre-defined metric list +- **Metric Aliasing**: Metadata expressions for cleaner metric names + +## Resources Created + +- `datadog_dashboard`: Dynamically generated dashboard with timeseries widgets + +## Requirements + +| Name | Version | +|------|---------| +| terraform | >= 0.12 | +| datadog | >= 2.0 | +| bash | For list_metrics.sh script | + +## Usage + +### Mode 1: Metric Discovery by Prefix + +```hcl +module "dynamic_dashboard" { + source = "./terraform-datadog-dashboard" + + title = "Application Metrics Dashboard" + api_key = var.datadog_api_key + app_key = var.datadog_app_key + prefix = "myapp.*" + space_aggregation = "avg" + scope = "environment:production,service:api" + description = "Auto-generated dashboard for application metrics" +} ``` -app.dev.memstats.alloc -app.dev.memstats.frees -app.dev.memstats.heap_released -... +### Mode 2: Pre-Defined Metrics List + +```hcl +module "custom_dashboard" { + source = "./terraform-datadog-dashboard" + + title = "Custom Metrics Dashboard" + api_key = var.datadog_api_key + app_key = var.datadog_app_key + prefix = "" + space_aggregation = "sum" + scope = "env:prod" + metrics_list = "metric1,metric2,metric3" + description = "Dashboard with specific metrics" +} ``` -then specify prefix = "app.dev.memstats" as your input to get a dashboard of all metrics -starting with that prefix. + +## Inputs + +| Name | Description | Type | Required | Default | +|------|-------------|------|----------|---------| +| `title` | Dashboard title | `string` | no | `"my dashboard"` | +| `api_key` | Datadog API key | `string` | yes | - | +| `app_key` | Datadog APP key | `string` | yes | - | +| `prefix` | Metric prefix pattern for discovery | `string` | yes | - | +| `space_aggregation` | Aggregation method (avg, max, min, sum) | `string` | yes | - | +| `scope` | Tag scope for filtering | `string` | yes | - | +| `description` | Dashboard description | `string` | no | `"generated by Terraform"` | +| `metrics_list` | Comma-separated list of metrics (alternative to prefix) | `string` | no | `""` | +| `template_variable_name` | Name of template variable | `string` | no | `"variable1"` | +| `template_variable_prefix` | Prefix of template variable | `string` | no | `""` | +| `template_variable_default` | Default value for template variable | `string` | no | `"*"` | + +## Outputs + +| Output | Description | +|--------|-------------| +| `url` | Dashboard URL (https://app.datadoghq.com/dashboard/{id}) | +| `external_metrics` | List of metrics discovered from Datadog | + +## External Script + +The module uses `list_metrics.sh` to query the Datadog API: + +```bash +#!/bin/bash +# list_metrics.sh +# Queries Datadog for metrics matching the prefix pattern +``` + +The script is called via the `external` data source: +```hcl +data "external" "metrics" { + program = ["bash", "${path.module}/list_metrics.sh"] + + query = { + api_key = var.api_key + app_key = var.app_key + prefix = var.prefix + } +} +``` + +## Dashboard Creation Logic + +The module uses conditional resource creation: + +- **dashboard_a**: Created when using metric discovery (prefix-based) +- **dashboard_b**: Created when using pre-defined metrics list +- Only ONE dashboard is created based on which mode is used + +```hcl +count = var.metrics_list == "" ? 1 : 0 # dashboard_a +count = var.metrics_list != "" ? 1 : 0 # dashboard_b +``` + +## Template Variables + +The dashboard includes a template variable for interactive filtering: + +```hcl +template_variable { + name = var.template_variable_name + prefix = var.template_variable_prefix + default = var.template_variable_default +} +``` + +Example: Filter by environment, host, service, etc. + +## Widget Configuration + +Each discovered metric gets a timeseries widget: +- **Display Type**: Line graph +- **Aggregation**: Configured via `space_aggregation` variable +- **Scope**: Filtered by `scope` variable +- **Alias**: Metadata expression for cleaner names + +```hcl +request { + q = "${var.space_aggregation}:${metric.value}{${var.scope}}" + + metadata { + expression = "${var.space_aggregation}:${metric.value}{${var.scope}}" + alias_name = metric.value + } +} +``` + +## Aggregation Methods + +Supported aggregation methods: +- `avg`: Average values +- `max`: Maximum values +- `min`: Minimum values +- `sum`: Sum of values + +## Scope Filtering + +Scope uses Datadog tag syntax: +``` +environment:production # Single tag +environment:production,service:api # Multiple tags (AND) +environment:production OR service:api # OR logic +environment:prod* # Wildcard +``` + +## Examples + +### CPU Metrics Dashboard + +```hcl +module "cpu_dashboard" { + source = "./terraform-datadog-dashboard" + + title = "CPU Utilization Dashboard" + prefix = "system.cpu.*" + space_aggregation = "avg" + scope = "env:production" + api_key = var.datadog_api_key + app_key = var.datadog_app_key +} +``` + +### Custom Application Dashboard + +```hcl +module "app_dashboard" { + source = "./terraform-datadog-dashboard" + + title = "Application Performance" + prefix = "myapp.performance.*" + space_aggregation = "max" + scope = "service:myapp,env:prod" + + template_variable_name = "host" + template_variable_prefix = "host" + template_variable_default = "*" + + api_key = var.datadog_api_key + app_key = var.datadog_app_key +} +``` + +### Pre-Defined Metrics + +```hcl +module "specific_metrics" { + source = "./terraform-datadog-dashboard" + + title = "Key Metrics" + prefix = "" # Not used in this mode + space_aggregation = "avg" + scope = "env:prod" + metrics_list = "aws.ec2.cpuutilization,aws.rds.database_connections,custom.metric.value" + api_key = var.datadog_api_key + app_key = var.datadog_app_key +} +``` + +## Layout + +- **Layout Type**: Ordered (widgets stacked vertically) +- **Widget Type**: Timeseries +- **Auto-Generated**: One widget per discovered metric + +## Notes + +- Requires external bash script (`list_metrics.sh`) in module directory +- Script must be executable (`chmod +x list_metrics.sh`) +- Metric discovery happens during Terraform plan/apply +- Dashboard updates automatically when new metrics appear +- Uses `external` data source which runs on every plan +- Consider caching if metric list is large and changes infrequently + +## Troubleshooting + +### Script Execution Issues + +Ensure the script is executable: +```bash +chmod +x terraform-datadog-dashboard/list_metrics.sh +``` + +### No Metrics Discovered + +- Verify API/APP keys have correct permissions +- Check that metrics matching prefix exist in Datadog +- Confirm metric prefix syntax (e.g., "myapp.*" not "myapp*") + +### Dashboard Not Created + +- Check if metrics_list vs prefix logic is correct +- Verify exactly one creation mode is used (not both) + +## Best Practices + +1. **Prefix Naming**: Use specific prefixes to limit widget count +2. **Aggregation**: Choose appropriate aggregation for metric type +3. **Scope**: Use specific scopes to reduce cardinality +4. **Template Variables**: Add variables for interactive filtering +5. **Testing**: Test metric discovery in dev before production + +## Limitations + +- One dashboard per module instance +- Script runs on every plan (can be slow with many metrics) +- Ordered layout only (no custom positioning) +- All widgets are timeseries type +- No support for mixed widget types + +## Future Enhancements + +Potential improvements: +- Widget type customization +- Free layout support +- Widget positioning control +- Query value widgets +- Toplist widgets +- Note widgets for organization + +## License + +Internal use only - Sanoma/WeBuildYourCloud + +## Authors + +Created and maintained by the Platform Engineering team. diff --git a/examples/main.tf b/examples/main.tf old mode 100644 new mode 100755 diff --git a/examples/outputs.tf b/examples/outputs.tf old mode 100644 new mode 100755 diff --git a/external.tf b/external.tf old mode 100644 new mode 100755 diff --git a/main.tf b/main.tf old mode 100644 new mode 100755 diff --git a/outputs.tf b/outputs.tf old mode 100644 new mode 100755 diff --git a/providers.tf b/providers.tf old mode 100644 new mode 100755 diff --git a/terraform-cloud-ci/main.tf b/terraform-cloud-ci/main.tf old mode 100644 new mode 100755 diff --git a/terraform-cloud-ci/outputs.tf b/terraform-cloud-ci/outputs.tf old mode 100644 new mode 100755 diff --git a/terraform-cloud-ci/variables.tf b/terraform-cloud-ci/variables.tf old mode 100644 new mode 100755 diff --git a/variables.tf b/variables.tf old mode 100644 new mode 100755