Function Compute:Configure the logging feature

Prerequisites

• Function Compute

  • A function is created.

• Optional: Simple Log Service (SLS)

  • A project and a Logstore are created.

Procedure

1. Log on to the Function Compute console. In the left-side navigation pane, click Functions.

2. In the top navigation bar, select a region. On the Functions page, click the function that you want to manage.

3. On the function details page, click the Configuration tab. Click Modify next to Advanced Settings. In the Advanced Settings panel, find the Logs option, configure the logging parameters, and then click Deploy.

   

   Note

   • When you create a function, the logging feature is enabled by default, and the system automatically selects a Log Service Project that starts with serverless-<region_id> and the default Logstore.

   • The console automatically enables Log Rotation Rules, Request-level Metrics, and Instance-level Metrics, and creates all the indexes required for log queries.

   Configuration Item	Required	Description
   Logging Feature	Yes	Specifies whether to enable Simple Log Service. Valid values: Enable: After you enable this feature, Function Compute imports logs to your project. You can query and retrieve logs in the Function Compute console and the Simple Log Service console to track and locate issues. Disable: If you disable the logging feature, function logs are not persisted. You cannot track and locate issues.
   Configuration Mode	Yes	Select Automatic Configuration or Custom Configuration. If you select Custom Configuration, Log Service Project and Logstore are required.
   Log Service Project	Yes	The destination project where function invocation logs are stored.
   Logstore	Yes	The destination Logstore where function invocation logs are stored.
   Log Rotation Rules	No	Specifies whether to enable a log segmentation rule. Valid values: Enable: If you enable this feature, Function Compute splits logs based on the segmentation rule and writes the log segments to Simple Log Service one by one. The default segmentation rule is ^.{0,2}\d{4}-\d{2}-\d{2}. This rule matches dates in the xxxx-xx-xx format, where x represents a digit. Logs are split based on whether a line starts with a date. For example, if a log line starts with 2023-10-10, it is considered the first line of a log segment. This line and the subsequent lines that do not start with a date are written to Simple Log Service as a single log entry. Disable: If you disable this feature, logs are split using \n by default.
   Request-level Metrics	No	Specifies whether to import logs of request-level metrics to the Logstore. Enabling this feature is strongly recommended. Valid values: Enable: After you enable this feature, metrics for each function invocation, such as the function execution time, memory usage, execution errors, cold starts, and the time taken for each cold start step, are delivered to the Logstore that you selected. Based on these metrics, Function Compute can display a list of requests in the invocation logs. You can also filter requests based on these metrics, such as filtering all error requests or requests that involve cold starts. Disable: You cannot view the details of request executions.
   Instance-level Metrics	No	Specifies whether to enable instance-level metrics. Valid values: Enable: After you enable this feature, instance-level metrics of the function are delivered to the Logstore that you selected. You can view performance metrics at the function instance level, such as the CPU, memory, and network I/O metrics of an instance. Function Compute provides instance-level observability based on instance-level metrics, offering an end-to-end monitoring and troubleshooting path for function instances. For more information, see Instance-level metrics. Disable: You cannot view the details of instance metrics.

Prerequisites

Install and configure Serverless Devs.

Procedure

1. Create a code directory with the following structure.

   .
   ├── code
   │   └── index.js
   └── s.yaml

   The following is a sample s.yaml file.

   In this example, the logConfig field configures the logging feature. Change the values of logstore and project to your actual Logstore and project. You can also set logConfig to auto to automatically create a project and a Logstore.

   edition: 3.0.0
   name: hello-world-app
   access: "default"
   vars: # Global variables
     region: "cn-hangzhou"
   
   resources:
     hello_world:
       component: fc3 # Component name
       props:
         region: ${vars.region}             
         functionName: "start-nodejs-****"
         description: 'hello world by serverless devs'
         runtime: "nodejs16"
         code: ./code
         handler: index.handler
         memorySize: 128
         timeout: 30
         logConfig: # Change the values of logstore and project to your actual Logstore and project. You can also set logConfig to auto to automatically create a project and a Logstore.
           enableInstanceMetrics: true  # Enable instance-level metrics
           enableRequestMetrics:  true  # Enable request-level metrics
           logBeginRule: DefaultRegex   # Log segmentation rule
           logstore: 'your-logstore'    # The name of the Logstore. The Logstore must be created in advance.
           project: 'your-project'      # The name of the project. The project must be created in advance.

2. Run the following command to deploy the application.

   sudo s deploy -y

   After the command runs successfully, log on to the Function Compute console to view the deployed function and verify that the logging feature is enabled.