Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix README typos and clarify #132

Merged
merged 2 commits into from
Jul 7, 2022
Merged

Fix README typos and clarify #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a03a12
Fix typo
stephen-soltesz Jul 7, 2022
b6bc4a9
Fix typo and clarify text
stephen-soltesz Jul 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ implementation `cmd/example-eventsocket-client` can be started using
`docker-compose`.

```bash
docker-compse up
docker-compose up
```

New TCP events are processed by the `example-eventsocket-client` sidecar and
Expand Down
16 changes: 11 additions & 5 deletions cmd/csvtool/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
# csvtool

The csvtool is intended to convert from ArchiveRecord files to CSV files.
It currently only handles raw or zstd compressed JSONL files as source.
It takes a single command line argument, which is the name of the file, or "-" to read uncompressed JSONL from stdin.
The csvtool is intended to convert the ArchiveRecord file format produced by
tcp-info to more easily usable CSV files. csvtool currently only handles
individual, raw or zstd compressed JSONL files as a source. Named files should
be the only parameter. If reading uncompressed JSONL from STDIN, provide no
argument.

## Examples:
## Examples

Decompressing the JSONL file so that csvtool reads from stdin:

```bash
zstd -cd 2019/04/01/ndt-jdczh_1553815964_00000000000003E8.00184.jsonl.zst | ./csvtool - > connection.csv
zstd -cd 2019/04/01/ndt-jdczh_1553815964_00000000000003E8.00184.jsonl.zst | ./csvtool > connection.csv
```

Directly read compressed format:

```bash
./csvtool 2019/04/01/ndt-jdczh_1553815964_00000000000003E8.00184.jsonl.zst > connection.csv
```