Skip to content

Commit b7a53d9

Browse files
committed
README
1 parent a30963b commit b7a53d9

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,7 @@ No modules.
182182
|------|-------------|------|---------|:--------:|
183183
| <a name="input_agent_name"></a> [agent\_name](#input\_agent\_name) | Name of the Grafana Alloy. | `string` | n/a | yes |
184184
| <a name="input_agent_resources"></a> [agent\_resources](#input\_agent\_resources) | Resources for the Grafana Alloy | <pre>object({<br/> requests = optional(object({<br/> cpu = optional(string, "100m")<br/> memory = optional(string, "256Mi")<br/> }), {})<br/> limits = optional(object({<br/> cpu = optional(string, null)<br/> memory = optional(string, null)<br/> }), {})<br/> })</pre> | `{}` | no |
185+
| <a name="input_aws"></a> [aws](#input\_aws) | n/a | <pre>object({<br/> account = optional(string, "")<br/> region = optional(string, "")<br/> })</pre> | n/a | yes |
185186
| <a name="input_chart_version"></a> [chart\_version](#input\_chart\_version) | Helm chart version of Grafana Alloy | `string` | `"1.0.2"` | no |
186187
| <a name="input_clustering_enabled"></a> [clustering\_enabled](#input\_clustering\_enabled) | Enable Grafana Alloy clustering. NOTE: This is only supported for certain kinds of resources - RTFM | `bool` | `false` | no |
187188
| <a name="input_config"></a> [config](#input\_config) | Grafana Alloy River configuration. Some configuration should be provided. You're encouraged to use the provided templates. You can also provide your completely own config with `default_config_enabled = false`. | `list(string)` | `[]` | no |
@@ -200,8 +201,8 @@ No modules.
200201
| <a name="input_kubernetes_namespace"></a> [kubernetes\_namespace](#input\_kubernetes\_namespace) | Kubernetes namespace to deploy the Grafana Alloy into. NOTE: The namespace must exist and be available for deployment! | `string` | n/a | yes |
201202
| <a name="input_kubernetes_security_context"></a> [kubernetes\_security\_context](#input\_kubernetes\_security\_context) | Kubernetes security context configuration for the Grafana Alloy. This is needed with node\_exporter to run privileged and as root (UID 0). | <pre>object({<br/> runAsUser = optional(number)<br/> privileged = optional(bool)<br/> })</pre> | `{}` | no |
202203
| <a name="input_live_debug"></a> [live\_debug](#input\_live\_debug) | Enable live debug for the Grafana Alloy | `bool` | `false` | no |
203-
| <a name="input_loki"></a> [loki](#input\_loki) | Grafana Alloy scrape settings for Loki logs | <pre>object({<br/> url = optional(string, "http://loki:3100")<br/> tenant_id = optional(string, "default")<br/> username = optional(string, "admin")<br/> password = optional(string, "admin")<br/> auth_enabled = optional(bool, false)<br/> scrape_pods_global = optional(bool, true)<br/> scrape_pods_annotation = optional(string, "loki.logs.enabled")<br/> })</pre> | `{}` | no |
204-
| <a name="input_metrics"></a> [metrics](#input\_metrics) | Grafana Alloy metrics endpoint of Prometheus-compatible receiver. NOTE: You must provide the base URL of the API. | <pre>object({<br/> endpoint = optional(string, "http://mimir:9090")<br/> tenant = optional(string, "default")<br/> backend_type = optional(string, "mimir")<br/> ssl_enabled = optional(bool, true)<br/> })</pre> | `{}` | no |
204+
| <a name="input_loki"></a> [loki](#input\_loki) | Grafana Alloy scrape settings for Loki logs | <pre>object({<br/> url = optional(string, "http://loki:3100")<br/> tenant_id = optional(string, "default")<br/> username = optional(string, "admin")<br/> password = optional(string, "admin")<br/> auth_enabled = optional(bool, false)<br/> scrape_pods_global = optional(bool, true)<br/> scrape_pods_annotation = optional(string, "loki.logs.enabled")<br/> scrape_logs_method = optional(string, "api")<br/> })</pre> | `{}` | no |
205+
| <a name="input_metrics"></a> [metrics](#input\_metrics) | Grafana Alloy metrics endpoint of Prometheus-compatible receiver. NOTE: You must provide the base URL of the API. | <pre>object({<br/> endpoint = optional(string, "http://mimir:9090")<br/> tenant = optional(string, null)<br/> backend_type = optional(string, "mimir")<br/> ssl_enabled = optional(bool, true)<br/> })</pre> | `{}` | no |
205206
| <a name="input_otel"></a> [otel](#input\_otel) | Grafana Alloy OTel configuration. NOTE: There can be only one OTel receiver at the moment. | <pre>object({<br/> http_port = optional(number, 4318)<br/> grpc_port = optional(number, 4317)<br/> endpoint = optional(string, "http://tempo:4318")<br/> service_graphs_dimensions = optional(list(string), [])<br/> })</pre> | `{}` | no |
206207
| <a name="input_replicas"></a> [replicas](#input\_replicas) | Number of Grafana Alloy replicas. NOTE: Only valid for `kubernetes_kind = "deployment"`. | `number` | `1` | no |
207208
| <a name="input_stability_level"></a> [stability\_level](#input\_stability\_level) | n/a | `string` | `"generally-available"` | no |

modules/loki-logs/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ The module is designed to collect logs from Kubernetes pods and forward them to
1010
- Global pod log collection option
1111
- Configurable Loki endpoint and authentication
1212
- Support for multi-tenant Loki deployments
13+
- Support for file-based/API-based log collection
1314

1415
The agent runs as a deployment and collects logs from:
1516

@@ -57,15 +58,17 @@ No resources.
5758
| Name | Description | Type | Default | Required |
5859
|------|-------------|------|---------|:--------:|
5960
| <a name="input_agent_resources"></a> [agent\_resources](#input\_agent\_resources) | Resources for the Grafana OTel agent | <pre>object({<br/> requests = optional(object({<br/> cpu = optional(string, "500m")<br/> memory = optional(string, "512Mi")<br/> }), {})<br/> limits = optional(object({<br/> cpu = optional(string, null)<br/> memory = optional(string, null)<br/> }), {})<br/> })</pre> | `{}` | no |
61+
| <a name="input_aws"></a> [aws](#input\_aws) | n/a | <pre>object({<br/> account = optional(string, "")<br/> region = optional(string, "")<br/> })</pre> | n/a | yes |
6062
| <a name="input_chart_version"></a> [chart\_version](#input\_chart\_version) | Helm chart version of Grafana Alloy | `string` | `"1.0.2"` | no |
63+
| <a name="input_clustering_enabled"></a> [clustering\_enabled](#input\_clustering\_enabled) | Enable clustering for the Grafana Alloy | `bool` | `false` | no |
6164
| <a name="input_config"></a> [config](#input\_config) | Grafana Alloy River config snippets | `list(string)` | `[]` | no |
6265
| <a name="input_controller_resources"></a> [controller\_resources](#input\_controller\_resources) | Resources for the Grafana Alloy controller | <pre>object({<br/> requests = optional(object({<br/> cpu = optional(string, "1m")<br/> memory = optional(string, "5Mi")<br/> }), {})<br/> limits = optional(object({<br/> cpu = optional(string, "100m")<br/> memory = optional(string, "50Mi")<br/> }), {})<br/> })</pre> | `{}` | no |
6366
| <a name="input_global_tolerations"></a> [global\_tolerations](#input\_global\_tolerations) | Global tolerations for the Grafana Alloy | <pre>list(object({<br/> key = string<br/> operator = string<br/> effect = string<br/> }))</pre> | `[]` | no |
6467
| <a name="input_image"></a> [image](#input\_image) | Image registry for Grafana Alloy | <pre>object({<br/> registry = optional(string, "docker.io")<br/> repository = optional(string, "grafana/alloy")<br/> })</pre> | `{}` | no |
6568
| <a name="input_kubernetes_cluster_name"></a> [kubernetes\_cluster\_name](#input\_kubernetes\_cluster\_name) | Kubernetes cluster name | `string` | n/a | yes |
6669
| <a name="input_kubernetes_namespace"></a> [kubernetes\_namespace](#input\_kubernetes\_namespace) | Kubernetes namespace | `string` | n/a | yes |
6770
| <a name="input_live_debug"></a> [live\_debug](#input\_live\_debug) | Enable live debug for the Grafana Alloy | `bool` | `false` | no |
68-
| <a name="input_loki"></a> [loki](#input\_loki) | Grafana Alloy scrape settings for Loki logs | <pre>object({<br/> url = optional(string, "http://loki:3100")<br/> tenant_id = optional(string, "default")<br/> username = optional(string, "admin")<br/> password = optional(string, "admin")<br/> scrape_pods_global = optional(bool, true)<br/> scrape_pods_annotation = optional(string, "loki.logs.enabled")<br/> })</pre> | `{}` | no |
71+
| <a name="input_loki"></a> [loki](#input\_loki) | Grafana Alloy scrape settings for Loki logs | <pre>object({<br/> url = optional(string, "http://loki:3100")<br/> tenant_id = optional(string, "default")<br/> username = optional(string, "admin")<br/> password = optional(string, "admin")<br/> scrape_pods_global = optional(bool, true)<br/> scrape_pods_annotation = optional(string, "loki.logs.enabled")<br/> scrape_logs_method = optional(string, "api")<br/> })</pre> | `{}` | no |
6972
| <a name="input_metrics"></a> [metrics](#input\_metrics) | Grafana Alloy metrics endpoint of Prometheus-compatible receiver. NOTE: You must provide the base URL of the API. | <pre>object({<br/> endpoint = optional(string, "http://mimir:9090")<br/> tenant = optional(string, "default")<br/> backend_type = optional(string, "mimir")<br/> })</pre> | `{}` | no |
7073
| <a name="input_replicas"></a> [replicas](#input\_replicas) | Number of Grafana Alloy replicas | `number` | `1` | no |
7174
| <a name="input_stability_level"></a> [stability\_level](#input\_stability\_level) | Stability level for the Grafana Alloy | `string` | `"generally-available"` | no |

0 commit comments

Comments
 (0)