Function Compute:Configure the logging feature

Prerequisites

• Function Compute

  • Create a function

• Optional: Simple Log Service

  • Create a project and a Logstore

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 and then click Edit to the right of Advanced Configuration. In the Advanced Configuration panel, find the Log section, configure the log settings, and then click Deploy.

   

   Note

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

   • The console automatically enables Log Segmentation Rules, Request-level Metrics, and Instance-level Metrics, and creates all indexes required to query logs.

   Parameter	Required	Description
   Logging	Yes	Enable or disable the logging feature. Valid values: Enable: If you enable the logging feature, Function Compute imports logs to your project. You can then query and retrieve logs in the Function Compute console or the Simple Log Service console to troubleshoot issues. Disable: If you do not enable the logging feature, function logs are not persisted. This makes it difficult to track and identify issues.
   Configuration Mode	Yes	Select Automatic Configuration or Custom Configuration. If you select Custom Configuration, you must specify the Log Service Project and Logstore.
   Log Project	Yes	The destination project that stores function invocation logs.
   Logstore	Yes	The destination Logstore that stores function invocation logs.
   Log Segmentation Rules	No	Enable or disable log segmentation rules. Valid values: Enable: If you enable log segmentation, Function Compute splits logs into multiple segments based on the segmentation rule and writes them to Simple Log Service one by one. The default log segmentation rule is ^.{0,2}\d{4}-\d{2}-\d{2}. This rule matches dates that use the xxxx-xx-xx format, where x represents a digit. The rule splits logs based on whether the first line contains a date. For example, if the first line of your log is 2023-10-10, this line 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 log segmentation, logs are split using \n by default.
   Request-level Metrics	No	Enable or disable the import of request metric logs to the Logstore. Enabling this feature is highly recommended. Valid values: Enable: If you enable this feature, metrics for each function invocation are delivered to the Logstore that you selected. These metrics include the running time, memory usage, execution errors, cold start status, and the duration of each cold start step. Function Compute can display a list of requests based on these metrics in the invocation logs. You can also filter requests based on the metrics, such as filtering all error requests or requests that involve cold starts. Disable: You cannot view the detailed execution information of requests.
   Instance-level Metrics	No	Enable or disable the instance-level metrics feature. Valid values: Enable: If you enable this feature, metric data of function instances is delivered to the Logstore that you selected. You can view performance metrics at the function instance dimension, such as the CPU, memory, and network I/O metrics of an instance. Function Compute provides instance-level observability based on instance-level metric data. This gives you 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. The following sample code shows the directory structure.

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

   The following sample code shows an s.yaml file.

   In this example, the logConfig field is used to configure the logging feature. You must change the values of logstore and project to your existing Logstore and project. You can also set logConfig to auto. In this case, the Function Compute platform automatically specifies the logstore and project.

   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'    # Specify the Logstore name. The Logstore must be created in advance.
           project: 'your-project'      # Specify the project name. 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, you can log on to the Function Compute console to verify that the function is deployed and the logging feature is enabled.