diff --git a/docs/sources/alert/_index.md b/docs/sources/alert/_index.md index abd1905cee439..5241491f91fd2 100644 --- a/docs/sources/alert/_index.md +++ b/docs/sources/alert/_index.md @@ -304,16 +304,16 @@ The [Cortex rules action](https://github.com/grafana/cortex-rules-action) introd uses: grafana/cortex-rules-action@master env: ACTION: check - RULES_DIR: # Example: logs/recording_rules/,logs/alerts/ + RULES_DIR: # Example: logs/recording_rules/,logs/alerts/ BACKEND: loki - name: Deploy rules to Loki staging uses: grafana/cortex-rules-action@master env: - CORTEX_ADDRESS: + CORTEX_ADDRESS: CORTEX_TENANT_ID: fake ACTION: sync - RULES_DIR: # Example: logs/recording_rules/,logs/alerts/ + RULES_DIR: # Example: logs/recording_rules/,logs/alerts/ BACKEND: loki ``` @@ -327,7 +327,7 @@ A full sharding-enabled Ruler example is: ```yaml ruler: - alertmanager_url: + alertmanager_url: enable_alertmanager_v2: true # true by default since Loki 3.2.0 enable_api: true enable_sharding: true @@ -339,7 +339,7 @@ ruler: rule_path: /tmp/rules storage: gcs: - bucket_name: + bucket_name: ``` ## Ruler storage diff --git a/docs/sources/community/maintaining/release/patch-vulnerabilities.md b/docs/sources/community/maintaining/release/patch-vulnerabilities.md index 6f8ed566e035c..cb71ee12d7799 100644 --- a/docs/sources/community/maintaining/release/patch-vulnerabilities.md +++ b/docs/sources/community/maintaining/release/patch-vulnerabilities.md @@ -43,7 +43,7 @@ Before start patching vulnerabilities, know what are you patching. It can be one 1. Check if [dependabot already patched the dependency](https://github.com/grafana/loki/pulls?q=is%3Apr+label%3Adependencies+is%3Aclosed) or [have a PR opened to patch](https://github.com/grafana/loki/pulls?q=is%3Apr+is%3Aopen+label%3Adependencies) . If not, manually upgrade the package on the `main` branch as follows. ```shell - go get -u -v @ + go get -u -v @ go mod tidy go mod vendor ``` diff --git a/docs/sources/reference/loki-http-api.md b/docs/sources/reference/loki-http-api.md index 2155a4604b1fd..057f282c76641 100644 --- a/docs/sources/reference/loki-http-api.md +++ b/docs/sources/reference/loki-http-api.md @@ -275,7 +275,7 @@ For information on how to configure Loki, refer to the [OTel Collector topic](ht {{< admonition type="note" >}} -When configuring the OpenTelemetry Collector, you must use `endpoint: http:///otlp`, as the collector automatically completes the endpoint. Entering the full endpoint will generate an error. +When configuring the OpenTelemetry Collector, you must use `endpoint: http:///otlp`, as the collector automatically completes the endpoint. Entering the full endpoint will generate an error. {{< /admonition >}} @@ -451,7 +451,7 @@ To query against your hosted log tenant in Grafana Cloud, use the **User** and * ```bash curl -u "User:$API_TOKEN" \ - -G -s "/loki/api/v1/query" \ + -G -s "/loki/api/v1/query" \ --data-urlencode 'query=sum(rate({job="varlogs"}[10m])) by (level)' | jq ``` @@ -1440,8 +1440,8 @@ Example cURL command: ```bash curl -X GET \ - /loki/api/v1/delete \ - -H 'X-Scope-OrgID: ' + /loki/api/v1/delete \ + -H 'X-Scope-OrgID: ' ``` The same example deletion request for Grafana Enterprise Logs uses Basic Authentication and specifies the tenant name as a user; `Tenant1` is the tenant name in this example. The password in this example is an access policy token that has been defined in the API_TOKEN environment variable. The token must be for an access policy with `logs:delete` scope for the tenant specified in the user field. @@ -1449,7 +1449,7 @@ The same example deletion request for Grafana Enterprise Logs uses Basic Authent ```bash curl -u "Tenant1:$API_TOKEN" \ -X GET \ - /loki/api/v1/delete + /loki/api/v1/delete ``` ### Request cancellation of a delete request @@ -1487,8 +1487,8 @@ Example cURL command: ```bash curl -X DELETE \ - '/loki/api/v1/delete?request_id=' \ - -H 'X-Scope-OrgID: ' + '/loki/api/v1/delete?request_id=' \ + -H 'X-Scope-OrgID: ' ``` The same example deletion cancellation request for Grafana Enterprise Logs uses Basic Authentication and specifies the tenant name as a user; `Tenant1` is the tenant name in this example. The password in this example is an access policy token that has been defined in the API_TOKEN environment variable. The token must be for an access policy with `logs:delete` scope for the tenant specified in the user field. @@ -1496,7 +1496,7 @@ The same example deletion cancellation request for Grafana Enterprise Logs uses ```bash curl -u "Tenant1:$API_TOKEN" \ -X DELETE \ - '/loki/api/v1/delete?request_id=' + '/loki/api/v1/delete?request_id=' ``` ## Format a LogQL query diff --git a/docs/sources/setup/install/helm/deployment-guides/aws.md b/docs/sources/setup/install/helm/deployment-guides/aws.md index 3be37995024c8..de79a8597e189 100644 --- a/docs/sources/setup/install/helm/deployment-guides/aws.md +++ b/docs/sources/setup/install/helm/deployment-guides/aws.md @@ -61,8 +61,8 @@ apiVersion: eksctl.io/v1alpha5 kind: ClusterConfig metadata: - name: - region: + name: + region: version: "1.31" iam: diff --git a/docs/sources/setup/install/helm/install-scalable/_index.md b/docs/sources/setup/install/helm/install-scalable/_index.md index 6fe50110432fe..01184635843ec 100644 --- a/docs/sources/setup/install/helm/install-scalable/_index.md +++ b/docs/sources/setup/install/helm/install-scalable/_index.md @@ -148,15 +148,15 @@ loki: # s3 URL can be used to specify the endpoint, access key, secret key, and bucket name this works well for S3 compatible storages or if you are hosting Loki on-premises and want to use S3 as the storage backend. Either use the s3 URL or the individual fields below (AWS endpoint, region, secret). s3: s3://access_key:secret_access_key@custom_endpoint/bucket_name # AWS endpoint URL - endpoint: + endpoint: # AWS region where the S3 bucket is located - region: + region: # AWS secret access key - secretAccessKey: + secretAccessKey: # AWS access key ID - accessKeyId: + accessKeyId: # AWS signature version (e.g., v2 or v4) - signatureVersion: + signatureVersion: # Forces the path style for S3 (true/false) s3ForcePathStyle: false # Allows insecure (HTTP) connections (true/false) @@ -205,21 +205,21 @@ loki: type: azure azure: # Name of the Azure Blob Storage account - accountName: + accountName: # Key associated with the Azure Blob Storage account - accountKey: + accountKey: # Comprehensive connection string for Azure Blob Storage account (Can be used to replace endpoint, accountName, and accountKey) - connectionString: + connectionString: # Flag indicating whether to use Azure Managed Identity for authentication useManagedIdentity: false # Flag indicating whether to use a federated token for authentication useFederatedToken: false # Client ID of the user-assigned managed identity (if applicable) - userAssignedId: + userAssignedId: # Timeout duration for requests made to the Azure Blob Storage account (in seconds) - requestTimeout: + requestTimeout: # Domain suffix of the Azure Blob Storage service endpoint (e.g., core.windows.net) - endpointSuffix: + endpointSuffix: bucketNames: chunks: "chunks" ruler: "ruler" diff --git a/docs/sources/setup/upgrade/upgrade-to-6x/index.md b/docs/sources/setup/upgrade/upgrade-to-6x/index.md index 716a2d272e675..2247436982e4e 100644 --- a/docs/sources/setup/upgrade/upgrade-to-6x/index.md +++ b/docs/sources/setup/upgrade/upgrade-to-6x/index.md @@ -100,7 +100,7 @@ In Helm chart version 6.34.0, [PR #18558](https://github.com/grafana/loki/pull/1 1. **Check if you're affected**: ```bash - helm get values | grep -A5 zoneAwareReplication + helm get values | grep -A5 zoneAwareReplication ``` If `enabled: true` appears, you need to follow these steps. @@ -109,16 +109,16 @@ In Helm chart version 6.34.0, [PR #18558](https://github.com/grafana/loki/pull/1 ```bash kubectl delete statefulset \ - -ingester-zone-a \ - -ingester-zone-b \ - -ingester-zone-c \ + -ingester-zone-a \ + -ingester-zone-b \ + -ingester-zone-c \ --cascade=orphan ``` 3. **Proceed with the Helm upgrade**: ```bash - helm upgrade grafana/loki --version 6.34.0 + helm upgrade grafana/loki --version 6.34.0 ``` **What happens**: @@ -140,32 +140,32 @@ Version 6.38.0 of the Helm charts introduced the ability to edit the access mode ```bash # Core components (SimpleScalable mode) - kubectl delete statefulset -write --cascade=orphan - kubectl delete statefulset -backend --cascade=orphan + kubectl delete statefulset -write --cascade=orphan + kubectl delete statefulset -backend --cascade=orphan # Single binary mode - kubectl delete statefulset --cascade=orphan + kubectl delete statefulset --cascade=orphan # Distributed mode components - kubectl delete statefulset -ingester --cascade=orphan + kubectl delete statefulset -ingester --cascade=orphan # Zone-aware ingester (if zoneAwareReplication.enabled is true) - kubectl delete statefulset -ingester-zone-a --cascade=orphan - kubectl delete statefulset -ingester-zone-b --cascade=orphan - kubectl delete statefulset -ingester-zone-c --cascade=orphan - - kubectl delete statefulset -index-gateway --cascade=orphan - kubectl delete statefulset -compactor --cascade=orphan - kubectl delete statefulset -ruler --cascade=orphan - kubectl delete statefulset -pattern-ingester --cascade=orphan - kubectl delete statefulset -bloom-planner --cascade=orphan - kubectl delete statefulset -bloom-gateway --cascade=orphan + kubectl delete statefulset -ingester-zone-a --cascade=orphan + kubectl delete statefulset -ingester-zone-b --cascade=orphan + kubectl delete statefulset -ingester-zone-c --cascade=orphan + + kubectl delete statefulset -index-gateway --cascade=orphan + kubectl delete statefulset -compactor --cascade=orphan + kubectl delete statefulset -ruler --cascade=orphan + kubectl delete statefulset -pattern-ingester --cascade=orphan + kubectl delete statefulset -bloom-planner --cascade=orphan + kubectl delete statefulset -bloom-gateway --cascade=orphan ``` 2. **Proceed with the Helm upgrade**: ```bash - helm upgrade grafana/loki --version 6.38.0 + helm upgrade grafana/loki --version 6.38.0 ``` #### Distributed mode