Serverless App Engine:Install an agent for a Python application

Docker image

1. Build the Python image.

   This section provides the commands to download, install, and start the application with the ARMS Python agent.

   ...
   # Download the agent installer from PyPI.
   RUN pip3 install aliyun-bootstrap
   # Install the Python agent by using aliyun-bootstrap.
   RUN aliyun-bootstrap -a install
   ...
   # Start the application by using the ARMS Python agent.
   CMD ["aliyun-instrument","python","main.py"]

   Note

   If you do not want to use the Python agent to start the application, you must import the agent in your application's main entry file, such as main.py, and then start the application.

   from aliyun.opentelemetry.instrumentation.auto_instrumentation import  sitecustomize

2. Push the built Python image to Alibaba Cloud Container Registry (ACR). For more information, see Push and pull images (Enterprise Edition) or Push and pull images (Personal Edition).

ZIP package

Package your Python project into a ZIP file in your local environment. For more information, see Instructions for packaging a Python project into a ZIP file.

From image

Step 3.1: Create the application

This section covers only the key steps. For detailed instructions, see Deploy an application using an image.

1. On the Specify Image panel, set Technology Stack Programming Language to Python and select your desired image version.

   Select the My Alibaba Cloud Images tab and Personal Edition of Container Registry. From the Select Image Version drop-down list, select python2.

2. On the Advanced Settings page, in the Application Monitoring section, enable Application Monitoring.

   To use Application Monitoring with a custom image, you must first modify the image to install the Python agent during the build process. ARMS provides a free quota of 200 GB per month for SAE users.

3. Click Create Application.

Step 3.2: Verify access

From code package

Step 3.1: Create the application

This section covers only the key steps. For detailed instructions, see Deploy a Python application.

1. On the Configure Code Package-based Deployment panel, set Technology Stack Programming Language to Python. In the Upload ZIP Package section, click the icon to upload your ZIP file.

   From the Python Environment drop-down list, select Python 3.9.15.

2. On the Advanced Settings page, configure the following settings.

   1. In the Startup Command section, enter the following command.

      aliyun-instrument python main.py
      # Start the application by using the ARMS Python agent. main.py is the main entry file in this example.

      Select /bin/sh as the command type.

   2. In the Application Monitoring section, enable Application Monitoring.

3. Click Create Application.

Step 3.2: Verify access

SAE console

Go to the Basic Information page of your application. In the left-side navigation pane, click Application Monitoring. On the Application Monitoring page, you can view the Monitoring Data.

The Application Overview tab displays four core metric cards: Requests, Errors, Avg. Response Time, and Instances, complete with day-over-day and week-over-week comparisons. The tab also features a time-series trend chart and lists the top five rankings for requests, errors, average response time, and peak CPU utilization.

ARMS console

1. Log on to the ARMS console.

2. In the left-side navigation pane, choose Application Monitoring > Application List. In the top navigation bar, select the target region.

   On the Applications page, you can see the connected applications and their key monitoring metrics, such as requests per second, error rate, and average response time. This confirms your application is connected to Application Monitoring.

3. On the Application List page, search for your application and click its name.

4. View the application's monitoring data on the details page.