KubeSphere Logging System

    For more information, see Log Query.

    When you install KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components.

    1. In the tutorial of , you create a default file . Modify the file by executing the following command:

      Note

      • If you adopt All-in-One Installation, you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable Logging in this mode (for example, for testing purposes), refer to to see how Logging can be installed after installation.

      • If you adopt Multi-node Installation and are using symbolic links for docker root directory, make sure all nodes follow the exactly same symbolic links. Logging agents are deployed in DaemonSets onto nodes. Any discrepancy in container log path may cause collection failures on that node.

    2. In this file, navigate to logging and change false to true for enabled. Save the file after you finish.

      1. logging:
      2.   enabled: true # Change "false" to "true".
      3.   containerruntime: docker

      Info

      To use containerd as the container runtime, change the value of the field containerruntime to containerd. If you upgraded to KubeSphere 3.2.0 from earlier versions, you have to manually add the field containerruntime under logging when enabling KubeSphere Logging system.

      Note

      By default, KubeKey will install Elasticsearch internally if Logging is enabled. For a production environment, it is highly recommended that you set the following values in config-sample.yaml if you want to enable Logging, especially externalElasticsearchUrl and externalElasticsearchPort. Once you provide the following information before installation, KubeKey will integrate your external Elasticsearch directly instead of installing an internal one.

      1. es:  # Storage backend for logging, tracing, events and auditing.
      2.   elasticsearchMasterReplicas: 1   # The total number of master nodes. Even numbers are not allowed.
      3.   elasticsearchDataReplicas: 1     # The total number of data nodes.
      4.   elasticsearchMasterVolumeSize: 4Gi   # The volume size of Elasticsearch master nodes.
      5.   elasticsearchDataVolumeSize: 20Gi    # The volume size of Elasticsearch data nodes.
      6.   logMaxAge: 7                     # Log retention day in built-in Elasticsearch. It is 7 days by default.
      7.   externalElasticsearchUrl: # The URL of external Elasticsearch.
      8.   externalElasticsearchPort: # The port of external Elasticsearch.

    Installing on Kubernetes

    As you install KubeSphere on Kubernetes, you can enable KubeSphere Logging first in the file.

    1. Download the file cluster-configuration.yaml and edit it.

    2. In this local cluster-configuration.yaml file, navigate to logging and enable Logging by changing false to true for enabled. Save the file after you finish.

      1. logging:
      2.   enabled: true # Change "false" to "true".
      3.   containerruntime: docker

      Info

      To use containerd as the container runtime, change the value of the field .logging.containerruntime to containerd. If you upgraded to KubeSphere 3.2.0 from earlier versions, you have to manually add the field containerruntime under logging when enabling KubeSphere Logging system.

      Note

      By default, ks-installer will install Elasticsearch internally if Logging is enabled. For a production environment, it is highly recommended that you set the following values in cluster-configuration.yaml if you want to enable Logging, especially externalElasticsearchUrl and externalElasticsearchPort. Once you provide the following information before installation, ks-installer will integrate your external Elasticsearch directly instead of installing an internal one.

      1. es:  # Storage backend for logging, tracing, events and auditing.
      2.   elasticsearchMasterReplicas: 1   # The total number of master nodes. Even numbers are not allowed.
      3.   elasticsearchDataReplicas: 1     # The total number of data nodes.
      4.   elasticsearchMasterVolumeSize: 4Gi   # The volume size of Elasticsearch master nodes.
      5.   elasticsearchDataVolumeSize: 20Gi    # The volume size of Elasticsearch data nodes.
      6.   logMaxAge: 7                     # Log retention day in built-in Elasticsearch. It is 7 days by default.
      7.   elkPrefix: logstash              # The string making up index names. The index name will be formatted as ks-<elk_prefix>-log.
      8.   externalElasticsearchUrl: # The URL of external Elasticsearch.
      9.   externalElasticsearchPort: # The port of external Elasticsearch.

    1. Log in to the console as admin. Click Platform in the upper-left corner and select Cluster Management.

    2. Click CRDs and enter clusterconfiguration in the search bar. Click the result to view its detail page.

      Info

    3. In Custom Resources, click on the right of ks-installer and select Edit YAML.

    4. In this YAML file, navigate to logging and change false to true for enabled. After you finish, click OK in the lower-right corner to save the configuration.

      Info

      To use containerd as the container runtime, change the value of the field .logging.containerruntime to containerd. If you upgraded to KubeSphere 3.2.0 from earlier versions, you have to manually add the field containerruntime under logging when enabling KubeSphere Logging system.

      Note

      By default, Elasticsearch will be installed internally if Logging is enabled. For a production environment, it is highly recommended that you set the following values in this yaml file if you want to enable Logging, especially externalElasticsearchUrl and externalElasticsearchPort. Once you provide the following information, KubeSphere will integrate your external Elasticsearch directly instead of installing an internal one.

      1. es:  # Storage backend for logging, tracing, events and auditing.
      2.   elasticsearchMasterReplicas: 1   # The total number of master nodes. Even numbers are not allowed.
      3.   elasticsearchDataReplicas: 1     # The total number of data nodes.
      4.   elasticsearchMasterVolumeSize: 4Gi   # The volume size of Elasticsearch master nodes.
      5.   elasticsearchDataVolumeSize: 20Gi    # The volume size of Elasticsearch data nodes.
      6.   logMaxAge: 7                     # Log retention day in built-in Elasticsearch. It is 7 days by default.
      7.   elkPrefix: logstash              # The string making up index names. The index name will be formatted as ks-<elk_prefix>-log.
      8.   externalElasticsearchUrl: # The URL of external Elasticsearch.
      9.   externalElasticsearchPort: # The port of external Elasticsearch.

    5. You can use the web kubectl to check the installation process by executing the following command:

      Note

      You can find the web kubectl tool by clicking KubeSphere Logging System - 图2 in the lower-right corner of the console.

    Go to System Components and check that all components on the Logging tab page is in Healthy state.

    Execute the following command to check the status of Pods: