Skip to content

Commit 2d28a68

Browse files
committed
docs: narrow quickstart changes to setup and configuration paths
1 parent 8a44536 commit 2d28a68

1 file changed

Lines changed: 11 additions & 12 deletions

File tree

‎website/content/en/docs/setup/quickstart.md‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,9 @@ mkdir vector-quickstart
6464
cd vector-quickstart
6565
```
6666

67-
Run all remaining commands from this directory. Copy and run the entire command below, including the final `YAML` line, to create `vector.yaml`:
67+
Let's create a configuration file called `vector.yaml`:
6868

69-
```shell
70-
cat > vector.yaml <<'YAML'
69+
```yaml filename="vector.yaml"
7170
sources:
7271
in:
7372
type: "stdin"
@@ -79,7 +78,6 @@ sinks:
7978
type: "console"
8079
encoding:
8180
codec: "text"
82-
YAML
8381
```
8482
8583
Each component has a unique id and is prefixed with the type of the component, for example `sources` for a source. Our first component, `sources.in`, uses the [`stdin` source][stdin], which tells Vector to receive data over stdin and is given the ID `in`.
@@ -90,7 +88,7 @@ The `inputs` option of the `sinks.out` component tells Vector where this sink's
9088

9189
## Hello world!
9290

93-
That's it for our first config. Now let's pipe an event through it. Choose the tab for your installation method:
91+
That's it for our first config. Now let's pipe an event through it:
9492

9593
{{< tabs default="Local installation" >}}
9694
{{< tab title="Local installation" >}}
@@ -119,16 +117,16 @@ The event we've just sent is received by our `sources.in` component, then sent o
119117

120118
```shell
121119
... some logs ...
122-
Hello world!
120+
Hello World!
123121
```
124122

125123
{{< info title="JSON encoding" >}}
126-
To see the event as JSON, change `codec: "text"` to `codec: "json"` under `encoding` in the sink configuration and run the command again.
124+
If you want to see something cool, try setting `encoding.codec = "json"` in the sink config.
127125
{{< /info >}}
128126

129127
## Hello Syslog!
130128

131-
Next, let's collect and process generated Syslog events. Open the same `vector.yaml` file in your text editor, replace its entire contents with the following configuration, and save the file:
129+
Echoing events into the console isn't terribly exciting. Let's see what we can do with some real observability data by collecting and processing Syslog events. To do that, we'll add two new components to our configuration file. Here's our updated `vector.yaml` configuration file:
132130

133131
```yaml filename="vector.yaml"
134132
sources:
@@ -157,9 +155,9 @@ sinks:
157155

158156
The first component uses the [`demo_logs` source][demo_logs], which creates sample log data that enables you to simulate different types of events in various formats.
159157

160-
{{< info >}}
161-
Generated logs let you try this pipeline without connecting to an external log source.
162-
{{< /info >}}
158+
{{< warning >}}
159+
Wait, I thought you said "real" observability data? We choose generated data here because it's hard for us to know which platform you're trying Vector on. That means it's also hard to document a single way for everyone to get data into Vector.
160+
{{< /warning >}}
163161

164162
The second component is a transform called [`remap`][remap]. The `remap` transform is at the heart of what makes Vector so powerful for processing observability data. The transform exposes a simple language called [Vector Remap Language][vrl] that allows you to parse, manipulate, and decorate your event data as it passes through Vector. Using `remap`, you can turn static events into informational
165163
data that can help you ask and answer questions about your environment's state.
@@ -176,7 +174,7 @@ We support parsing a variety of logging formats. Of course, if you have an event
176174

177175
Lastly, we've updated the ID of our sink component to `emit_syslog`, updated the `inputs` option to process events generated by the `remap_syslog` transform, and specified that we want to emit events in JSON-format.
178176

179-
Let's re-run Vector from the same directory, choosing the tab for your installation method. This time we don't need to echo any data to it. It'll process
177+
Let's re-run Vector. This time we don't need to echo any data to it; just run in on the command line. It'll process
180178
100 lines of generated Syslog data, emit the processed data as JSON, and exit:
181179

182180
{{< tabs default="Local installation" >}}
@@ -212,6 +210,7 @@ We're just scratching the surface in this post. To get your hands dirty with Vec
212210

213211
* All of Vector's [sources][sources], [transforms][transforms], and [sinks][sinks].
214212
* The [Vector Remap Language][vrl], the heart of data processing in Vector.
213+
* More details on [component configuration][config] in Vector.
215214
* Finally, [deploying Vector][deployment] to launch Vector in your production environment.
216215

217216
[components]: /components

0 commit comments

Comments
 (0)