Skip to content

Commit 123f0a3

Browse files
committed
2 parents 663e89d + 507de49 commit 123f0a3

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Fluent Bit with Kubernetes
2-
This repository contains the code, configurations, test data, and utilities for Manning's book [Fluent Bit with Kubernetes](https://www.manning.com/books/fluent-bit-with-kubernetes?utm_source=Phil&utm_medium=affiliate), as well as the book's examples and solutions. We have incorporated some additional examples within the chapter folders.
1+
# Logs and Telemetry using Fluent Bit, Kubernetes, streaming and more
2+
This repository contains the code, configurations, test data, and utilities for Manning's book [Logs and Telemetry using Fluent Bit]([https://www.manning.com/books/fluent-bit-with-kubernetes?utm_source=Phil&utm_medium=affiliate](https://www.manning.com/books/logs-and-telemetry?utm_source=Phil&utm_medium=affiliate)), as well as the book's examples and solutions. We have incorporated some additional examples within the chapter folders.
33

44
A quick summary of the book's chapters:
55

@@ -15,33 +15,33 @@ A quick summary of the book's chapters:
1515
10. Building Plugins
1616
11. Putting Fluent Bit into action - an enterprise use case
1717

18-
There are additional read-me documents incorporated into the different folders providing domain or chapter specific information.
18+
Additional read-me documents are incorporated into the different folders to provide domain- or chapter-specific information.
1919

20-
![](https://mp3muncher.files.wordpress.com/2023/11/front-cover-meap-sponsored.png?w=529)
20+
![](https://blog.mp3monster.org/wp-content/uploads/2024/07/wilkins-hi.jpg?w=529)
2121

2222
### Demo Configurations
2323

2424
The chapters container demo configurations to illustrate different aspects of Fluent Bit. This includes for some chapters scripts which wrap utilities / tools in a container.
2525

26-
##### Cross Platform Constraints
26+
##### Cross-Platform Constraints
2727

2828
It is important to note that **a couple of demos CAN'T run on (Mac and Windows)** as not all plugins support all platforms. We have focussed on all the demos working for Linux as this is the typical platform for containerized/Kubernetes solutions. The root of the issue is that there are a few plugins that have not been built for macOS (particularly for Apple silicon), and for Windows some of the OS level services do not have a direct equivalent.
2929

3030
We've noted the constraints in the text of the book, and the book also has a table showing which plugins are supported by which platforms.
3131

3232
##### Classic & YAML Configurations
3333

34-
Fluent Bit is slowly pushing towards YAML as the configuration standard, although with a couple of exceptions the classic and YAML configuration formats work for all plugins. As a result we have provided YAML versions of the configuration files (although during development we've largely worked with the classic format first).
34+
Fluent Bit is slowly pushing towards YAML as the configuration standard, although with a couple of exceptions, the classic and YAML configuration formats work for all plugins. As a result, we have provided YAML versions of the configuration files (although during development, we've largely worked with the classic format first).
3535

3636
#### Extras
3737

38-
In addition to the content in the book, we have also incorporated some extra resources such as additional configurations, but also details such as Rail Road diagrams. They are in a folder called [extras](https://github.com/mp3monster/Fluentbit-with-Kubernetes/tree/main/extras) or, where more appropriate, in the relevant folder.
38+
In addition to the content in the book, we have also incorporated some extra resources, such as additional configurations and details, such as Rail Road diagrams. They are in a folder called [extras](https://github.com/mp3monster/Logs-and-Telemetry--Using-Fluent-Bit/tree/main/extras) or, where more appropriate, in the relevant folder.
3939

4040
##### Railroad diagrams
4141

4242
Details of the railroad diagrams can be found here, and an example diagram:
4343

44-
![](https://github.com/mp3monster/Fluentbit-with-Kubernetes/blob/main/extras/Syntax%20RailRoad%20Diagrams/Classic%20Configuration%20Format%20Railroad%20Diagram.png?raw=true)
44+
![](https://github.com/mp3monster/Logs-and-Telemetry--Using-Fluent-Bit/blob/main/extras/Syntax%20RailRoad%20Diagrams/Classic%20Configuration%20Format%20Railroad%20Diagram.png?raw=true)
4545

4646
## About the Book
4747
This book covers Fluent Bit v2 onwards, focusing on its application and configuration. It's designed to cater to your specific interests in logging and monitoring, even if you haven't read Logging In Action.
@@ -52,13 +52,13 @@ It is being written as a partner title to [Logging In Action](https://www.mannin
5252

5353
### Log Simulator
5454

55-
The book uses several third-party tools, all referenced in Appendix A. The Log Simulator can be a very helpful tool for developing and testing Fluent Bit configurations (although it is currently limited to just logs). All the resources can be found in the [Log Generator GitHub](https://github.com/mp3monster/LogGenerator) repository.
55+
The book uses several third-party tools, all of which are referenced in Appendix A. The Log Simulator can be a very helpful tool for developing and testing Fluent Bit configurations (although it is currently limited to logs). All the resources can be found in the [Log Generator GitHub](https://github.com/mp3monster/LogGenerator) repository.
5656

5757
The docker scripts we've provided to run the Log Simulator (are in the folder `SimulatorConfig` in the relevant chapter folders). These scripts exist to just simplify the Docker command - primarily mapping the volumes and environment variable configuration settings for a specific scenario.
5858

5959
The command does include the parameters `-ti --init` . This means that the Docker container will terminate with the use of `ctrl-c`. These parameters do the following:
6060

61-
- `-ti` tell Docker to use a pseudo tty (terminal input) and to run interactively. As a result, you will see everything the Log Simulator sends to the console.
61+
- `-ti` tells Docker to use a pseudo tty (terminal input) and to run interactively. As a result, you will see everything the Log Simulator sends to the console.
6262
- `--init` command modifies the way the process is started within the container so that the
6363

6464
The use of this `-ti --init` is nicely explained [here](https://www.baeldung.com/ops/docker-init-parameter) and you can read more about how `--init` works [here](https://github.com/krallin/tini).

0 commit comments

Comments
 (0)