diff --git a/content/docs/configuration/fluentd-vs-syslog-ng.md b/content/docs/configuration/fluentd-vs-syslog-ng.md index 113d45b22..668fac007 100644 --- a/content/docs/configuration/fluentd-vs-syslog-ng.md +++ b/content/docs/configuration/fluentd-vs-syslog-ng.md @@ -4,16 +4,16 @@ linktitle: Fluentd or syslog-ng weight: 10 --- -The Logging operator supports [Fluentd](https://www.fluentd.org/) and syslog-ng (via the [AxoSyslog syslog-ng distribution](https://axoflow.com/docs/axosyslog-core/)) as log forwarders. The log forwarder instance receives, filters, and transforms the incoming the logs, and transfers them to one or more destination outputs. Which one to use depends on your logging requirements. +The Logging operator supports [Fluentd](https://www.fluentd.org/) and syslog-ng (via the [AxoSyslog syslog-ng distribution](https://axoflow.com/docs/axosyslog-core/)) as log forwarders. The log forwarder instance receives, filters, and transforms the incoming logs, and transfers them to one or more destination outputs. Which one to use depends on your logging requirements. The following points help you decide which forwarder to use. -- The forwarders support different outputs. If the output you want to use is supported only by one forwarder, use that. +- The forwarders support different outputs. If the output you want to use is supported by only one forwarder, use that. - If the volume of incoming log messages is high, use syslog-ng, as its multithreaded processing provides higher performance. -- If you have lots of logging flows or need complex routing or log message processing, use syslog-ng. +- If you have many logging flows or need complex routing or log message processing, use syslog-ng. -> Note: Depending on which log forwarder you use, some of the CRDs you have to create and configure are different. +> Note: Depending on the log forwarder you choose, the CRDs you need to create and configure will differ. {{< include-headless "syslog-ng-minimum-version.md" >}} diff --git a/content/docs/configuration/output.md b/content/docs/configuration/output.md index 3ffd5ecf4..37e35cb83 100644 --- a/content/docs/configuration/output.md +++ b/content/docs/configuration/output.md @@ -52,10 +52,10 @@ spec: ## syslog-ng outputs {#syslogngoutput} - The `SyslogNGOutput` resource defines an output for **syslog-ng** where your SyslogNGFlows can send the log messages. The output is a `namespaced` resource which means only a `SyslogNGFlow` within the *same* namespace can access it. You can use `secrets` in these definitions, but they must also be in the same namespace. -Outputs are the final stage for a `logging flow`. You can define multiple `SyslogNGoutputs` and attach them to multiple `SyslogNGFlows`. +Outputs are the final stage for a `logging flow`. You can define multiple `SyslogNGOutputs` and attach them to multiple `SyslogNGFlows`. - `SyslogNGClusterOutput` defines a SyslogNGOutput **without** namespace restrictions. It is only evaluated in the `controlNamespace` by default unless `allowClusterResourcesFromAllNamespaces` is set to true. -> Note: `SyslogNGFlow` can be connected to `SyslogNGOutput` and `SyslogNGClusterOutput`, but `SyslogNGClusterFlow` can be attached only to `SyslogNGClusterOutput`. +> Note: `SyslogNGFlow` can be connected to `SyslogNGOutput` and `SyslogNGClusterOutput`, but a `SyslogNGClusterFlow` can only be attached to a `SyslogNGClusterOutput`. ### RFC5424 syslog-ng output example diff --git a/content/docs/quickstarts/single.md b/content/docs/quickstarts/single.md index 04879c764..48bf0bd59 100644 --- a/content/docs/quickstarts/single.md +++ b/content/docs/quickstarts/single.md @@ -8,7 +8,7 @@ weight: 100 In this tutorial, you will: - Install the Logging operator on a cluster. -- Configure Logging operator to collect logs from a namespace and send it to an sample output. +- Configure Logging operator to collect logs from a namespace and send it to a sample output. - Install a sample application (log-generator) to collect its logs. - Check the collected logs. @@ -53,7 +53,7 @@ EOF {{% /tab %}} {{< /tabpane >}} - > Note: The control namespace is where the Logging operator deploys the forwarder's resources, like the StatefulSet and the configuration secrets. Usually it's called `logging`. + > Note: The control namespace is where the Logging operator deploys the forwarder's resources, such as the StatefulSet and the configuration secrets. Usually it's called `logging`. > > By default, this namespace is used to define the cluster-wide resources: `SyslogNGClusterOutput`, `SyslogNGClusterFlow`, `ClusterOutput`, and `ClusterFlow`. For details, see {{% xref "/docs/configuration/_index.md" %}}. @@ -110,7 +110,7 @@ quickstart-fluentd-configcheck-ac2d4553 0/1 Completed 0 60s {{% /tab %}} {{< /tabpane >}} -1. Create a namespace (for example, `quickstart`) from where you want to collect the logs. +1. Create a namespace (for example: `quickstart`) from which you want to collect the logs from. ```bash kubectl create namespace quickstart @@ -258,7 +258,7 @@ fluentbitagent.logging.banzaicloud.io/quickstart 3m2s {{% /tab %}} {{< /tabpane >}} -1. Install log-generator to produce logs with the label `app.kubernetes.io/name: log-generator` +1. Install the log-generator to produce logs labelled with: `app.kubernetes.io/name: log-generator` ```bash helm upgrade --install --wait --namespace quickstart log-generator oci://ghcr.io/kube-logging/helm-charts/log-generator @@ -340,10 +340,10 @@ If you have completed this guide, you have made the following changes to your cl - Installed syslog-ng or Fluentd on the cluster, to receive the logs from the Fluent Bit agents, and filter, parse, and transform them as needed, and to route the incoming logs to an output. To learn more about routing and filtering, see {{% xref "/docs/configuration/log-routing-syslog-ng.md" %}} or {{% xref "/docs/configuration/log-routing.md" %}}. - Created the following resources that configure Logging operator and the components it manages: - `Logging` to configure the logging infrastructure, like the details of the Fluent Bit and the syslog-ng or Fluentd deployment. To learn more about configuring the logging infrastructure, see {{% xref "/docs/logging-infrastructure/_index.md" %}}. - - `SyslogNGOutput` or `Output` to define an http output that receives the collected messages. To learn more, see {{% xref "/docs/configuration/output.md#syslogngoutput" %}} or {{% xref "/docs/configuration/output.md" %}}. + - `SyslogNGOutput` or `Output` to define an HTTP output that receives the collected messages. To learn more, see {{% xref "/docs/configuration/output.md#syslogngoutput" %}} or {{% xref "/docs/configuration/output.md" %}}. - `SyslogNGFlow` or `Flow` that processes the incoming messages and routes them to the appropriate output. To learn more, see {{% xref "/docs/configuration/flow.md#syslogngflow" %}} or {{% xref "/docs/configuration/flow.md" %}}. -- Installed a simple receiver to act as the destination of the logs, and configured the the log forwarder to send the logs from the `quickstart` namespace to this destination. +- Installed a simple receiver to act as the destination of the logs, and configured the log forwarder to send the logs from the `quickstart` namespace to this destination. - Installed a log-generator application to generate sample log messages, and verified that the logs of this application arrive to the output. diff --git a/content/headless/quickstart/deploy-logging-operator-helm.md b/content/headless/quickstart/deploy-logging-operator-helm.md index 20a6b3be3..1bef93fde 100644 --- a/content/headless/quickstart/deploy-logging-operator-helm.md +++ b/content/headless/quickstart/deploy-logging-operator-helm.md @@ -26,7 +26,7 @@ REVISION: 1 TEST SUITE: None ``` -After the installation, check that the following pods and services are running: +After the installation is completed, check that the following pods and services are running: ```shell kubectl get deploy -n logging diff --git a/content/headless/quickstart/intro.md b/content/headless/quickstart/intro.md index 203257be3..42084380d 100644 --- a/content/headless/quickstart/intro.md +++ b/content/headless/quickstart/intro.md @@ -1,7 +1,7 @@ This guide shows you how to collect application and container logs in Kubernetes using the Logging operator. -The Logging operator itself doesn't store any logs. For demonstration purposes, it can deploy a special workload will to the cluster to let you observe the logs flowing through the system. +The Logging operator itself doesn't store any logs. For demonstration purposes, it can deploy a special workload to the cluster to let you observe the logs flowing through the system. The Logging operator collects all logs from the cluster, selects the specific logs based on pod labels, and sends the selected log messages to the output. For more details about the Logging operator, see the [Logging operator overview]({{< relref "/docs/_index.md">}}).