This section describes how to add a log receiver.

KubeSphere supports using Elasticsearch, OpenSearch, and Kafka as log receivers.

  • Only one log receiver of each type can be added.

  • KubeSphere uses OpenSearch as the default log receiver.

  • KubeSphere does not install Kafka by default and currently does not provide log analysis tools for Kafka. KubeSphere only provides the functionality to integrate with Kafka. If you need to use Kafka as a log receiver, you need to install Kafka by referring to the Kafka official documentation.

Prerequisites

  • You need to join a cluster and have the cluster-admin permission in the cluster. For more information, see Cluster Members and Cluster Roles.

  • The KubeSphere platform needs to have the WizTelemetry Logging, WizTelemetry Events, WizTelemetry Auditing, or WizTelemetry Notification extension installed and enabled.

Steps

  1. Log in to the KubeSphere web console with a user who has cluster-admin permissions and enter your cluster.

  2. Click Logging > Log Receivers in the left navigation pane.

  3. On the Log Receivers page, click Container Logs, Resource Events, Audit Logs, or Notification History to open the log receiver list.

  4. Click Add Log Receiver on the right side of the page.

  5. In the Add Log Receiver dialog box, select Elasticsearch, OpenSearch, or Kafka.

  6. Configure the parameters for the log receiver, then click OK.

    Parameter Description

    Service Address

    The service address and port of the log receiver. KubeSphere will send logs to this address and port. The default OpenSearch service address and port used by KubeSphere are opensearch-cluster-data.kubesphere-logging-system.svc:9200.

    Index Prefix

    The index prefix for log data, used to distinguish between different types of logs. Only available for Elasticsearch and OpenSearch.

    Topic

    The topic for log data, used to distinguish between different types of logs. Only available for Kafka.