Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(TPG >= 5.27)!: Add intercept_children support for log sinks #229

Merged
merged 3 commits into from
Sep 5, 2024
Merged

feat(TPG >= 5.27)!: Add intercept_children support for log sinks #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9250f29
Add intercept_children support for log sinks
up2neck Sep 4, 2024
9cc32b9
Minimal google provider version chaged
up2neck Sep 5, 2024
3875121
Update version in examples
up2neck Sep 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Current version is 9.X. Upgrade guides:
- [4.X -> 5.0](/docs/upgrading_to_v5.0.md)
- [6.X -> 7.0](/docs/upgrading_to_v7.0.md)
- [8.X -> 9.0](/docs/upgrading_to_v9.0.md)
- [9.X -> 10.0](/docs/upgrading_to_v10.0.md)

## Usage

Expand All @@ -29,7 +30,7 @@ example that will configure a Cloud Storage destination and a log export at the
```hcl
module "log_export" {
source = "terraform-google-modules/log-export/google"
version = "~> 9.0"
version = "~> 10.0"
destination_uri = "${module.destination.destination_uri}"
filter = "severity >= ERROR"
log_sink_name = "storage_example_logsink"
Expand All @@ -40,7 +41,7 @@ module "log_export" {

module "destination" {
source = "terraform-google-modules/log-export/google//modules/storage"
version = "~> 9.0"
version = "~> 10.0"
project_id = "sample-project"
storage_bucket_name = "storage_example_bucket"
log_sink_writer_identity = "${module.log_export.writer_identity}"
Expand All @@ -63,6 +64,7 @@ so that all dependencies are met.
| exclusions | (Optional) A list of sink exclusion filters. | <pre>list(object({<br> name = string,<br> description = string,<br> filter = string,<br> disabled = bool<br> }))</pre> | `[]` | no |
| filter | The filter to apply when exporting logs. Only log entries that match the filter are exported. Default is '' which exports all logs. | `string` | `""` | no |
| include\_children | Only valid if 'organization' or 'folder' is chosen as var.parent\_resource.type. Determines whether or not to include children organizations/folders in the sink export. If true, logs associated with child projects are also exported; otherwise only logs relating to the provided organization/folder are included. | `bool` | `false` | no |
| intercept\_children | Only valid if 'organization' or 'folder' is chosen as var.parent\_resource.type. Whether or not to intercept logs from child projects. If true, matching logs will not match with sinks in child resources, except \_Required sinks. This sink will be visible to child resources when listing sinks. | `bool` | `false` | no |
| log\_sink\_name | The name of the log sink to be created. | `string` | n/a | yes |
| parent\_resource\_id | The ID of the GCP resource in which you create the log sink. If var.parent\_resource\_type is set to 'project', then this is the Project ID (and etc). | `string` | n/a | yes |
| parent\_resource\_type | The GCP resource in which you create the log sink. The value must not be computed, and must be one of the following: 'project', 'folder', 'billing\_account', or 'organization'. | `string` | `"project"` | no |
Expand Down
3 changes: 3 additions & 0 deletions docs/upgrading_to_v10.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Upgrading to Log Export v10.0

The v10.0 release of Log Export is a backwards incompatible release and features a new feature `intercept_children` for folder and oraganization logging sinks. Minimum provider version `5.27` ia required.
4 changes: 2 additions & 2 deletions examples/storage/billing_account/main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

module "log_export" {
source = "terraform-google-modules/log-export/google"
version = "~> 9.0"
version = "~> 10.0"

destination_uri = module.destination.destination_uri
log_sink_name = "storage_example_logsink"
Expand All @@ -27,7 +27,7 @@ module "log_export" {

module "destination" {
source = "terraform-google-modules/log-export/google//modules/storage"
version = "~> 9.0"
version = "~> 10.0"

project_id = var.project_id
storage_bucket_name = "storage_example_bucket"
Expand Down
4 changes: 2 additions & 2 deletions examples/storage/folder/main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ resource "random_string" "suffix" {

module "log_export" {
source = "terraform-google-modules/log-export/google"
version = "~> 9.0"
version = "~> 10.0"

destination_uri = module.destination.destination_uri
filter = "resource.type = gce_instance"
Expand All @@ -35,7 +35,7 @@ module "log_export" {

module "destination" {
source = "terraform-google-modules/log-export/google//modules/storage"
version = "~> 9.0"
version = "~> 10.0"

project_id = var.project_id
storage_bucket_name = "storage_folder_${random_string.suffix.result}"
Expand Down
4 changes: 2 additions & 2 deletions examples/storage/organization/main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ resource "random_string" "suffix" {

module "log_export" {
source = "terraform-google-modules/log-export/google"
version = "~> 9.0"
version = "~> 10.0"

destination_uri = module.destination.destination_uri
filter = "resource.type = gce_instance"
Expand All @@ -35,7 +35,7 @@ module "log_export" {

module "destination" {
source = "terraform-google-modules/log-export/google//modules/storage"
version = "~> 9.0"
version = "~> 10.0"

project_id = var.project_id
storage_bucket_name = "storage_org_${random_string.suffix.result}"
Expand Down
4 changes: 2 additions & 2 deletions examples/storage/project/main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ resource "random_string" "suffix" {

module "log_export" {
source = "terraform-google-modules/log-export/google"
version = "~> 9.0"
version = "~> 10.0"

destination_uri = module.destination.destination_uri
filter = "resource.type = gce_instance"
Expand All @@ -34,7 +34,7 @@ module "log_export" {

module "destination" {
source = "terraform-google-modules/log-export/google//modules/storage"
version = "~> 9.0"
version = "~> 10.0"

project_id = var.project_id
storage_bucket_name = "storage_project_${random_string.suffix.result}"
Expand Down
34 changes: 18 additions & 16 deletions main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,15 @@ resource "google_logging_project_sink" "sink" {

# Folder-level
resource "google_logging_folder_sink" "sink" {
count = local.is_folder_level ? 1 : 0
name = var.log_sink_name
description = var.description
folder = var.parent_resource_id
filter = var.filter
include_children = var.include_children
destination = var.destination_uri
disabled = var.disabled
count = local.is_folder_level ? 1 : 0
name = var.log_sink_name
description = var.description
folder = var.parent_resource_id
filter = var.filter
include_children = var.include_children
intercept_children = var.intercept_children
destination = var.destination_uri
disabled = var.disabled
dynamic "bigquery_options" {
for_each = local.bigquery_options
content {
Expand All @@ -95,14 +96,15 @@ resource "google_logging_folder_sink" "sink" {

# Org-level
resource "google_logging_organization_sink" "sink" {
count = local.is_org_level ? 1 : 0
name = var.log_sink_name
description = var.description
org_id = var.parent_resource_id
filter = var.filter
include_children = var.include_children
destination = var.destination_uri
disabled = var.disabled
count = local.is_org_level ? 1 : 0
name = var.log_sink_name
description = var.description
org_id = var.parent_resource_id
filter = var.filter
include_children = var.include_children
intercept_children = var.intercept_children
destination = var.destination_uri
disabled = var.disabled
dynamic "bigquery_options" {
for_each = local.bigquery_options
content {
Expand Down
6 changes: 6 additions & 0 deletions variables.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ variable "include_children" {
default = false
}

variable "intercept_children" {
description = "Only valid if 'organization' or 'folder' is chosen as var.parent_resource.type. Whether or not to intercept logs from child projects. If true, matching logs will not match with sinks in child resources, except _Required sinks. This sink will be visible to child resources when listing sinks."
type = bool
default = false
}

variable "log_sink_name" {
description = "The name of the log sink to be created."
type = string
Expand Down
2 changes: 1 addition & 1 deletion versions.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ terraform {

google = {
source = "hashicorp/google"
version = ">= 3.53, < 6"
version = ">= 5.27, < 6"
}
}

Expand Down