diff options
| author | Paul Buetow <paul@buetow.org> | 2021-11-07 14:58:13 +0200 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2021-11-07 14:58:13 +0200 |
| commit | 3e05d5657c7c26a8d73c7be2f83a1d701ba896c7 (patch) | |
| tree | 2483ad7ec7a0e5abdf2805458b9f0c22f852f321 | |
| parent | 84166ab05f72ed23ada3802fc0baf0cec5eb1233 (diff) | |
Finetune example docs
| -rw-r--r-- | doc/examples.md | 35 |
1 files changed, 19 insertions, 16 deletions
diff --git a/doc/examples.md b/doc/examples.md index 803b1af..2d57cbf 100644 --- a/doc/examples.md +++ b/doc/examples.md @@ -1,7 +1,7 @@ Examples ======== -This page demonstrates the primary usage of DTail. Please also see `dtail --help` for more available options. +This page demonstrates the primary usage of DTail. Please also see `--help` for more available options. ## Table of contents @@ -16,7 +16,7 @@ This page demonstrates the primary usage of DTail. Please also see `dtail --help ### Following logs -The following example demonstrates how to follow logs of multiple servers at once. The server list is provided as a flat text file. The example filters all records containing the string `INFO` Any other Go compatible regular expression can be used instead of `INFO` +The following example demonstrates how to follow logs of multiple servers at once. The server list is provided as a flat text file. The example filters all records containing the string `INFO`. Any other Go compatible regular expression can also be used instead of `INFO`. ```shell % dtail --servers serverlist.txt --grep INFO --files "/var/log/dserver/*.log" @@ -26,7 +26,7 @@ Hint: you can also provide a comma separated server list, e.g.: `servers server1  -Hint: You can also use the shorthand version (omitting the `files` +Hint: You can also use the shorthand version (omitting the `--files`) ```shell % dtail --servers serverlist.txt --grep INFO "/var/log/dserver/*.log" @@ -34,7 +34,9 @@ Hint: You can also use the shorthand version (omitting the `files` ### Aggregating logs -To run ad-hoc map-reduce aggregations on newly written log lines you must add a query. The following example follows all remote log lines and prints out every few seconds the top 10 servers with the most average free memory. To run a map-reduce query across log lines written in the past, please use the `dmap` command instead. +To run ad-hoc map-reduce aggregations on newly written log lines you must add a query. The following example follows all remote log lines and prints out every few seconds the result to standard output. + +Hint: To run a map-reduce query across log lines written in the past, please use the `dmap` command instead. ```shell % dtail --servers serverlist.txt \ @@ -42,7 +44,7 @@ To run ad-hoc map-reduce aggregations on newly written log lines you must add a --query 'from STATS select sum($goroutines),sum($cgocalls),last($time),max(lifetimeConnections)' ``` -For map-reduce queries to work, you have to ensure that DTail supports your log format. You can either use the ones already defined in `internal/mapr/log format` or add an extension to support a custom log format. +Beware: For map-reduce queries to work, you have to ensure that DTail supports your log format. You can either use the ones already defined in `internal/mapr/logformat` or add an extension to support a custom log format.  @@ -53,7 +55,7 @@ Hint: You can also use the shorthand version: --files '/var/log/dserver/*.log' \ 'from STATS select sum($goroutines),sum($cgocalls),last($time),max(lifetimeConnections)' ``` -Here is yet another example: +Here is another example: ```shell % dtail --servers serverlist.txt \ @@ -67,7 +69,7 @@ Here is yet another example: The following example demonstrates how to cat files (display the full content of the files) of multiple servers at once. -As you can see in this example, a DTail client also creates a local log file of all received data in `log` You can also use the `noColor` and `-plain` flags (they also work with other commands than `dcat`). +As you can see in this example, a DTail client also creates a local log file of all received data in `~/log`. You can also use the `noColor` and `-plain` flags (this all also work with other DTail commands than `dcat`). ```shell % dcat --servers serverlist.txt --files /etc/hostname @@ -83,7 +85,7 @@ Hint: You can also use the shorthand version: ## How to use `dgrep` -The following example demonstrates how to grep files (display only the lines which match a given regular expression) of multiple servers at once. In this example, we look after some entries in `etc/passwd` This time, we don't provide the server list via an file but rather via a comma separated list directly on the command line. We also explore the `-before`, `-after` and `-max` flags. +The following example demonstrates how to grep files (display only the lines which match a given regular expression) of multiple servers at once. In this example, we look after some entries in `/etc/passwd` This time, we don't provide the server list via an file but rather via a comma separated list directly on the command line. We also explore the `-before`, `-after` and `-max` flags (see animation). ```shell % dgrep --servers server1.example.org:2223 \ @@ -91,7 +93,7 @@ The following example demonstrates how to grep files (display only the lines whi --regex nologin ``` -Generally, this is also a very useful way to search historic application logs. +Generally, `dgrep` is also a very useful way to search historic application logs for certain content.  @@ -99,7 +101,7 @@ Hint: `-regex` is an alias for `-grep`. ## How to use `dmap` -To run a map-reduce aggregation over logs written in the past, the `dmap` command has be used. The following example aggregates all map-reduce fields `dmap` will print interim results every few seconds. You can also write the result to an CSV file by adding `outfile result.csv` to the query. +To run a map-reduce aggregation over logs written in the past, the `dmap` command can be used. The following example aggregates all map-reduce fields `dmap` will print interim results every few seconds. You can also write the result to an CSV file by adding `outfile result.csv` to the query. ```shell % dmap --servers serverlist.txt \ @@ -107,15 +109,17 @@ To run a map-reduce aggregation over logs written in the past, the `dmap` comman --query 'from STATS select $hostname,max($goroutines),max($cgocalls),$loadavg,lifetimeConnections group by $hostname order by max($cgocalls)' ``` -Remember: For that to work, you have to make sure that DTail supports your log format. You can either use the ones already defined in `internal/mapr/logformat` or add an extension to support a custom log format. Te example here works out of the box though, as DTail understands its own log format already. +Remember: For that to work, you have to make sure that DTail supports your log format. You can either use the ones already defined in `internal/mapr/logformat` or add an extension to support a custom log format. The example here works out of the box though, as DTail understands its own log format already.  ## How to use the DTail serverless mode -Until now, all examples so far assumed to have remote server(s) to connect to. That makes sense, as after all DTail is a *distributed* tool. However, there are circumstances where you don't really need to connect to a server remotely. For example, you already have a login shell open to the server an all what you want is to run some queries directly on local log files. +Until now, all examples so far required to have remote server(s) to connect to. That makes sense, as after all DTail is a *distributed* tool. However, there are circumstances where you don't really need to connect to a server remotely. For example, you already have a login shell open to the server an all what you want is to run some queries directly on local log files. + +The serverless mode does not require any `dserver` up and running and therefore there is no networking/SSH involved. -All commands shown so far also work in a serverless mode. All what needs to be done is to omit a server list. The DTail client then starts in serverless mode. +All commands shown so far also work in a serverless mode. All what needs to be done is to omit a server list. The DTail client then starts in serverless mode. ### Serverless map-reduce query @@ -141,7 +145,7 @@ You can also use a file input pipe as follows: ### Other serverless commands -It works transparently with all other DTail commands. Here are some examples: +The serverless mode works transparently with all other DTail commands. Here are some examples: ```shell dtail /var/log/dserver/dserver.log @@ -166,6 +170,5 @@ dgrep --regex ERROR --files /var/log/dserver/dsever.log ``` ```shell -dgrep --before 10 --after 10 --max 10 --grep ERROR \ - /var/log/dserver/dsever.log +dgrep --before 10 --after 10 --max 10 --grep ERROR /var/log/dserver/dsever.log ``` |
