Chapter 1. Red Hat OpenShift Logging overview
The ClusterLogForwarder
custom resource (CR) is the central configuration point for log collection and forwarding.
1.1. Inputs and outputs Copy linkLink copied to clipboard!
Inputs specify the sources of logs to be forwarded. Logging provides the following built-in input types that select logs from different parts of your cluster:
-
application
-
receiver
-
infrastructure
-
audit
You can also define custom inputs based on namespaces or pod labels to fine-tune log selection.
Outputs define the destinations where logs are sent. Each output type has its own set of configuration options, allowing you to customize the behavior and authentication settings.
1.2. Receiver input type Copy linkLink copied to clipboard!
The receiver input type enables the Logging system to accept logs from external sources. It supports two formats for receiving logs: http
and syslog
.
The ReceiverSpec
field defines the configuration for a receiver input.
1.3. Pipelines and filters Copy linkLink copied to clipboard!
Pipelines determine the flow of logs from inputs to outputs. A pipeline consists of one or more input refs, output refs, and optional filter refs. You can use filters to transform or drop log messages within a pipeline. The order of filters matters, as they are applied sequentially, and earlier filters can prevent log messages from reaching later stages.
1.4. Operator behavior Copy linkLink copied to clipboard!
The Cluster Logging Operator manages the deployment and configuration of the collector based on the managementState
field of the ClusterLogForwarder
resource:
-
When set to
Managed
(default), the Operator actively manages the logging resources to match the configuration defined in the spec. -
When set to
Unmanaged
, the Operator does not take any action, allowing you to manually manage the logging components.
1.5. Validation Copy linkLink copied to clipboard!
Logging includes extensive validation rules and default values to ensure a smooth and error-free configuration experience. The ClusterLogForwarder
resource enforces validation checks on required fields, dependencies between fields, and the format of input values. Default values are provided for certain fields, reducing the need for explicit configuration in common scenarios.