feat(cloudsql): add support for enhanced query insights (#3948)
Adds support for enhanced query insights on cloud sql instances by adding enhanced_query_insights_enabled to the insights_config block. This allows enabling deeper visibility into query performance. Closes #3890 TAG=agy CONV=41331d43-c782-48a4-b0e7-bc8ad14866e9
This commit is contained in:
Ludovico Magnocavallo
committed by
GitHub
GitHub
parent
ef3af4fd28
commit
98554a9d20
@@ -415,11 +415,11 @@ module "db" {
|
||||
| name | description | type | required | default |
|
||||
|---|---|:---:|:---:|:---:|
|
||||
| [database_version](variables.tf#L96) | Database type and version to create. | <code>string</code> | ✓ | |
|
||||
| [name](variables.tf#L212) | Name of primary instance. | <code>string</code> | ✓ | |
|
||||
| [network_config](variables.tf#L217) | Network configuration for the instance. Only one between private_network and psc_config can be used. | <code>object({…})</code> | ✓ | |
|
||||
| [project_id](variables.tf#L260) | The ID of the project where this instances will be created. | <code>string</code> | ✓ | |
|
||||
| [region](variables.tf#L265) | Region of the primary instance. | <code>string</code> | ✓ | |
|
||||
| [tier](variables.tf#L317) | The machine type to use for the instances. | <code>string</code> | ✓ | |
|
||||
| [name](variables.tf#L213) | Name of primary instance. | <code>string</code> | ✓ | |
|
||||
| [network_config](variables.tf#L218) | Network configuration for the instance. Only one between private_network and psc_config can be used. | <code>object({…})</code> | ✓ | |
|
||||
| [project_id](variables.tf#L261) | The ID of the project where this instances will be created. | <code>string</code> | ✓ | |
|
||||
| [region](variables.tf#L266) | Region of the primary instance. | <code>string</code> | ✓ | |
|
||||
| [tier](variables.tf#L318) | The machine type to use for the instances. | <code>string</code> | ✓ | |
|
||||
| [activation_policy](variables.tf#L17) | This variable specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND. Default is ALWAYS. | <code>string</code> | | <code>"ALWAYS"</code> |
|
||||
| [availability_type](variables.tf#L28) | Availability type for the primary replica. Either `ZONAL` or `REGIONAL`. | <code>string</code> | | <code>"ZONAL"</code> |
|
||||
| [backup_configuration](variables.tf#L34) | Backup settings for primary instance. Set to null to leave existing GCP backup settings unmanaged. When set, all fields are managed by Terraform including disabling backups when enabled=false. | <code>object({…})</code> | | <code>null</code> |
|
||||
@@ -437,17 +437,17 @@ module "db" {
|
||||
| [flags](variables.tf#L137) | Map FLAG_NAME=>VALUE for database-specific tuning. | <code>map(string)</code> | | <code>null</code> |
|
||||
| [gcp_deletion_protection](variables.tf#L143) | Set Google's deletion protection attribute which applies across all surfaces (UI, API, & Terraform). | <code>bool</code> | | <code>true</code> |
|
||||
| [insights_config](variables.tf#L150) | Query Insights configuration. Defaults to null which disables Query Insights. | <code>object({…})</code> | | <code>null</code> |
|
||||
| [labels](variables.tf#L161) | Labels to be attached to all instances. | <code>map(string)</code> | | <code>null</code> |
|
||||
| [maintenance_config](variables.tf#L167) | Set maintenance window configuration and maintenance deny period (up to 90 days). Date format: 'yyyy-mm-dd'. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [managed_connection_pooling_config](variables.tf#L202) | Configuration for Managed Connection Pooling. NOTE: This feature is only available for PostgreSQL on Enterprise Plus edition instances. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [password_validation_policy](variables.tf#L236) | Password validation policy configuration for instances. | <code>object({…})</code> | | <code>null</code> |
|
||||
| [prefix](variables.tf#L250) | Optional prefix used to generate instance names. | <code>string</code> | | <code>null</code> |
|
||||
| [replicas](variables.tf#L270) | Map of NAME=> {REGION, KMS_KEY, AVAILABILITY_TYPE} for additional read replicas. Set to null to disable replica creation. | <code>map(object({…}))</code> | | <code>{}</code> |
|
||||
| [root_password](variables.tf#L281) | Root password of the Cloud SQL instance, or flag to create a random password. Required for MS SQL Server. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [ssl](variables.tf#L295) | Setting to enable SSL, set config and certificates. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [terraform_deletion_protection](variables.tf#L310) | Prevent terraform from deleting instances. | <code>bool</code> | | <code>true</code> |
|
||||
| [time_zone](variables.tf#L322) | The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format. | <code>string</code> | | <code>null</code> |
|
||||
| [users](variables.tf#L328) | Map of users to create in the primary instance (and replicated to other replicas). For MySQL, anything after the first `@` (if present) will be used as the user's host. Set PASSWORD to null if you want to get an autogenerated password. The user types available are: 'BUILT_IN', 'CLOUD_IAM_USER' or 'CLOUD_IAM_SERVICE_ACCOUNT'. | <code>map(object({…}))</code> | | <code>{}</code> |
|
||||
| [labels](variables.tf#L162) | Labels to be attached to all instances. | <code>map(string)</code> | | <code>null</code> |
|
||||
| [maintenance_config](variables.tf#L168) | Set maintenance window configuration and maintenance deny period (up to 90 days). Date format: 'yyyy-mm-dd'. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [managed_connection_pooling_config](variables.tf#L203) | Configuration for Managed Connection Pooling. NOTE: This feature is only available for PostgreSQL on Enterprise Plus edition instances. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [password_validation_policy](variables.tf#L237) | Password validation policy configuration for instances. | <code>object({…})</code> | | <code>null</code> |
|
||||
| [prefix](variables.tf#L251) | Optional prefix used to generate instance names. | <code>string</code> | | <code>null</code> |
|
||||
| [replicas](variables.tf#L271) | Map of NAME=> {REGION, KMS_KEY, AVAILABILITY_TYPE} for additional read replicas. Set to null to disable replica creation. | <code>map(object({…}))</code> | | <code>{}</code> |
|
||||
| [root_password](variables.tf#L282) | Root password of the Cloud SQL instance, or flag to create a random password. Required for MS SQL Server. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [ssl](variables.tf#L296) | Setting to enable SSL, set config and certificates. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [terraform_deletion_protection](variables.tf#L311) | Prevent terraform from deleting instances. | <code>bool</code> | | <code>true</code> |
|
||||
| [time_zone](variables.tf#L323) | The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format. | <code>string</code> | | <code>null</code> |
|
||||
| [users](variables.tf#L329) | Map of users to create in the primary instance (and replicated to other replicas). For MySQL, anything after the first `@` (if present) will be used as the user's host. Set PASSWORD to null if you want to get an autogenerated password. The user types available are: 'BUILT_IN', 'CLOUD_IAM_USER' or 'CLOUD_IAM_SERVICE_ACCOUNT'. | <code>map(object({…}))</code> | | <code>{}</code> |
|
||||
|
||||
## Outputs
|
||||
|
||||
|
||||
@@ -213,11 +213,12 @@ resource "google_sql_database_instance" "primary" {
|
||||
dynamic "insights_config" {
|
||||
for_each = var.insights_config != null ? [1] : []
|
||||
content {
|
||||
query_insights_enabled = true
|
||||
query_string_length = var.insights_config.query_string_length
|
||||
record_application_tags = var.insights_config.record_application_tags
|
||||
record_client_address = var.insights_config.record_client_address
|
||||
query_plans_per_minute = var.insights_config.query_plans_per_minute
|
||||
query_insights_enabled = true
|
||||
query_string_length = var.insights_config.query_string_length
|
||||
record_application_tags = var.insights_config.record_application_tags
|
||||
record_client_address = var.insights_config.record_client_address
|
||||
query_plans_per_minute = var.insights_config.query_plans_per_minute
|
||||
enhanced_query_insights_enabled = var.insights_config.enhanced_query_insights_enabled
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -150,10 +150,11 @@ variable "gcp_deletion_protection" {
|
||||
variable "insights_config" {
|
||||
description = "Query Insights configuration. Defaults to null which disables Query Insights."
|
||||
type = object({
|
||||
query_string_length = optional(number, 1024)
|
||||
record_application_tags = optional(bool, false)
|
||||
record_client_address = optional(bool, false)
|
||||
query_plans_per_minute = optional(number, 5)
|
||||
query_string_length = optional(number, 1024)
|
||||
record_application_tags = optional(bool, false)
|
||||
record_client_address = optional(bool, false)
|
||||
query_plans_per_minute = optional(number, 5)
|
||||
enhanced_query_insights_enabled = optional(bool, false)
|
||||
})
|
||||
default = null
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user