tencent cloud

Feedback

Function Overview

Last updated: 2023-02-01 17:41:43

    A function is the basic unit of management and operation in SCF, which usually consists of a series of configuration items and executable code/packages. You can trigger a function through APIs. You can also pass different events to a function through different triggers to trigger it for event processing.

    Relevant Concepts of Function

    Regions

    A function resource must belong to a certain region. For regions supported by SCF, see Billing Overview.

    Namespace

    A function resource must be created under a certain namespace in a certain region. Each region has a default namespace. You can also create namespaces, whose names cannot be modified after creation.

    Function name

    It is the unique identifier of a function, must be unique under the same namespace, and cannot be modified after creation.

    Function type

    SCF supports two function types: event-triggered function and HTTP-triggered function.

    • Event-triggered functions are triggered by events in a specified format, such as scheduled triggering events and COS triggering events. For more information on the event structure, see Trigger Overview.
    • HTTP-triggered functions focus on optimizing web services and can directly accept and process HTTP requests. For more information, see Function Overview.

    Time zone

    SCF uses the UTC time by default, which you can modify by configuring the TZ environment variable. After you select a time zone, the TZ environment variable corresponding to the time zone will be added automatically.

    Runtime environment

    Execution environment of the function code. Currently, SCF supports Python, Node.js, PHP, Java, Go, Custom Runtime, and image deployment.

    Function execution method

    The execution method specifies the starting file and function while invoking the function. There are three ways as follows:

    • For Go programming, use the "[FileName]" format, such as main.
    • For Python, Node.js, or PHP programming, use the "[FileName].[FunctionName]" format, such as index.main_handler.
      Note

      Note that FileName does not include the file name extension, and FunctionName is the name of the entry function. Make sure that the file name extension matches the programming language. For example, for Python programming, the file name extension is .py, and for Node.js programming, the file name extension is .js.

    • For Java programming, use the "[package].[class]::[method]" format, such as example.Hello::mainHandler.

    Function description

    It is used to record information such as the purpose of the function, which is optional.

    Relevant Configurations of Function

    In addition to the above configuration items, you can also modify the following configuration items for function execution by editing the function configuration in the console or updating function configuration:

    Resource type

    The computing power supported by SCF includes CPU and GPU.

    Resource specification

    It sets the specifications of resources, such as different memory sizes for CPU and different card types for GPU.

    Initialization timeout period

    Maximum initialization duration of the function between 3 and 300 seconds (90 seconds for image deployment-based functions and 60 seconds for other functions by default).

    Note
    • The function initialization phase includes the preparations of function code, image, layer, and other relevant resources and execution of the main process code of the function. If your function has a larger image or complex business logic, increase the initialization timeout period appropriately.
    • The initialization timeout period only takes effect in the scenario where the triggered instance is cold started for invocation.
    • The client waiting time is better to be slightly larger than the sum of the initialization timeout period and the execution timeout period.

    Execution timeout period

    Maximum execution duration of the function between 1 and 900 seconds (3 seconds by default).

    Environment variable

    It can be defined in the configuration and obtained from the environment when the function is executed. For more information, see Environment Variables.

    Execution role

    It grants the corresponding permissions of the policy contained in it to the function. For more information, see Role and Authorization. For example, to execute the action of writing an object into COS in the function code, you should configure an execution role with the permission to write COS.

    Log configuration

    It delivers function invocation logs to the specified log topic. For more information, see Log Search Guide.

    Network configuration

    It configures the function network access permissions. For more information, see Network Configuration Management.

    • Public network: It is enabled by default. The function cannot access public network resources after it is disabled.
    • Fixed outbound IP: After it is enabled, the platform will assign a fixed public network outbound IP to the function.
    • VPC: After it is enabled, the function can access resources in the same VPC.

    File system

    After it is enabled, the function can access resources of the mounted file system. For more information, see Mounting CFS File System.

    Execution configuration

    The execution configuration includes async execution, status tracking, and async execution event management. For more information, see Execution Configuration.

    • Async execution: After it is enabled, the function execution timeout period can be up to 24 hours. It cannot be modified after function creation.
    • Linkage trace: It can be enabled only for async execution. When it's enabled, it will keep the logs of real-time status of response for async function events. You can query and stop the event and check the related statistics. Data of event status will be retained for three days.

    Async invocation configuration

    Async invocation configuration: You can use this configuration item to set the retry policy for async invocation. You can also configure the dead letter queue to collect error event information and analyze the failure cause.

    Application performance monitoring

    After it is enabled, SCF will report the basic execution duration of the function to the specified APM system. You can also instrument the function code for custom reporting. This helps you better track and monitor the execution of the function.

    DNS configuration

    In SCF use cases, DNS delays may cause function execution timeouts, affecting the normal business logic. In case of frequent function invocations, the resolution of the DNS server may exceed the frequency limit, which also leads to function execution failures. SCF provides the DNS cache configuration to solve these problems, which can improve the DNS efficiency and mitigate the impact of various factors such as network jitter on the DNS success rate. For more information, see DNS Caching Configuration.

    Executable Operations for a Function

    • Creating function: Creates a function.
    • Updating function:
      • Updating function configuration: Updates the configuration items of the function.
      • Updating function code: Updates the execution code of the function.
    • Getting details: Gets function configuration, trigger, and code details.
    • Testing function: Triggers the function in a sync or async manner as needed.
    • Getting log: Gets the log of function execution and output.
    • Deleting function: Deletes a function that is no longer needed.
    • Copying function: Copies a function to the specified region, name, and configuration.

    Function trigger-related operations include:

    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support