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. Click Modify next to Advanced Settings. In the Advanced Settings panel, find the Logs section, configure the parameters, and then click Deploy.

   

   Note

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

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

   Parameter	Required	Description
   Logging	Yes	Enables or disables the logging feature. Valid values: Enable: When enabled, Function Compute sends logs to your project. You can then query and retrieve logs in the Function Compute console or the Simple Log Service console to track and troubleshoot issues. Disable: When disabled, Function Compute does not persist function logs, making it difficult to track and troubleshoot issues.
   Configuration Mode	Yes	Select Automatic Configuration or Custom Configuration. If you select Custom Configuration, the Log Service Project and Logstore parameters are required.
   Log Service Project	Yes	The Simple Log Service project where function invocation logs are stored.
   Logstore	Yes	The Logstore within the specified project where function invocation logs are stored.
   Log Rotation Rules	No	Enables or disables the log segmentation rule. Valid values: Enable: When enabled, Function Compute splits logs into segments based on the specified rule and writes each segment as a separate log entry to Simple Log Service. The default log 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. The rule splits logs based on whether a line starts with a date. For example, if a log line begins with 2023-10-10, it is treated as the first line of a new log entry. This line and all subsequent lines that do not start with a date are combined into a single log entry written to Simple Log Service. Disable: If disabled, Function Compute splits logs by the newline character \n by default.
   Request-level Metrics	No	Enables or disables request-level metrics. We strongly recommend that you enable this feature. Valid values: Enable: When enabled, metrics for each function invocation are sent to the selected Logstore. These metrics include execution duration, memory usage, execution errors, cold start occurrences, and the duration of each cold start phase. Function Compute uses these metrics to display a list of requests in the invocation logs. You can also use these metrics to filter requests, such as filtering for all failed requests or all requests that triggered a cold start. Disable: You cannot view detailed information about request executions.
   Instance-level Metrics	No	Enables or disables instance-level metrics. Valid values: Enable: When enabled, metric data from function instances is sent to the selected Logstore. You can view instance-level performance metrics, such as CPU, memory, and network I/O usage. Function Compute provides instance-level observability based on this data, providing an end-to-end path for monitoring and troubleshooting function instances. For more information, see Instance-level metrics. Disable: You cannot view detailed information about 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 an example of an s.yaml file.

   In this example, the logConfig field is used to configure the logging feature. You must modify the Logstore and project values to match an existing project and Logstore in your account. You can also set logConfig: auto, and Function Compute will automatically specify a Logstore and project for you.

   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: # Modify the logstore and project to match your actual resources. You can also use logConfig:auto to have the system automatically create a project and Logstore.
           enableInstanceMetrics: true  # Enable instance-level metrics.
           enableRequestMetrics:  true  # Enable request-level metrics.
           logBeginRule: DefaultRegex   # The log segmentation rule.
           logstore: 'your-logstore'    # Specify the Logstore name (must be created in advance).
           project: 'your-project'      # Specify the project name (must be created in advance).

2. Run the following command to deploy the application.

   s deploy -y

   After the deployment succeeds, log on to the Function Compute console to verify that the function is deployed with the logging feature enabled.