< img height="1" width="1" style="display:none;" alt="" src="https://px.ads.linkedin.com/collect/?pid=3131724&fmt=gif" />

Add Log Receivers

This section introduces how to add log receivers.

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

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

  • KubeSphere defaults to using OpenSearch and provides log analysis tools, which you can use in the toolbox of the KubeSphere web console to query logs collected by OpenSearch.

  • KubeSphere does not install Kafka by default and currently does not provide log analysis tools for Kafka. KubeSphere only provides the function of connecting with Kafka. If you need to use Kafka as a log receiver, you need to refer to the Kafka Documentation to install Kafka.

Prerequisites

  • You should join a cluster and have the Cluster Settings Management permission within the cluster. For more information, refer to "Cluster Members" and "Cluster Roles".

  • WhizardTelemetry Logging, WhizardTelemetry Events, WhizardTelemetry Auditing, or WhizardTelemetry Notification should have been installed and enabled.

Steps

  1. Log in to the KubeSphere web console with a user who has the Cluster Settings Management permission, and access your cluster.

  2. Click Cluster Settings > 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, select Elasticsearch, OpenSearch, or Kafka.

  6. Set the parameters of the log receiver, then click OK.

    ParameterDescription

    Address

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

    Index Prefix

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

    Topic

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

Receive the latest news, articles and updates from KubeSphere


Thanks for the feedback. If you have a specific question about how to use KubeSphere, ask it on Slack. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement.

What’s on this Page