[release/v1.2] Update local.file.md (#2111)

* Update local.file.md when trying to use `local.file` it seemed to be missing an example of how to use it. * Update docs/sources/reference/components/local/local.file.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/reference/components/local/local.file.md Co-authored-by: Clayton Cornell <[email protected]> * Fixed the workding of the example --------- Co-authored-by: Clayton Cornell <[email protected]> (cherry picked from commit 2eecbfe) Co-authored-by: Bob Cotton <[email protected]>
grafana · Nov 15, 2024 · b444364 · b444364
1 parent 5fb877e
commit b444364
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/docs/sources/reference/components/local/local.file.md b/docs/sources/reference/components/local/local.file.md
@@ -46,7 +46,9 @@ Name      | Type                 | Description
 ----------|----------------------|---------------------------------------------------
 `content` | `string` or `secret` | The contents of the file from the most recent read
 
-The `content` field will have the `secret` type only if the `is_secret` argument was true.
+The `content` field will have the `secret` type only if the `is_secret` argument was true. 
+
+You can use `local.file.LABEL.content` to access the contents of the file.
 
 ## Component health
 
@@ -66,9 +68,15 @@ The read error will be exposed as a log message and in the debug information for
 
 ## Example
 
+The following example shows a simple `local.file` configuration that watches a passwords text file and uses the exported content field.
+
 ```alloy
 local.file "secret_key" {
   filename  = "/var/secrets/password.txt"
   is_secret = true
 }
+grafana_cloud.stack "receivers" {
+  stack_name = "mystack"
+  token = local.file.secret_key.content
+}
 ```