From fe010308fdcb07502c0287bdf684b41b1af9c8a6 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Thu, 21 Oct 2021 20:55:44 +0300 Subject: merge doc from master branch --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d65d124..6515b76 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,26 @@ DTail ===== -![DTail](doc/logo.png "DTail") +![DTail](doc/title.png "DTail") -DTail (a distributed tail program) is a DevOps tool for engineers programmed in Google Go for following (tailing), catting and grepping (including gzip and zstd decompression support) log files on many machines concurrently. An advanced feature of DTail is to execute distributed mapreduce aggregations across many machines. +[![License](https://img.shields.io/github/license/mimecast/dtail)](https://www.apache.org/licenses/LICENSE-2.0.html) [![Go Report Card](https://goreportcard.com/badge/github.com/mimecast/dtail)](https://goreportcard.com/report/github.com/mimecast/dtail) [![Hits-of-Code](https://hitsofcode.com/github/mimecast/dtail)](https://www.vbrandl.net/post/2019-05-03_hits-of-code/) ![GitHub issues](https://img.shields.io/github/issues/mimecast/dtail) ![GitHub forks](https://img.shields.io/github/forks/mimecast/dtail) ![GitHub stars](https://img.shields.io/github/stars/mimecast/dtail) -For secure authorization and transport encryption the SSH protocol is used. Furthermore, DTail respects the UNIX file system permission model (traditional on all Linux/UNIX variants and also ACLs on Linux based operating systems). +DTail (a distributed tail program) is a DevOps tool for engineers programmed in Google Go for following (tailing), catting and grepping (including gzip and zstd decompression support) log files on many machines concurrently. An advanced feature of DTail is to execute distributed MapReduce aggregations across many devices. -The DTail binary operate in either client or in server mode. The DTail server must be installed on all server boxes involved. The DTail client (possibly running on a regular Laptop) is used interactively by the user to connect to the servers concurrently. That currently scales to multiple thousands of servers per client. +For secure authorization and transport encryption, the SSH protocol is used. Furthermore, DTail respects the UNIX file system permission model (traditional on all Linux/UNIX variants and also ACLs on Linux based operating systems). + +The DTail binary operates in either client or server mode. The DTail server must be installed on all server boxes involved. The DTail client (possibly running on a regular Laptop) is used interactively to connect to the servers concurrently. That currently scales to multiple thousands of servers per client. ![DTail](doc/dtail.gif "Example") -If you like what you see [look here for more examples](doc/examples.md)! +If you like what you see [look here for more examples](doc/examples.md)! You can also read through the [DTail Mimecast Engineering Blog Post](https://medium.com/mimecast-engineering/dtail-the-distributed-log-tail-program-79b8087904bb). There is also a GitHub Page at [dtail.dev](https://dtail.dev). Installation and Usage ====================== -* For simplest setup please follow the [Quick Starting Guide](doc/quickstart.md). -* For a more sustainable setup please follow the [Installation Guide](doc/installation.md). -* Please also have a look at the [Usage Examples](doc/examples.md). +* For the most straightforward setup, please follow the [Quick Starting Guide](doc/quickstart.md). +* For a more sustainable setup, please follow the [Installation Guide](doc/installation.md). +* Please also look at the [Usage Examples](doc/examples.md). More ==== @@ -31,5 +33,5 @@ Credits ======= * DTail was created by **Paul Buetow** ** - -* Thank you to **Vlad-Marian Marian** for creating the DTail logo. +* Thank you to **Vlad-Marian Marian** for creating the DTail (dog) logo. +* The Gopher was generated at https://gopherize.me -- cgit v1.2.3 From 6edea198188172c603e10201aa2302a28b7b722f Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Thu, 21 Oct 2021 21:42:06 +0300 Subject: mention serverless mode in the main README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 6515b76..d8c18b7 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ DTail (a distributed tail program) is a DevOps tool for engineers programmed in For secure authorization and transport encryption, the SSH protocol is used. Furthermore, DTail respects the UNIX file system permission model (traditional on all Linux/UNIX variants and also ACLs on Linux based operating systems). -The DTail binary operates in either client or server mode. The DTail server must be installed on all server boxes involved. The DTail client (possibly running on a regular Laptop) is used interactively to connect to the servers concurrently. That currently scales to multiple thousands of servers per client. +The DTail binary operates in either client or server mode. The DTail server must be installed on all server boxes involved. The DTail client (possibly running on a regular Laptop) is used interactively to connect to the servers concurrently. That currently scales to multiple thousands of servers per client. Furthermore, DTail can be operated in a serverless mode too. Read more about it in the documentation. ![DTail](doc/dtail.gif "Example") -- cgit v1.2.3 From 1606b809fc905b74f1f2be408a6fc1393a8ac6dd Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Sun, 31 Oct 2021 18:01:27 +0200 Subject: add testing guide --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index d8c18b7..9d80405 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ If you like what you see [look here for more examples](doc/examples.md)! You can Installation and Usage ====================== +* Check out the [Testing Guide](doc/testing.md) for unit and integration testing. * For the most straightforward setup, please follow the [Quick Starting Guide](doc/quickstart.md). * For a more sustainable setup, please follow the [Installation Guide](doc/installation.md). * Please also look at the [Usage Examples](doc/examples.md). -- cgit v1.2.3 From 8de8bb925229368ae8c5f84362c1aed488d1aff5 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Sun, 7 Nov 2021 11:17:21 +0200 Subject: add reference to asciinema --- README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 9d80405..d5c1eb3 100644 --- a/README.md +++ b/README.md @@ -34,5 +34,7 @@ Credits ======= * DTail was created by **Paul Buetow** ** +* Thank you [Mimecast](https://www.mimecast.com) for supporting this Open-Source project. * Thank you to **Vlad-Marian Marian** for creating the DTail (dog) logo. * The Gopher was generated at https://gopherize.me +* The animated Gifs were created using `asciinema` with `asciicast2gif`. Checkout [this](./doc/asciinema/README.md) for more information. -- cgit v1.2.3 From c5679ae69d0ffd17d6675d2b275b62daa1522ced Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Sun, 7 Nov 2021 11:54:16 +0200 Subject: can set ssh private key path file via env var --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index d5c1eb3..c40a244 100644 --- a/README.md +++ b/README.md @@ -37,4 +37,4 @@ Credits * Thank you [Mimecast](https://www.mimecast.com) for supporting this Open-Source project. * Thank you to **Vlad-Marian Marian** for creating the DTail (dog) logo. * The Gopher was generated at https://gopherize.me -* The animated Gifs were created using `asciinema` with `asciicast2gif`. Checkout [this](./doc/asciinema/README.md) for more information. +* The animated Gifs were created using `asciinema` with `asciicast2gif`. Check out [how this was done](./doc/asciinema/README.md) for more information. -- cgit v1.2.3 From 1fa1f0329442c555635460221c809fecdaa977a7 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Tue, 7 Dec 2021 09:23:00 +0000 Subject: initial logformats and querylanguage documentation --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c40a244..8a0ac57 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,7 @@ If you like what you see [look here for more examples](doc/examples.md)! You can Installation and Usage ====================== -* Check out the [Testing Guide](doc/testing.md) for unit and integration testing. -* For the most straightforward setup, please follow the [Quick Starting Guide](doc/quickstart.md). -* For a more sustainable setup, please follow the [Installation Guide](doc/installation.md). -* Please also look at the [Usage Examples](doc/examples.md). +* Check out the [DTail Documentation](doc/index.md) More ==== -- cgit v1.2.3