k8s/loki/loki-stack/charts/fluent-bit/README.md

Fluent Bit Loki chart

This chart install the Fluent Bit application to ship logs to Loki. It defines daemonset on a Kubernetes cluster using the Helm package manager.

Get Repo Info

helm repo add grafana https://grafana.github.io/helm-charts
helm repo update

_See helm repo for command documentation._

Installing the Chart

If you don't have Helm installed locally, or Tiller installed in your Kubernetes cluster, read the Using Helm documentation to get started. To install the chart with the release name my-release using our helm repository:

helm repo add grafana https://grafana.github.io/helm-charts
helm upgrade --install my-release grafana/fluent-bit \
    --set loki.serviceName=loki.default.svc.cluster.local

If you deploy Loki with a custom namespace or service name, you must change the value above for loki.serviceName to the appropriate value.

The command deploys Fluent Bit on the Kubernetes cluster with the default configuration. The configuration section lists the parameters that can be configured during installation.

To configure the chart to send to Grafana Cloud use:

helm upgrade --install my-release grafana/fluent-bit \
    --set loki.serviceName=logs-us-west1.grafana.net,loki.servicePort=80,loki.serviceScheme=https \
    --set loki.user=2830,loki.password=1234

Tip: List all releases using helm list

To install a custom tag use the following command:

helm upgrade --install my-release grafana/fluent-bit \
    --set image.tag=<custom tag>

The full list of available tags on docker hub.

Alternatively you can install the full Loki stack (Loki + Fluent Bit) using:

helm upgrade --install my-release grafana/loki-stack \
    --set fluent-bit.enabled=true,promtail.enabled=false

This will automatically configured the loki.serviceName configuration field to the newly created Loki instance.

RBAC

By default, rbac.create is set to true. This enable RBAC support in Fluent Bit and must be true if RBAC is enabled in your cluster.

The chart will take care of creating the required service accounts and roles for Fluent Bit.

If you have RBAC disabled, or to put it another way, ABAC enabled, you should set this value to false.

Uninstalling the Chart

To uninstall/delete the my-release deployment:

helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following tables lists the configurable parameters of the Fluent Bit chart and their default values.

For more details, read the Fluent Bit documentation

Parameter	Description	Default
loki.serviceName	The address of the Loki service.	"${RELEASE}-loki"
loki.servicePort	The port of the Loki service.	3100
loki.serviceScheme	The scheme of the Loki service.	http
loki.user	The http basic auth username to access the Loki service.
loki.password	The http basic auth password to access the Loki service.
config.port	the Fluent Bit port to listen. (This is mainly used to serve metrics)	2020
config.tenantID	The tenantID used by default to push logs to Loki	''
config.batchWait	Time to wait before send a log batch to Loki, full or not. (unit: secs)	1
config.batchSize	Log batch size to send a log batch to Loki. (unit: bytes)	10240 (10KiB)
config.loglevel	the Fluent Bit log level (debug,info,warn,error).	warn
config.lineFormat	The line format to use to send a record (json/key_value)	json
config.k8sLoggingParser	Allow Kubernetes Pods to suggest a pre-defined Parser. See Official Fluent Bit documentation.	Off
config.k8sLoggingExclude	Allow Kubernetes Pods to exclude their logs from the log processor. See Official Fluent Bit documentation	Off
config.memBufLimit	Override the default Mem_Buf_Limit Official Fluent Bit documentation	5MB
config.removeKeys	The list of key to remove from each record	[removeKeys,stream]
config.labels	A set of labels to send for every log	'{job="fluent-bit"}'
config.autoKubernetesLabels	If set to true, it will add all Kubernetes labels to Loki labels	false
config.labelMap	Mapping of labels from a record. See Fluent Bit documentation
config.parsers	Definition of extras fluent bit parsers. See Official Fluent Bit documentation. The format is a sequence of mappings where each key is the same as the one in the [PARSER] section of parsers.conf file	[]
config.extraOutputs	Definition of extras fluent bit outputs. See Official Fluent Bit documentation. The format is a sequence of mappings where each key is the same as the one in the [OUTPUT]	[]
affinity	affinity settings for pod assignment	{}
annotations	Annotations to add to Kubernetes resources.	{}
deploymentStrategy	The deployment strategy to use with the daemonset	RollingUpdate
image.repository	The Fluent Bit docker image repository	grafana/fluent-bit-plugin-loki
image.tag	The Fluent Bit docker image tag	0.1
image.pullPolicy	The Fluent Bit docker image pull policy	IfNotPresent
nodeSelector	Fluent Bit node labels for pod assignment	{}
podLabels	additional Fluent Bit pod labels	{}
podAnnotations	additional Fluent Bit pod annotations	Prometheus discovery
rbac.create	Activate support for RBAC	true
resources	Resource requests/limit
tolerations	Toleration labels for pod assignment	no schedule on master nodes
volumes	Volume to mount	host containers log
volumeMounts	Volume mount mapping
serviceMonitor.enabled	Create a Prometheus Operator serviceMonitor resource for Fluent Bit	false