Enable control plane log collection and log-based alerting (legacy)

Prerequisites

• You have an ASM instance with a version earlier than 1.17.2.35. For more information, see Create an ASM instance.

  Note

  If your instance version is 1.17.2.35 or later, see Enable control plane log collection and log-based alerting (new).

• You have activated Simple Log Service (SLS) for your Alibaba Cloud account. For more information, see Activate Simple Log Service.

  Important

  Collecting logs to the ASM log service does not incur extra fees. However, SLS charges for data writes and the features that you use. For more information about SLS billing, see Billing overview.

Enable control plane log collection

1. Log on to the ASM console. In the left-side navigation pane, choose Service Mesh > Mesh Management.

2. On the Mesh Management page, click the name of the ASM instance. In the left-side navigation pane, choose ASM Instance > Base Information.

3. On the Basic Information page, in the Configuration Information section, click Enable to the right of Control Plane Log Collection.

   Important

   The control plane Logstore saves log data for the last 30 days. Logs older than 30 days are discarded.

   • If you enable control plane log collection for the first time, the Enable Control Plane Logs dialog box appears. You can select Create New Project or Use Existing Project and then click Confirm.

     If you select Create Project, you can use the default project name or specify a custom project name.

     

   • If you previously enabled and disabled control plane log collection, an Important Note dialog box appears when you enable the feature again. Click OK, and the previously specified project is automatically selected.

   After you enable control plane log collection, on the Basic Information page, click View Log to the right of Control Plane Log Collection to view the detailed control plane logs on the project page.

Enable control plane log-based alerting

1. Log on to the ASM console. In the left-side navigation pane, choose Service Mesh > Mesh Management.

2. On the Mesh Management page, click the name of the ASM instance. In the left-side navigation pane, choose ASM Instance > Base Information.

3. On the Basic Information page, in the Configuration Information section, click Alerting Settings to the right of Control Plane Log Collection.

4. In the target action policy area of the Control Plane Log-based Alerting Settings dialog box, select Service Mesh ASM Built-in Action Policy (Recommended) or Custom Action Policy, and click Enable Alerting.

   An action policy defines the behavior when an alert is triggered. You can create and edit action policies in your SLS project. For more information, see Action policies.

5. In the Important dialog box, click OK.

Configure alert notification recipients

You can configure the built-in action policy for the SLS service gateway to set alert notification recipients, notification templates, and other settings.

1. Log on to the Simple Log Service console.

2. In the Project List area, click the target project name, and then in the navigation pane on the left, click Alerting.

3. On the Alert Center page, click Notification Recipient > User Group Management.

4. On the User Group Management tab, click Modify in the Actions column of the SLS Service Mesh Built-in User Group.

5. In the Modify User Group dialog box, select the target member in the Available Members area, click the icon to add the member to the Added Members area, and then click Confirm.

Example of triggering an alert notification

1. Log on to the ASM console. In the left-side navigation pane, choose Service Mesh > Mesh Management.

2. On the Mesh Management page, click the name of the ASM instance. In the left-side navigation pane, choose ASM Gateways > Gateway. On the page that appears, click Create from YAML.

3. On the Create page, select the target namespace and any scenario template, and configure the YAML.

   This topic uses the default namespace as an example to configure a service gateway. The following code provides a YAML example:

   apiVersion: networking.istio.io/v1beta1
   kind: Gateway
   metadata:
     name:  gateway-test
     namespace: default
   spec:
     selector:
       istio: ingressgateway
     servers:
       - hosts:
           - '*console.aliyun.com'
         port:
           name: https
           number: 443
           protocol: HTTPS
         tls:
           credentialName: not-existing-credential
           mode: SIMPLE

4. View the alert notification.

   1. In the navigation pane on the left of the instance details page, choose ASM Instance > Basic Information.

   2. On the Basic Information page, in the Configuration Information section, click View Log to the right of Control Plane Log Collection.

   3. In the Simple Log Service console, search for 'ACK ERROR' to view the alert information.

      The following figure shows a sample output:

      If you have configured an email address for the notification recipient, you can view the alert notification in your mailbox.

Reference solutions for handling alerts

Diagnosed mesh configurations with warnings

ASM mesh diagnosis has found potentially risky mesh configurations in your cluster. These configurations might cause ASM to produce unexpected results. You can view the alert content on the mesh diagnosis page and follow the prompts to correct the configuration.

Diagnosed mesh configurations with errors

ASM mesh diagnosis has found incorrect mesh configurations in your cluster. These configurations have a high risk of causing unexpected behavior. You should view the alert content on the mesh diagnosis page as soon as possible and follow the prompts to correct the configuration.

Failed to push configurations from the control plane because mesh rule configurations do not meet specifications

Related operations

Modify the control plane log Project

1. Log on to the ASM console. In the left-side navigation pane, choose Service Mesh > Mesh Management.

2. On the Mesh Management page, click the name of the ASM instance. In the left-side navigation pane, choose ASM Instance > Base Information.

3. On the Basic Information page, in the Configuration Information area, click Change Log Project to the right of Control Plane Log Collection. In the Change Log Project dialog box, make the required changes, and then click Confirm.