From 8ae076422f9a59e38de4c334e053ea853f7ae50e Mon Sep 17 00:00:00 2001 From: Luc Perkins Date: Mon, 18 Oct 2021 08:44:28 -0700 Subject: [PATCH] Update README Signed-off-by: Luc Perkins --- csv-enrichment/README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/csv-enrichment/README.md b/csv-enrichment/README.md index 0fdad46..be9b01a 100644 --- a/csv-enrichment/README.md +++ b/csv-enrichment/README.md @@ -1,20 +1,24 @@ # CSV enrichment in Vector -**Note:** This feature is unreleased and still under active development. However, if you want to try it out, we would -love any feedback! +> **Note:** This feature is unreleased and still under active development. However, if you want to try it out, we would +> love any feedback! ## How to start it -`docker-compose up` +```shell +docker-compose up +``` ## What it does -This demo shows an example of using CSV enrichment in Vector to enrich events with data from a CSV file. +This demo shows an example of using CSV enrichment in Vector to enrich events with data from two CSV files. -The CSV file ([`./data/users.csv`](./data/users.csv) contains a list of users with their phone numbers and addresses. +The [`users.csv`](./data/users.csv) file contains a list of users with their phone numbers and addresses, while the +[`codes.csv`](./data/codes.csv) file contains a list of common Unix exit codes (with code, tag, and message info). -The `vector.toml` configuration contains: +The [`vector.toml`](./vector.toml) configuration contains: -* A `random` source in the `vector.toml` that simply generates some fake events using names that match users in the CSV file -* A `remap` transform then parses these events and then looks up the corresponding record from the CSV file to enrich the event with more metadata +* Two `generator` sources in the that generate fake events that can be enriched using the CSV files (user data and coded error messages + respectively) +* Two `remap` transforms that parse the events and then look up the corresponding records from the CSV files to enrich the events with more metadata * A `console` sink to print out the events