Update TF provider documentation around template variables (#138)

.go-version

@@ -1 +1 @@
-1.73.3
+1.73.4

docs/resources/dashboard.md

@@ -20,15 +20,15 @@ resource "lightstep_dashboard" "customer_charges" {
   dashboard_description = "Dashboard for customer charges metrics"
 
   chart {
-    name = "Requests by Project for $service"
+    name = "Requests by Project"
     rank = 1
     type = "timeseries"
 
     query {
       hidden         = false
       query_name     = "a"
       display        = "line"
-      query_string   = "metric requests | filter (service == $service) | rate 10m | group_by [project_id], sum"
+      query_string   = "metric requests | rate 10m | group_by [project_id], sum"
     }
   }
 
@@ -53,12 +53,6 @@ resource "lightstep_dashboard" "customer_charges" {
   label {
     value = "customlabel"
   }
-
-  template_variable {
-    name = "service"
-    default_values = ["adservice"]
-    suggestion_attribute_key = "service_name"
-  }
 }
 ```
 
@@ -76,7 +70,7 @@ resource "lightstep_dashboard" "customer_charges" {
 - `dashboard_description` (String)
 - `group` (Block Set) (see [below for nested schema](#nestedblock--group))
 - `label` (Block Set) Labels can be key/value pairs or standalone values. (see [below for nested schema](#nestedblock--label))
-- `template_variable` (Block Set) Variable to be used in dashboard queries for dynamically filtering telemetry data (see [below for nested schema](#nestedblock--template_variable))
+- `template_variable` (Block Set) [Do not use - this field is not yet supported by the Lightstep SaaS] Variable to be used in dashboard queries for dynamically filtering telemetry data (see [below for nested schema](#nestedblock--template_variable))
 
 ### Read-Only
 
@@ -230,6 +224,6 @@ Optional:
 
 Required:
 
-- `default_values` (List of String) One or more values to set the template variable to by default (if none are provided, defaults to all possible values)
-- `name` (String) Unique (per dashboard) name for template variable, beginning with a letter or underscore and only containing letters, numbers, and underscores
-- `suggestion_attribute_key` (String) Attribute key used as source for suggested template variable values appearing in Lightstep UI
+- `default_values` (List of String) [Do not use - this field is not yet supported by the Lightstep SaaS] One or more values to set the template variable to by default (if none are provided, defaults to all possible values)
+- `name` (String) [Do not use - this field is not yet supported by the Lightstep SaaS] Unique (per dashboard) name for template variable, beginning with a letter or underscore and only containing letters, numbers, and underscores
+- `suggestion_attribute_key` (String) [Do not use - this field is not yet supported by the Lightstep SaaS] Attribute key used as source for suggested template variable values appearing in Lightstep UI

docs/resources/metric_dashboard.md

@@ -92,7 +92,7 @@ resource "lightstep_metric_dashboard" "customer_charges" {
 - `dashboard_description` (String)
 - `group` (Block Set) (see [below for nested schema](#nestedblock--group))
 - `label` (Block Set) Labels can be key/value pairs or standalone values. (see [below for nested schema](#nestedblock--label))
-- `template_variable` (Block Set) Variable to be used in dashboard queries for dynamically filtering telemetry data (see [below for nested schema](#nestedblock--template_variable))
+- `template_variable` (Block Set) [Do not use - this field is not yet supported by the Lightstep SaaS] Variable to be used in dashboard queries for dynamically filtering telemetry data (see [below for nested schema](#nestedblock--template_variable))
 
 ### Read-Only
 
@@ -310,6 +310,6 @@ Optional:
 
 Required:
 
-- `default_values` (List of String) One or more values to set the template variable to by default (if none are provided, defaults to all possible values)
-- `name` (String) Unique (per dashboard) name for template variable, beginning with a letter or underscore and only containing letters, numbers, and underscores
-- `suggestion_attribute_key` (String) Attribute key used as source for suggested template variable values appearing in Lightstep UI
+- `default_values` (List of String) [Do not use - this field is not yet supported by the Lightstep SaaS] One or more values to set the template variable to by default (if none are provided, defaults to all possible values)
+- `name` (String) [Do not use - this field is not yet supported by the Lightstep SaaS] Unique (per dashboard) name for template variable, beginning with a letter or underscore and only containing letters, numbers, and underscores
+- `suggestion_attribute_key` (String) [Do not use - this field is not yet supported by the Lightstep SaaS] Attribute key used as source for suggested template variable values appearing in Lightstep UI

lightstep/resource_metric_dashboard.go

@@ -92,7 +92,7 @@ func resourceUnifiedDashboard(chartSchemaType ChartSchemaType) *schema.Resource
 				Elem: &schema.Resource{
 					Schema: getTemplateVariableSchema(),
 				},
-				Description: "Variable to be used in dashboard queries for dynamically filtering telemetry data",
+				Description: "[Do not use - this field is not yet supported by the Lightstep SaaS] Variable to be used in dashboard queries for dynamically filtering telemetry data",
 			},
 		},
 	}
@@ -232,20 +232,20 @@ func getTemplateVariableSchema() map[string]*schema.Schema {
 		"name": {
 			Type:        schema.TypeString,
 			Required:    true,
-			Description: "Unique (per dashboard) name for template variable, beginning with a letter or underscore and only containing letters, numbers, and underscores",
+			Description: "[Do not use - this field is not yet supported by the Lightstep SaaS] Unique (per dashboard) name for template variable, beginning with a letter or underscore and only containing letters, numbers, and underscores",
 		},
 		"suggestion_attribute_key": {
 			Type:        schema.TypeString,
 			Required:    true,
-			Description: "Attribute key used as source for suggested template variable values appearing in Lightstep UI",
+			Description: "[Do not use - this field is not yet supported by the Lightstep SaaS] Attribute key used as source for suggested template variable values appearing in Lightstep UI",
 		},
 		"default_values": {
 			Type:     schema.TypeList,
 			Required: true,
 			Elem: &schema.Schema{
 				Type: schema.TypeString,
 			},
-			Description: "One or more values to set the template variable to by default (if none are provided, defaults to all possible values)",
+			Description: "[Do not use - this field is not yet supported by the Lightstep SaaS] One or more values to set the template variable to by default (if none are provided, defaults to all possible values)",
 		},
 	}
 }

templates/resources/dashboard.md.tmpl

@@ -20,15 +20,15 @@ resource "lightstep_dashboard" "customer_charges" {
   dashboard_description = "Dashboard for customer charges metrics"
 
   chart {
-    name = "Requests by Project for $service"
+    name = "Requests by Project"
     rank = 1
     type = "timeseries"
 
     query {
       hidden         = false
       query_name     = "a"
       display        = "line"
-      query_string   = "metric requests | filter (service == $service) | rate 10m | group_by [project_id], sum"
+      query_string   = "metric requests | rate 10m | group_by [project_id], sum"
     }
   }
 
@@ -53,12 +53,6 @@ resource "lightstep_dashboard" "customer_charges" {
   label {
     value = "customlabel"
   }
-
-  template_variable {
-    name = "service"
-    default_values = ["adservice"]
-    suggestion_attribute_key = "service_name"
-  }
 }
 ```