Changes to log configuration docs (#148)

integration and related resources doc improvements
yugabyte · Jan 24, 2025 · 7cb7962 · 7cb7962
1 parent ef41639
commit 7cb7962
Show file tree

Hide file tree

Showing 10 changed files with 26 additions and 22 deletions.
diff --git a/docs/resources/associate_metrics_exporter_cluster.md b/docs/resources/associate_metrics_exporter_cluster.md
@@ -1,12 +1,12 @@
 ---
 page_title: "ybm_associate_metrics_exporter_cluster Resource - YugabyteDB Aeon"
 description: |-
-  The resource to manage metrics export configuration for a cluster in YugabyteDB Aeon.
+  Use this resource to assign an export configuration (created using the ybm_integration resource) to a cluster for the export of cluster metrics. When assigned, cluster metrics are exported to the sink defined in the export configuration.
 ---
 
 # ybm_associate_metrics_exporter_cluster (Resource)
 
-The resource to manage metrics export configuration for a cluster in YugabyteDB Aeon.
+Use this resource to assign an export configuration (created using the `ybm_integration` resource) to a cluster for the export of cluster metrics. When assigned, cluster metrics are exported to the sink defined in the export configuration.
 
 
 ## Example Usage

diff --git a/docs/resources/cluster.md b/docs/resources/cluster.md
@@ -616,7 +616,7 @@ resource "ybm_private_service_endpoint" "npsenonok-region" {
 - `cluster_allow_list_ids` (List of String) List of IDs of the allow lists assigned to the cluster.
 - `cmk_spec` (Attributes) KMS Provider Configuration. (see [below for nested schema](#nestedatt--cmk_spec))
 - `database_track` (String) The track of the database. Production or Innovation or Preview.
-- `desired_state` (String) The desired state of the database, Active or Paused. This parameter can be used to pause/resume a cluster.
+- `desired_state` (String) The desired state of the cluster, Active or Paused. This parameter can be used to pause/resume a cluster.
 - `fault_tolerance` (String) The fault tolerance of the cluster. NONE, NODE, ZONE or REGION.
 - `node_config` (Attributes, Deprecated) (see [below for nested schema](#nestedatt--node_config))
 - `num_faults_to_tolerate` (Number) The number of domain faults the cluster can tolerate. 0 for NONE, 1 for ZONE and [1-3] for NODE and REGION

diff --git a/docs/resources/db_audit_logging.md b/docs/resources/db_audit_logging.md
@@ -3,12 +3,12 @@
 page_title: "ybm_db_audit_logging Resource - ybm"
 subcategory: ""
 description: |-
-  The resource to manage DB Audit log configuration for a cluster in YugabyteDB Aeon.
+  Use this resource to configure database audit logging for a cluster, and specify the export configuration (created using the ybm_integration resource) to use for log export. When assigned to a cluster, cluster audit logs are exported to the sink defined in the export configuration.
 ---
 
 # ybm_db_audit_logging (Resource)
 
-The resource to manage DB Audit log configuration for a cluster in YugabyteDB Aeon.
+Use this resource to configure database audit logging for a cluster, and specify the export configuration (created using the `ybm_integration` resource) to use for log export. When assigned to a cluster, cluster audit logs are exported to the sink defined in the export configuration.
 
 ## Example Usage
 

diff --git a/docs/resources/db_query_logging.md b/docs/resources/db_query_logging.md
@@ -3,12 +3,12 @@
 page_title: "ybm_db_query_logging Resource - ybm"
 subcategory: ""
 description: |-
-  The resource to manage DB query logging configuration for a cluster in YugabyteDB Aeon.
+  Use this resource to configure database query logging for a cluster, and specify the export configuration (created using the ybm_integration resource) to use for log export. When assigned to a cluster, cluster query logs are exported to the sink defined in the export configuration.
 ---
 
 # ybm_db_query_logging (Resource)
 
-The resource to manage DB query logging configuration for a cluster in YugabyteDB Aeon.
+Use this resource to configure database query logging for a cluster, and specify the export configuration (created using the `ybm_integration` resource) to use for log export. When assigned to a cluster, cluster query logs are exported to the sink defined in the export configuration.
 
 
 

diff --git a/docs/resources/integration.md b/docs/resources/integration.md
@@ -1,17 +1,20 @@
 ---
 page_title: "ybm_integration Resource - YugabyteDB Aeon"
 description: |-
-  The resource to create an export configuration for the integration you want to use in YugabyteDB Aeon.
-  Using the configuration you created, connect to your cluster:
-  -  Export metrics using resource ybm_associate_metrics_exporter_cluster
+  Use this resource to create export configurations. Export configurations define parameters for connecting to third party tools, such as Datadog, for exporting cluster metrics and logs.
+  To use an export configuration, assign it to a cluster using the following resources:
+  -Export metrics using resource ybm_associate_metrics_exporter_cluster
+  -Export query logs using resource ybm_db_query_logging
+  -Export audit logs using resource ybm_db_audit_logging
 ---
 
 # ybm_integration (Resource)
 
-The resource to create an export configuration for the integration you want to use in YugabyteDB Aeon.
-
-Using the configuration you created, connect to your cluster:
-	-  Export metrics using resource `ybm_associate_metrics_exporter_cluster`
+Use this resource to create export configurations. Export configurations define parameters for connecting to third party tools, such as Datadog, for exporting cluster metrics and logs.
+To use an export configuration, assign it to a cluster using the following resources:
+-Export metrics using resource `ybm_associate_metrics_exporter_cluster`
+-Export query logs using resource `ybm_db_query_logging`
+-Export audit logs using resource `ybm_db_audit_logging`
 
 
 ## Example Usage

diff --git a/managed/resource_associate_me_cluster.go b/managed/resource_associate_me_cluster.go
@@ -20,7 +20,7 @@ type resourceAssociateMetricsExporterClusterType struct{}
 
 func (r resourceAssociateMetricsExporterClusterType) GetSchema(_ context.Context) (tfsdk.Schema, diag.Diagnostics) {
 	return tfsdk.Schema{
-		Description: `The resource to manage metrics export configuration for a cluster in YugabyteDB Aeon.`,
+		Description: "Use this resource to assign an export configuration (created using the `ybm_integration` resource) to a cluster for the export of cluster metrics. When assigned, cluster metrics are exported to the sink defined in the export configuration.",
 		Attributes: map[string]tfsdk.Attribute{
 			"account_id": {
 				Description: "ID of the account this metrics export configuration belongs to.",

diff --git a/managed/resource_cluster.go b/managed/resource_cluster.go
@@ -499,7 +499,7 @@ func (r resourceClusterType) GetSchema(_ context.Context) (tfsdk.Schema, diag.Di
 			Computed:    true,
 		},
 		"desired_state": {
-			Description: "The desired state of the database, Active or Paused. This parameter can be used to pause/resume a cluster.",
+			Description: "The desired state of the cluster, Active or Paused. This parameter can be used to pause/resume a cluster.",
 			Type:        types.StringType,
 			Optional:    true,
 			Computed:    true,

diff --git a/managed/resource_db_audit_logging.go b/managed/resource_db_audit_logging.go
@@ -29,7 +29,7 @@ var validStatementClasses = []string{
 
 func (r resourceDbAuditLoggingType) GetSchema(ctx context.Context) (tfsdk.Schema, diag.Diagnostics) {
 	return tfsdk.Schema{
-		Description: `The resource to manage DB Audit log configuration for a cluster in YugabyteDB Aeon.`,
+		Description: "Use this resource to configure database audit logging for a cluster, and specify the export configuration (created using the `ybm_integration` resource) to use for log export. When assigned to a cluster, cluster audit logs are exported to the sink defined in the export configuration.",
 		Attributes: map[string]tfsdk.Attribute{
 			"account_id": {
 				Description: "ID of the account this DB Audit log configuration belongs to.",

diff --git a/managed/resource_db_query_logging.go b/managed/resource_db_query_logging.go
@@ -21,7 +21,7 @@ type resourceDbQueryLoggingType struct{}
 
 func (r resourceDbQueryLoggingType) GetSchema(ctx context.Context) (tfsdk.Schema, diag.Diagnostics) {
 	return tfsdk.Schema{
-		Description: `The resource to manage DB query logging configuration for a cluster in YugabyteDB Aeon.`,
+		Description: "Use this resource to configure database query logging for a cluster, and specify the export configuration (created using the `ybm_integration` resource) to use for log export. When assigned to a cluster, cluster query logs are exported to the sink defined in the export configuration.",
 		Attributes: map[string]tfsdk.Attribute{
 			"integration_name": {
 				Description: "Name of the integration for this DB query logging configuration.",

diff --git a/managed/resource_integration.go b/managed/resource_integration.go
@@ -24,10 +24,11 @@ type resourceIntegrationType struct{}
 
 func (r resourceIntegrationType) GetSchema(_ context.Context) (tfsdk.Schema, diag.Diagnostics) {
 	return tfsdk.Schema{
-		Description: `The resource to create an export configuration for the integration you want to use in YugabyteDB Aeon.
-
-Using the configuration you created, connect to your cluster:
-	-  Export metrics using resource ` + "`ybm_associate_metrics_exporter_cluster`",
+		Description: "Use this resource to create export configurations. Export configurations define parameters for connecting to third party tools, such as Datadog, for exporting cluster metrics and logs.\n" +
+			"To use an export configuration, assign it to a cluster using the following resources:\n" +
+			"-Export metrics using resource `ybm_associate_metrics_exporter_cluster`\n" +
+			"-Export query logs using resource `ybm_db_query_logging`\n" +
+			"-Export audit logs using resource `ybm_db_audit_logging`",
 		Attributes: r.getSchemaAttributes(),
 	}, nil
 }