search string side menu

BRIX On-Premises > BRIX On-Premises Enterprise > Install add-on components for BRIX / Install Loki

Install Loki

Loki is an open platform for collecting, indexing, and storing logs. It enables debugging and problem detection in the system based on log data analysis and monitoring.

Before installing Loki, configure the monitoring tools.

This article describes how to:

The installation of Loki consists of five steps:

  1. Download the Helm chart and the configuration file.
  2. Create buckets in MinIO.
  3. Fill in the configuration file.
  4. Install the Loki chart using Helm in the Kubernetes cluster.
  5. Configure the connection to Loki in Grafana data sources.

Начало внимание

When installing Loki + Tempo, start with the Loki addon. This allows preserving cross-linking settings, as they are initially configured in the Datasource settings.

Конец внимание

Step 1: Download the Helm chart and the configuration file

To install over the internet, obtain the configuration file values-loki.yaml by executing the command:

helm repo add elma365 https://charts.elma365.tech
helm repo update
helm show values elma365/loki > values-loki.yaml

Getting configuration file for installation in a closed environment without internet access,

  1. On a computer with internet access, download the archive of the latest version of the Loki chart from the BRIX repository using the command:

helm repo add elma365 https://charts.elma365.tech
helm repo update
helm pull elma365/loki

  1. Copy the obtained loki-X.Y.Z.tgz chart archive to the server where the installation will take place.
  2. Unpack the chart and copy the default configuration file values.yaml to values- loki.yaml .

tar -xf loki-X.Y.Z.tgz
cp loki/values.yaml values-loki.yaml

Step 2: Create buckets in MinIO

1. Create alias for MinIO:

mc alias set my_alias http://minio.local accessKey secretKey

2. Create buckets with the names admins, chunks and rules:

mc mb -p my_alias/admin --region=ru-central-1
mc mb -p my_alias/chunks --region=ru-central-1
mc mb -p my_alias/rules --region=ru-central-1

Step 3: Fill in the configuration file

Fill in the values-loki.yaml configuration file to install Loki

 loki:
# -- Deploy mode allows specifying the Loki deployment mode
deploymentMode: SimpleScalable
# -- COnfiguration so start Enterprise Loki
enterprise:
  enabled: false
# -- Use the GEL gateway if; if false, use the nginx gateway by default
  gelGateway: false
# -- enable caching of chunks based on memcached
chunksCache:
  enabled: false
loki:
  # -- enable authentication
  auth_enabled: false
  # -- storage configuration
  storage:
    bucketNames:
      chunks: chunks
      ruler: ruler
      admin: admin
    type: s3
    s3:
      s3: null
      endpoint: minio.local:9000
      region: ru-central-1
      secretAccessKey: secretAccessKey
      accessKeyId: accessKeyId
      signatureVersion: null
      s3ForcePathStyle: true
      insecure: true
      http_config: {}
  # -- additional compactor configuration
  compactor:
    delete_request_store: s3
    compaction_interval: 10m
    retention_enabled: true
    retention_delete_delay: 2h
    retention_delete_worker_count: 150
    working_directory: /var/loki/chunks
  # -- schema settings
  schemaConfig:
    configs:
    - from: "2024-04-01"
      index:
        period: 24h
        prefix: index_
      object_store: s3
      schema: v13
      store: tsdb
  useTestSchema: false
  # -- limits configuration
  limits_config:
    retention_period: 744h #default 744h
    per_stream_rate_limit: 512M
    per_stream_rate_limit_burst: 1024M
  commonConfig:
    replication_factor: 1
# -- write module configuration
write:
  replicas: 1
  autoscaling:
    enabled: false
    minReplicas: 2
    maxReplicas: 6
# -- read module configuration
read:
  replicas: 1
  autoscaling:
    enabled: false
    minReplicas: 2
    maxReplicas: 6
# -- backend module configuration
backend:
  replicas: 1
  autoscaling:
    enabled: false
    minReplicas: 2
    maxReplicas: 6
# -- gateway module configuration
gateway:
  enabled: true
  replicas: 1
  verboseLogging: true
  autoscaling:
    enabled: false
    minReplicas: 1
    maxReplicas: 3
# -- Section for setting up additional Helm test
test:
  enabled: false
# Loki canary
lokiCanary:
  enabled: false
 
# -- promtail settings
promtail:
daemonset:
  # -- Deploys Promtail as DaemonSet
  enabled: true
  autoscaling:
    enabled: false
deployment:
  # -- Deploys Promtail as Deployment
  enabled: false
  replicaCount: 1
  autoscaling:
    enabled: false
    minReplicas: 1
    maxReplicas: 10
# -- Promtail configuration
config:
  enabled: true
  serverPort: 3101
  clients:
    - url: http://loki-gateway/loki/api/v1/push

Filling in connection parameters to a private registry for installation in a closed environment without internet access

To connect to a private registry, follow these steps:

  1. Download the BRIX images and load them into the local image registry. Read more about this in Download BRIX images.
  1. Set the address and path for the parameter image.repository.
  1. Specify the name of the secret with access rights to the private registry in the parameter image.pullSecrets. The secret must be created manually and encoded in Base64.

loki:
## parameters for connecting to the private registry
global:
  image:
    registry: null
imagePullSecrets: []  
 
promtail:
## parameters for connecting to the private registry
global:
  imageRegistry: ""
  imagePullSecrets: []

Step 4: Install the Loki chart using Helm in the Kubernetes cluster

Execute the installation of the Loki chart in namespace monitoring.

For online installation via the internet:

helm upgrade --install -n monitoring loki elma365/loki -f values-loki.yaml

For offline installation without internet access, navigate to the directory with the downloaded chart and execute the command:

helm upgrade --install loki ./loki -f values-loki.yaml -n monitoring

Step 5: Configure the connection to Loki in Grafana data sources

The Loki data source is added during installation. You can check it using the path:  Home > Administration > Data source > Loki. 

URL: http://loki-gateway

install-loki-1

Example of viewing logs for mongodb ({app="mongodb"} |= "error" != "timeout"):
install-loki-2

Configure Loki in the Deckhouse platform

If you use the Deckhouse platform, there are two ways to install Loki:

  • Install the Loki chart into the Kubernetes cluster following the description above.
  • Enable the Loki module built into Deckhouse. When using this module, you can view the logs from all pods of the cluster in Grafana.

To enable the Loki module in the Deckhouse platform, use the following code:

kubectl apply -f - <<EOF
# Configure log collection from all pods
apiVersion: deckhouse.io/v1alpha1
kind: ClusterLoggingConfig
metadata:
 name: all-logs
spec:
 type: KubernetesPods
 destinationRefs:
 - d8-loki
---
# Enable the Loki module and configure data storage settings
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
 name: loki
spec:
 settings:
   storageClass: localpath-deckhouse-system
   diskSizeGigabytes: 30
   retentionPeriodHours: 168
 enabled: true
 version: 1
---
# Enable the log-shipper module
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
 name: log-shipper
spec:
 version: 1
 enabled: true
EOF

install-cert-manager.html install-mimir.html