Simple Log Service:Use AliyunLogConfig to manage a Logtail configuration

Create a Logtail configuration

Create a CR from AliyunLogConfig. After you create the CR, alibaba-log-controller creates a Logtail configuration based on the CR and applies the configuration automatically.

1. Obtain the kubeconfig file of a cluster and use kubectl to connect to the cluster.

2. Run the following command to create a YAML file. In this example, the file name is cube.yaml. Replace the file name as needed.

   vim cube.yaml

3. Enter the following script in the YAML file and configure the parameters as needed. The script contains the required fields only. Set inputType to specify how logs are collected, and set inputDetail to configure the settings of the log input. For more information about the fields of the CR, seeCR parameters.

   apiVersion: log.alibabacloud.com/v1alpha1      # Use the default value. You do not need to modify this parameter.
   kind: AliyunLogConfig                          # Use the default value. You do not need to modify this parameter.
   metadata:
     name: test-config                            # The name of the resource. The name must be unique in the current Kubernetes cluster.
   spec:
     logstore: k8s-stdout                         # The name of the Logstore. If the Logstore that you specify does not exist, Simple Log Service automatically creates the Logstore.
     logtailConfig:                               # The Logtail configuration.
       inputType: plugin                          # The type of the data source from which logs are collected.
       configName: test-config                    # The name of the Logtail configuration.
       inputDetail:                               # The details of the Logtail configuration.
         ...

4. Run the following command to create the CR from AliyunLogConfig. After the Logtail configuration takes effect, Logtail starts to collect data and sends the data to Simple Log Service.

   kubectl apply -f cube.yaml

5. Verify that the value of the statusCode field of the CR is 200. For instructions, see View Logtail configurations.

View Logtail configurations

To view all Logtail configurations that are created by AliyunLogConfig in the current Kubernetes cluster, run the following command:

kubectl get aliyunlogconfigs

To view the details and status of a single Logtail configuration that is created by AliyunLogConfig, run the following command. <config_name> is the name of the AliyunLogConfig. Replace the name as needed.

kubectl get aliyunlogconfigs <config_name> -o yaml

A result similar to the following one is returned. In this example, the Logtail configuration uses inputType: file.

apiVersion: log.alibabacloud.com/v1alpha1
kind: AliyunLogConfig
metadata:
  name: example-k8s-file
  namespace: kube-system
spec:
  project: k8s-log-test
  logstore: k8s-file
  logtailConfig:
    inputType: file
    configName: example-k8s-file
    inputDetail:
      logType: common_reg_log
      logPath: /data/logs/app_1
      filePattern: test.LOG
      dockerFile: true
status:
  status: OK
  statusCode: 200

The status field and the statusCode field in the result indicate the status of the Logtail configuration:

• If the value of the statusCode field is 200, the Logtail configuration is applied.

• If the value of the statusCode field is not 200, the Logtail configuration fails to be applied. Check the status field for the reported status.

Update a Logtail configuration

To update a Logtail configuration that is created by AliyunLogConfig, modify the existing YAML file of the CR and apply the file again.

1. Obtain the kubeconfig file of a cluster and use kubectl to connect to the cluster.

2. Edit the existing AliyunLogConfig YAML file, such as cube.yaml.

   vim cube.yaml

3. Modify the parameters in the YAML file as needed. For more information about the fields of the CR, seeCR parameters.

4. Run the following command to apply the file and make the Logtail configuration take effect.

   kubectl apply -f cube.yaml

5. Verify that the value of the statusCode field of the CR is 200. For instructions, see View Logtail configurations.

Delete a Logtail configuration

To delete a Logtail configuration that is created by AliyunLogConfig, delete the corresponding CR. In the following command, <config_name> is the name of the AliyunLogConfig. Replace the name as needed.

kubectl delete aliyunlogconfigs <config_name>

To confirm the deletion, run kubectl get aliyunlogconfigs and check that the CR is no longer listed.

apiVersion

The value is fixed to log.alibabacloud.com/v1alpha1.

kind

The value is fixed to AliyunLogConfig.

metadata

The metadata field identifies the CR in the Kubernetes cluster.

spec

The spec field specifies the destination project and LogStore, the attributes of the destination LogStore, and the details of the Logtail configuration.

AliyunLogConfigDetail

For more information about the parameters, seeLogtail configurations (legacy). The data format of AliyunLogConfigDetail is the same as the format that is described inLogtail configurations (legacy).