From 67dfd9616a56f0d852a806585c2583ec5dd42e64 Mon Sep 17 00:00:00 2001 From: at055612 <22818309+at055612@users.noreply.github.com> Date: Mon, 30 Oct 2023 14:20:52 +0000 Subject: [PATCH] Remove context from segmented stream in streams.md --- .../user-guide/concepts/streams/segmented-stream.puml | 2 -- content/en/docs/user-guide/concepts/streams.md | 8 +++++++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/assets/images/user-guide/concepts/streams/segmented-stream.puml b/assets/images/user-guide/concepts/streams/segmented-stream.puml index 72483aec86..5161d34f28 100644 --- a/assets/images/user-guide/concepts/streams/segmented-stream.puml +++ b/assets/images/user-guide/concepts/streams/segmented-stream.puml @@ -13,8 +13,6 @@ rectangle "Stream nnn" #Silver { } rectangle "Meta" #SeaGreen { } - rectangle "Context" #SlateBlue { - } } } diff --git a/content/en/docs/user-guide/concepts/streams.md b/content/en/docs/user-guide/concepts/streams.md index d4e78713d5..a405de2017 100644 --- a/content/en/docs/user-guide/concepts/streams.md +++ b/content/en/docs/user-guide/concepts/streams.md @@ -13,6 +13,7 @@ Streams can either be created when data is directly POSTed in to Stroom or durin When data is directly POSTed to Stroom the content of the POST will be stored as one Stream. With proxy aggregation multiple files in the proxy repository will/can be aggregated together into a single Stream. + ## Anatomy of a Stream A Stream is made up of a number of parts of which the raw or cooked data is just one. @@ -40,16 +41,19 @@ Segmented means that the data has been demarcated into segments or records. This is the actual data of the stream, e.g. the XML events, raw CSV, JSON, etc. + #### Context This is additional contextual data that can be sent with the data. Context data can be used for reference data lookups. + #### Meta Data This is the data about the Stream (e.g. the feed name, receipt time, user agent, etc.). This meta data either comes from the HTTP headers when the data was POSTed to Stroom or is added by Stroom or Stroom-Proxy on receipt/processing. + ### Non-Segmented Stream The following is a representation of a non-segmented stream with three parts, each with Meta Data and Context child streams. @@ -64,9 +68,10 @@ The Stream may be single-part or multi-part depending on how it is received. If it is the product of proxy aggregation then it is likely to be multi-part. Each part will have its own context and meta data child streams, if applicable. + ### Segmented Stream -The following is a representation of a segmented stream that contains three records (i.e events) and has Meta Data and Context child streams. +The following is a representation of a segmented stream that contains three records (i.e events) and the Meta Data. {{< image "user-guide/concepts/streams/segmented-stream.puml.svg" >}}Segmented Stream{{< /image >}} @@ -74,6 +79,7 @@ Cooked Events and Reference data are forms of segmented data. The raw data has been parsed and split into records/events and the resulting data is stored in a way that allows Stroom to know where each record/event starts/ends. These streams only have a single part. + ### Error Stream {{< image "user-guide/concepts/streams/error-stream.puml.svg" >}}Error Stream{{< /image >}}