Add docs for foreach #2447
Add docs for foreach #2447
Conversation
|
💻 Deploy preview available: https://deploy-preview-alloy-2447-zb444pucvq-vp.a.run.app/docs/alloy/latest/ |
| ## Examples | ||
|
|
||
| ### Run Prometheus exporters dynamically on service discovery targets |
There was a problem hiding this comment.
| ## Examples | |
| ### Run Prometheus exporters dynamically on service discovery targets | |
| ## Example | |
| The following example shows you how to run Prometheus exporters dynamically on service discovery targets. |
It's a single example and we shouldn't have headings with no text between them
There was a problem hiding this comment.
I'm sure there will be more examples in the future, so I wanted to make it a bit easier to add them by having the right structure.
There was a problem hiding this comment.
We can expand it then to Examples (with the s) if/when we add more examples?
| `var` | `string` | Name of the variable referring to the current item in the collection. | | yes | ||
| `enable_metrics` | `bool` | Whether to expose debug metrics in Alloy's `/metrics` endpoint. | `false` | no | ||
|
|
||
| `collection` could contain any [type][types] such as a bool, a string, a list, or a map. |
There was a problem hiding this comment.
could contain or can contain any type.
There was a problem hiding this comment.
Is it more clear if I reword it to:
The items in the
collectionlist can be of any type such as a bool, a string, a list, or a map.
There was a problem hiding this comment.
| `collection` could contain any [type][types] such as a bool, a string, a list, or a map. | |
| The items in the `collection` list can be of any type [type][types], such as a bool, a string, a list, or a map. |
Add a comma and it should be good.
| On the other hand, `discovery.*` components such as `discovery.kubernetes` output a list of targets such as this: | ||
|
|
||
| {{< collapse title="Example targets output by discovery.kubernetes" >}} |
There was a problem hiding this comment.
I'm not sure this should be collapsed in this context. We could expand the sentence in line 68 a bit more. or take out the collapse shortcode... or maybe collapse this whole section? It's an aside... extra info about the example further down, correct?
There was a problem hiding this comment.
The reason I included the collapsible section is to illustrate what the contents of collection are.
There was a problem hiding this comment.
Ok, works for me :-) Leave it as-is.
| ### template block | ||
|
|
||
| The `template` block contains the definition of Alloy components which will be ran for every item in the collection. | ||
| The contents of the block look like a normal Alloy config file, except that you can use the keyword defined in `var` to refer to the current item in the collection. |
There was a problem hiding this comment.
We should probably specify that components inside of the template can use exports of components that are outside of the foreach block but components outside of the foreach cannot use exports from components inside of the template.
Co-authored-by: Clayton Cornell <[email protected]>
No description provided.