Skip to content

Report

Read events from a Logstash 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;'>📂 Logstash</div><div style='font-size: 10px;'>inputs</div>"] --> B["<div style='font-size: 14px;'>🔧 Pipe Output</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>"]
    A --> E["<div style='font-size: 14px;'>📤 Logstash</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

  • 📂 Logstash Inputs - Collect logs from files, beats, TCP, or other sources
  • 🔧 Pipe Output Plugin - Launches 10x sidecar and pipes events via stdin
  • ⚡ 10x Reporter - Transforms events into TenXObjects, aggregates metrics
  • 📊 Metrics Output - Publishes time-series data to Prometheus/metrics backends
  • 📤 Logstash 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
🔧 Pipe Output Uses Logstash's pipe output plugin for stdin piping

Sidecar Relay

This module configures a Logstash pipe output plugin. The Logstash output plugin launches a 10x sidecar process and pipes events to aggregate and publish to time-series outputs.

Install

See the Log10x Edge Reporter Logstash run instructions

Currently not supported

Config Files

To configure the Logstash reporter module, Edit these files.

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

Edit Online

Edit config.yaml Locally 

# 🔟❎ 'run' Logstash reporter configuration

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

# This file operates used in conjunction with:
# https://github.com/log-10x/config/blob/main/pipelines/run/input/forwarder/logstash/report/tenx-pipe-out.conf

# tenx-pipe-out.conf configures a Logstash forwarder to launch a 10x 'run' subprocess to
# write events to its stdin pipe for aggregation and reporting.

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

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

include: run/modules/input/forwarder/logstash/input


This module is defined in report/module.yaml.