Send logs from Kubernetes to socket receiver

A simple guide to send logs from Kubernetes to socket receiver in just a few minutes.
type: tutorialdomain: platformsdomain: sinksplatform: kubernetessource: kubernetes_logssink: socket

Logs are an essential part of observing any service; without them you'll have significant blind spots. But collecting and analyzing them can be a real challenge -- especially at scale. Not only do you need to solve the basic task of collecting your logs, but you must do it in a reliable, performant, and robust manner. Nothing is more frustrating than having your logs pipeline fall on it's face during an outage, or even worse, cause the outage!

Fear not! In this guide we'll build an observability pipeline that will send logs from Kubernetes to socket receiver.

Background

What is Kubernetes?

Kubernetes, also known as k8s, is an open-source container-orchestration system for automating application deployment, scaling, and management.

Strategy

How This Guide Works

We'll be using [Vector][urls.vector_website] to accomplish this task. Vector is a popular open-source observability data pipeline. It's written in Rust, making it lightweight, ultra-fast and highly reliable. And we'll be deploying Vector as a agent.

Vector daemon deployment strategyVector daemon deployment strategy
1. Your service logs to STDOUT
STDOUT follows the 12 factor principles.
2. STDOUT is captured
STDOUT is captured and sent to a Kubernetes cluster.
3. Vector collects & fans-out data
Vector will sends logs to [socket receiver](https://en.wikipedia.org/wiki/Network_socket).

What We'll Accomplish

We'll build an observability data pipeline that:

  • Collects all log data for Kubernetes Nodes, automatically enriching data with Kubernetes metadata via the Kubernetes API.
    • Enriches data with useful Kubernetes context.
    • Efficiently collects data and checkpoints read positions to ensure data is not lost between restarts.
  • Sends logs to socket receiver.
    • Buffers data in-memory or on-disk for performance and durability.
    • Compresses data to optimize bandwidth.
    • Supports TCP keepalive for efficient resource use and reliability.
    • Automatically retries failed requests, with backoff.
    • Securely transmits data via Transport Layer Security (TLS).

All in just a few minutes!

Tutorial

Helm 3
  1. Add the Vector repo

    helm repo add timberio https://packages.timber.io/helm/latest
  2. Check available Helm chart configuration options

    helm show values timberio/vector-agent
  3. Configure Vector

    cat <<-'VALUES' > values.yaml
    # The Vector Kubernetes integration automatically defines a
    # kubernetes_logs source that is made available to you.
    # You do not need to define a log source.
    sinks:
    # Adjust as necessary. By default we use the console sink
    # to print all data. This allows you to see Vector working.
    # /docs/reference/sinks/
    stdout:
    type: console
    inputs: ["kubernetes_logs"]
    target: "stdout"
    encoding: "json"
    VALUES
  4. Install Vector

    helm install --namespace vector --create-namespace vector timberio/vector-agent --values values.yaml
  5. Observe Vector

    kubectl logs --namespace vector daemonset/vector-agent
    explain this command

Next Steps

Vector is powerful tool and we're just scratching the surface in this guide. Here are a few pages we recommend that demonstrate the power and flexibility of Vector:

Vector Github repo 4k
Vector is free and open-source!
Vector quickstart
Get setup in just a few minutes
Vector documentation
Everything you need to know about Vector

[urls.vector_website]: