Collect logs from a file and send them anywhere

A simple guide to collect logs from a file and send them anywhere in just a few minutes.
type: tutorialdomain: sourcessource: file

Logs are an essential part of observing any service; without them you are flying blind. 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, disrupt more important services!

Fear not! In this guide we'll show you how to send collect logs from a file and send them anywhere and build a logs pipeline that will be the backbone of your observability strategy.

Strategy

How This Guide Works

We'll be using Vector to accomplish this task. Vector is a popular open-source utility for building observability pipelines. It's written in Rust, making it lightweight, ultra-fast and highly reliable. And we'll be deploying Vector as a daemon.

The daemon deployment strategy is designed for data collection on a single host. Vector runs in the background, in its own process, collecting all data for that host. For this guide, Vector will collect data from a file via Vector's file. The following diagram demonstrates how it works.

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 file.
3. Vector collects & fans-out data
Vector collects data from your platform.

What We'll Accomplish

To be clear, here's everything we'll accomplish in this short guide:

  • Tail one or more files.
    • Automatically discover new files with glob patterns.
    • Merge multi-line logs into one event.
    • Checkpoint your position to ensure data is not lost between restarts.
    • Enrich your logs with useful file and host-level context.
  • Send your logs to one or more destinations
  • All in just a few minutes!

Tutorial

  1. Install Vector

    curl --proto '=https' --tlsv1.2 -sSf https://sh.vector.dev | sh
    explain this command

    Or choose your preferred method.

  2. Configure Vector

    Where do you want to send your data?
    Console
    cat <<-VECTORCFG > vector.toml
    [sources.in]
    include = ["/var/log/nginx/*.log"] # required
    type = "file" # required
    [sinks.out]
    # Encoding
    encoding.codec = "json" # required
    # General
    inputs = ["in"] # required
    type = "console" # required
    VECTORCFG
    explain this command
  3. Start Vector

    vector --config vector.toml

    That's it! Simple and to the point. Hit ctrl+c to exit.

Next Steps

Vector is powerful utility 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 getting started series
Go from zero to production in under 10 minutes!
Vector documentation
Thoughtful, detailed docs that respect your time.