Skip to content

Report

Read events from a Fluentd forwarder to transform into typed TenXObjects to aggregate and report on. This module is a component of the Edge Reporter app.

Architecture

graph LR
    A["<div style='font-size: 14px;'>📂 Fluentd</div><div style='font-size: 10px;'>sources</div>"] --> B["<div style='font-size: 14px;'>🔧 exec_filter</div><div style='font-size: 10px;'>plugin</div>"]
    B --> C["<div style='font-size: 14px;'>⚡ 10x Reporter</div><div style='font-size: 10px;'>sidecar</div>"]
    C --> D["<div style='font-size: 14px;'>📊 Metrics</div><div style='font-size: 10px;'>Prometheus</div>"]
    B --> E["<div style='font-size: 14px;'>📤 Fluentd</div><div style='font-size: 10px;'>outputs</div>"]

    classDef input fill:#2563eb,stroke:#1d4ed8,color:#ffffff,stroke-width:2px,rx:8,ry:8
    classDef filter fill:#ea580c,stroke:#c2410c,color:#ffffff,stroke-width:2px,rx:8,ry:8
    classDef engine fill:#7c3aed,stroke:#6d28d9,color:#ffffff,stroke-width:2px,rx:8,ry:8
    classDef metrics fill:#16a34a,stroke:#15803d,color:#ffffff,stroke-width:2px,rx:8,ry:8
    classDef output fill:#0891b2,stroke:#0e7490,color:#ffffff,stroke-width:2px,rx:8,ry:8

    class A input
    class B filter
    class C engine
    class D metrics
    class E output

Data Flow

  • 📂 Fluentd Sources - Collect logs from files, TCP, HTTP, or other sources
  • 🔧 exec_filter Plugin - Launches 10x sidecar and pipes events via stdin/stdout
  • ⚡ 10x Reporter - Transforms events into TenXObjects, aggregates metrics
  • 📊 Metrics Output - Publishes time-series data to Prometheus/metrics backends
  • 📤 Fluentd Outputs - Original events continue unchanged to final destinations

Key Characteristics

Feature Description
📊 Read-Only Reporter observes events without modifying the pipeline
🔗 Parallel Flow Events flow to both 10x Reporter AND original outputs
📈 Metrics Publishing Aggregates and publishes to time-series backends
🔧 exec_filter Uses Fluentd's native exec_filter for stdin/stdout piping

Sidecar Relay

This module configures a Fluentd exec-filter that launches a 10x sidecar process and passes it collected events to aggregate and publish to time-series outputs.

Install

See the Log10x Edge Reporter Fluentd run instructions

Deploy to k8s via Helm

See the Log10x Edge Reporter Fluentd deployment instructions

Configuration

To configure the Fluentd reporter module, Edit these settings.

Below is the default configuration from: report/config.yaml.

Edit Online

Edit config.yaml Locally 

# 🔟❎ 'run' Fluentd reporter configuration

# Configure an input that reads events from a Fluentd forwarder.
# To learn more see https://doc.log10x.com/run/input/forwarder/fluentd/report/

# This config runs in conjunction with the instructions provided in:
# https://doc.log10x.com/run/input/forwarder/fluentd/report/#install

# Set the 10x pipeline to 'run'
tenx: run

# =============================== Dependencies ================================

# read events from the forwarder using the Fluentd 'forward' protocol
# https://docs.fluentd.org/output/forward
include: run/modules/input/forwarder/fluentd/input


This module is defined in report/module.yaml.