mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
170 lines
6.1 KiB
Plaintext
170 lines
6.1 KiB
Plaintext
// Module is included in the following assemblies:
|
|
//cluster-logging-loki.adoc
|
|
:_content-type: REFERENCE
|
|
[id="cluster-logging-about-vector_{context}"]
|
|
= About Vector
|
|
Vector is a log collector offered as an alternative to Fluentd for the {logging}.
|
|
|
|
The following outputs are supported:
|
|
|
|
* `elasticsearch`. An external Elasticsearch instance. The `elasticsearch` output can use a TLS connection.
|
|
|
|
* `kafka`. A Kafka broker. The `kafka` output can use an unsecured or TLS connection.
|
|
|
|
* `loki`. Loki, a horizontally scalable, highly available, multitenant log aggregation system.
|
|
|
|
|
|
[id="cluster-logging-vector-enable_{context}"]
|
|
== Enabling Vector
|
|
Vector is not enabled by default. Use the following steps to enable Vector on your {product-title} cluster.
|
|
|
|
[IMPORTANT]
|
|
====
|
|
Vector does not support FIPS Enabled Clusters.
|
|
====
|
|
|
|
.Prerequisites
|
|
|
|
* {product-title}: 4.13
|
|
* {logging-title-uc}: 5.4
|
|
* FIPS disabled
|
|
|
|
.Procedure
|
|
|
|
. Edit the `ClusterLogging` custom resource (CR) in the `openshift-logging` project:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc -n openshift-logging edit ClusterLogging instance
|
|
----
|
|
|
|
. Add a `logging.openshift.io/preview-vector-collector: enabled` annotation to the `ClusterLogging` custom resource (CR).
|
|
|
|
. Add `vector` as a collection type to the `ClusterLogging` custom resource (CR).
|
|
|
|
[source,yaml]
|
|
----
|
|
apiVersion: "logging.openshift.io/v1"
|
|
kind: "ClusterLogging"
|
|
metadata:
|
|
name: "instance"
|
|
namespace: "openshift-logging"
|
|
annotations:
|
|
logging.openshift.io/preview-vector-collector: enabled
|
|
spec:
|
|
collection:
|
|
logs:
|
|
type: "vector"
|
|
vector: {}
|
|
----
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
* link:https://vector.dev/docs/about/what-is-vector/[Vector Documentation]
|
|
|
|
== Collector features
|
|
|
|
.Log Sources
|
|
[options="header"]
|
|
|===============================================================
|
|
| Feature | Fluentd | Vector
|
|
| App container logs | ✓ | ✓
|
|
| App-specific routing | ✓ | ✓
|
|
| App-specific routing by namespace | ✓ | ✓
|
|
| Infra container logs | ✓ | ✓
|
|
| Infra journal logs | ✓ | ✓
|
|
| Kube API audit logs | ✓ | ✓
|
|
| OpenShift API audit logs | ✓ | ✓
|
|
| Open Virtual Network (OVN) audit logs| ✓ | ✓
|
|
|===============================================================
|
|
|
|
.Outputs
|
|
[options="header"]
|
|
|==========================================================
|
|
| Feature | Fluentd | Vector
|
|
| Elasticsearch v5-v7 | ✓ | ✓
|
|
| Fluent forward | ✓ |
|
|
| Syslog RFC3164 | ✓ |
|
|
| Syslog RFC5424 | ✓ |
|
|
| Kafka | ✓ | ✓
|
|
| Cloudwatch | ✓ | ✓
|
|
| Loki | ✓ | ✓
|
|
|==========================================================
|
|
|
|
.Authorization and Authentication
|
|
[options="header"]
|
|
|=================================================================
|
|
| Feature | Fluentd | Vector
|
|
| Elasticsearch certificates | ✓ | ✓
|
|
| Elasticsearch username / password | ✓ | ✓
|
|
| Cloudwatch keys | ✓ | ✓
|
|
| Cloudwatch STS | ✓ |
|
|
| Kafka certificates | ✓ | ✓
|
|
| Kafka username / password | ✓ | ✓
|
|
| Kafka SASL | ✓ | ✓
|
|
| Loki bearer token | ✓ | ✓
|
|
|=================================================================
|
|
|
|
.Normalizations and Transformations
|
|
[options="header"]
|
|
|============================================================================
|
|
| Feature | Fluentd | Vector
|
|
| Viaq data model - app | ✓ | ✓
|
|
| Viaq data model - infra | ✓ | ✓
|
|
| Viaq data model - infra(journal) | ✓ | ✓
|
|
| Viaq data model - Linux audit | ✓ | ✓
|
|
| Viaq data model - kube-apiserver audit | ✓ | ✓
|
|
| Viaq data model - OpenShift API audit | ✓ | ✓
|
|
| Viaq data model - OVN | ✓ | ✓
|
|
| Loglevel Normalization | ✓ | ✓
|
|
| JSON parsing | ✓ | ✓
|
|
| Structured Index | ✓ | ✓
|
|
| Multiline error detection | ✓ |
|
|
| Multicontainer / split indices | ✓ | ✓
|
|
| Flatten labels | ✓ | ✓
|
|
| CLF static labels | ✓ | ✓
|
|
|============================================================================
|
|
|
|
.Tuning
|
|
[options="header"]
|
|
|==========================================================
|
|
| Feature | Fluentd | Vector
|
|
| Fluentd readlinelimit | ✓ |
|
|
| Fluentd buffer | ✓ |
|
|
| - chunklimitsize | ✓ |
|
|
| - totallimitsize | ✓ |
|
|
| - overflowaction | ✓ |
|
|
| - flushthreadcount | ✓ |
|
|
| - flushmode | ✓ |
|
|
| - flushinterval | ✓ |
|
|
| - retrywait | ✓ |
|
|
| - retrytype | ✓ |
|
|
| - retrymaxinterval | ✓ |
|
|
| - retrytimeout | ✓ |
|
|
|==========================================================
|
|
|
|
.Visibility
|
|
[options="header"]
|
|
|=====================================================
|
|
| Feature | Fluentd | Vector
|
|
| Metrics | ✓ | ✓
|
|
| Dashboard | ✓ | ✓
|
|
| Alerts | ✓ |
|
|
|=====================================================
|
|
|
|
.Miscellaneous
|
|
[options="header"]
|
|
|===========================================================
|
|
| Feature | Fluentd | Vector
|
|
| Global proxy support | ✓ | ✓
|
|
| x86 support | ✓ | ✓
|
|
| ARM support | ✓ | ✓
|
|
ifndef::openshift-rosa[]
|
|
| {ibmpowerProductName} support | ✓ | ✓
|
|
| {ibmzProductName} support | ✓ | ✓
|
|
endif::openshift-rosa[]
|
|
| IPv6 support | ✓ | ✓
|
|
| Log event buffering | ✓ |
|
|
| Disconnected Cluster | ✓ | ✓
|
|
|===========================================================
|