Getting Started

Getting Started with Kinetic🔗

Kinetic is a high-performance, end-to-end observability data pipeline. This guide will help you get up and running with your first pipeline.

Installation🔗

Currently, Kinetic is built from source. Ensure you have the Rust toolchain installed.

git clone https://github.com/jimmystewpot/kinetic
cd kinetic
cargo build --release

Your First Pipeline🔗

Kinetic uses a YAML configuration file to define pipelines. A pipeline consists of sources, transforms, and sinks.

Create a file named pipeline.yaml:

sources:
  my_source:
    type: internal_metrics

transforms:
  my_transform:
    type: filter
    inputs: [my_source]
    condition:
      type: pass
      source: my_source

sinks:
  my_sink:
    type: dlq
    inputs: [my_transform]
    region: us-east-1
    bucket: my-kinetic-dlq
    prefix: alerts/

Running Kinetic🔗

Start Kinetic with your configuration:

./target/release/kinetic --config pipeline.yaml

Next Steps🔗