Uploaded image for project: 'Observability Documentation'
  1. Observability Documentation
  2. OBSDOCS-204

Incorrect Loki Documentation for updating configurable parameter

    XMLWordPrintable

Details

    • OBSDOCS (May 30-June 20) #237, OBSDOCS (June 20-July 10) #238, OBSDOCS (July 10-31) #239, OBSDOCS (Aug 21-Sep 11) #241

    Description

      As per the documentation[0],

      [0] https://docs.openshift.com/rosa/logging/cluster-logging-loki.html#cluser-logging-troubleshooting-loki-entry-out-of-order-messages_cluster-logging-loki

       

      To modify the below parameters, we have to edit the file `loki.yaml` but there is no such file as `loki.yaml` since the lokistack is operator managed, we need to edit the file using `oc edit lokistack`, there are no clear examples on where and how to add these parameters in lokistack

      grpc_server_max_recv_msg_size: 8388608
      chunk_target_size: 8388608
      ingestion_rate_mb: 8
      ingestion_burst_size_mb: 16
      

       

      For the Demo, I have updated the lokistack as below

      Example

      oc edit lokistack
      
      ...
      apiVersion: loki.grafana.com/v1
      kind: LokiStack
      metadata:
        annotations:
          kubectl.kubernetes.io/last-applied-configuration: |
            {"apiVersion":"loki.grafana.com/v1","kind":"LokiStack","metadata":{"annotations":{},"name":"logging-loki","namespace":"openshift-logging"},"spec":{"size":"1x.extra-small","storage":{"schemas":[{"effectiveDate":"2022-06-01","version":"v12"}],"secret":{"name":"logging-loki-s3","type":"s3"}},"storageClassName":"gp3-csi","tenants":{"mode":"openshift-logging"}}}
          loki.grafana.com/rulesDiscoveredAt: "2023-02-27T14:16:59Z"
        creationTimestamp: "2023-02-27T14:09:55Z"
        generation: 2
        name: logging-loki
        namespace: openshift-logging
        resourceVersion: "73916"
        uid: 3c206537-b37f-4443-aeb6-322d8e7e9530
      spec:
        limits:
          global:
            ingestion:
              ingestionBurstSize: 16 # <--- added this to set ingestion_burst_size_mb: 16 in loki.yml
              ingestionRate: 8 # <--- added this to set ingestion_rate_mb: 8 in loki.yml
        managementState: Managed
      ...
      
      

       
      Result

      ... 
      apiVersion: v1
      - apiVersion: loki.grafana.com/v1
        kind: LokiStack
        metadata:
          annotations:
            kubectl.kubernetes.io/last-applied-configuration: |
              {"apiVersion":"loki.grafana.com/v1","kind":"LokiStack","metadata":{"annotations":{},"name":"logging-loki","namespace":"openshift-logging"},"spec":{"size":"1x.extra-small","storage":{"schemas":[{"effectiveDate":"2022-06-01","version":"v12"}],"secret":{"name":"logging-loki-s3","type":"s3"}},"storageClassName":"gp3-csi","tenants":{"mode":"openshift-logging"}}}
            loki.grafana.com/rulesDiscoveredAt: "2023-02-27T14:16:59Z"
          creationTimestamp: "2023-02-27T14:09:55Z"
          generation: 2
          name: logging-loki
          namespace: openshift-logging
          resourceVersion: "73916"
          uid: 3c206537-b37f-4443-aeb6-322d8e7e9530
        spec:
          limits:
            global:
              ingestion:
                ingestionBurstSize: 16
                ingestionRate: 8
          managementState: Managed
       ...
      

      what are the other parameters that can be configured using the `Lokistack` do we have a list of that parameters

       

      For the below parameter,  We cannot configure them as they are not available in the https://loki-operator.dev/docs/api.md/ , having these parameters in the doc in confusing the customer 

       

      • grpc_server_max_recv_msg_size: 8388608
      • chunk_target_size: 8388608

      Attachments

        There are no Sub-Tasks for this issue.

        Activity

          People

            abrennan@redhat.com Ashleigh Brennan
            rhn-support-ssonigra Sonigra Saurab
            Votes:
            0 Vote for this issue
            Watchers:
            9 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: