Application Real-Time Monitoring Service：Instal agen Python untuk Container Service for Kubernetes (ACK) dan Container Compute Service (ACS) menggunakan komponen ack-onepilot

Catatan

• Jika aplikasi Anda dimulai dengan uvicorn, pilih salah satu metode konfigurasi berikut.

  • Metode 1: Tambahkan pernyataan berikut ke baris pertama file entri uvicorn untuk mengimpor agen Python.

    from aliyun.opentelemetry.instrumentation.auto_instrumentation import sitecustomize

  • Metode 2: Ganti uvicorn dengan gunicorn dan tambahkan awalan aliyun-instrument ke perintah gunicorn.

    Contoh:

    uvicorn app:app --workers 4 --port=9090 --host 0.0.0.0

    Ubah perintah menjadi:

    aliyun-instrument gunicorn -w 4 -k uvicorn.workers.UvicornWorker -b 0.0.0.0:8000 app:app

    Catatan

    Instruksi aliyun-instrument menangani inisialisasi dan instrumentasi non-intrusif dari agen Python ARMS.

• Jika aplikasi Anda dimulai dengan uWSGI, lihat Instal agen Python untuk proyek Django atau Flask yang dimulai dengan uWSGI.

• Jika Anda menggunakan korutin gevent, Anda harus menyetel variabel lingkungan GEVENT_ENABLE=true.

  Sebagai contoh, jika program Anda berisi kode berikut:

  from gevent import monkey
  monkey.patch_all()

  Anda harus menyetel variabel lingkungan sebagai berikut:

  GEVENT_ENABLE=true

Langkah 1: Instal penginstal agen ARMS (ack-onepilot)

1. Masuk ke Konsol ACK. Pada halaman Clusters, klik nama kluster.

2. Pada panel navigasi sebelah kiri, klik Add-ons. Di pojok kanan atas, cari ack-onepilot.

   Penting

   Pastikan versi ack-onepilot adalah 3.2.4 atau lebih baru.

3. Klik Install pada kartu ack-onepilot.

   Catatan

   Secara default, komponen ack-onepilot mendukung 1.000 Pod. Untuk setiap tambahan 1.000 Pod di kluster, Anda harus menambahkan 0,5 core CPU dan memori 512 MB untuk komponen tersebut.

4. Pada kotak dialog yang muncul, konfigurasikan parameter dan klik OK. Kami menyarankan Anda menggunakan nilai default.

   Catatan

   Setelah menginstal ack-onepilot, Anda dapat melakukan peningkatan, konfigurasi, atau uninstal di halaman Add-ons.

5. Penting

   Jika versi komponen ack-onepilot yang Anda instal lebih baru dari 5.0.0, Anda dapat melewati Langkah 2 dan langsung ke Langkah 3. Ini memberikan pengalaman instalasi sepenuhnya non-intrusif untuk aplikasi Python.

Langkah 2: Modifikasi Dockerfile

1. Unduh penginstal agen dari repositori Python Package Index (PyPI).

   pip3 install aliyun-bootstrap

2. Gunakan aliyun-bootstrap untuk menginstal agen.

   # ID wilayah Akun Alibaba Cloud.
   ARMS_REGION_ID=xxx aliyun-bootstrap -a install

   Catatan

   Untuk menginstal versi tertentu dari agen Python, jalankan perintah berikut:

   # Ganti ${version} dengan nomor versi aktual.
   aliyun-bootstrap -a install -v ${version}

   Untuk informasi selengkapnya tentang semua versi rilis agen Python, lihat Catatan rilis agen Python.

3. Jalankan aplikasi menggunakan agen Python ARMS.

   aliyun-instrument python app.py

4. Buat citra.

Kode berikut menyediakan contoh lengkap Dockerfile:

Langkah 3: Berikan izin akses ke resource ARMS

Langkah 4: Aktifkan Pemantauan Aplikasi ARMS untuk aplikasi Python

Templat berikut merupakan contoh YAML lengkap untuk membuat deployment dan mengaktifkan Pemantauan Aplikasi ARMS:

apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    app: arms-python-client
  name: arms-python-client
  namespace: arms-demo
spec:
  progressDeadlineSeconds: 600
  replicas: 1
  revisionHistoryLimit: 10
  selector:
    matchLabels:
      app: arms-python-client
  strategy:
    rollingUpdate:
      maxSurge: 25%
      maxUnavailable: 25%
    type: RollingUpdate
  template:
    metadata:
      labels:
        app: arms-python-client
        aliyun.com/app-language: python # Wajib untuk aplikasi Python. Menentukan bahwa ini adalah aplikasi Python.
        armsPilotAutoEnable: 'on'
        armsPilotCreateAppName: "arms-python-client"    # Nama tampilan aplikasi di ARMS.
    spec:
      containers:
        - image: registry.cn-hangzhou.aliyuncs.com/arms-default/python-agent:arms-python-client
          imagePullPolicy: Always
          name: client
          resources:
            requests:
              cpu: 250m
              memory: 300Mi
          terminationMessagePath: /dev/termination-log
          terminationMessagePolicy: File
      dnsPolicy: ClusterFirst
      restartPolicy: Always
      schedulerName: default-scheduler
      securityContext: {}
      terminationGracePeriodSeconds: 30

---

apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    app: arms-python-server
  name: arms-python-server
  namespace: arms-demo
spec:
  progressDeadlineSeconds: 600
  replicas: 1
  revisionHistoryLimit: 10
  selector:
    matchLabels:
      app: arms-python-server
  strategy:
    rollingUpdate:
      maxSurge: 25%
      maxUnavailable: 25%
    type: RollingUpdate
  template:
    metadata:
      labels:
        app: arms-python-server
        aliyun.com/app-language: python # Wajib untuk aplikasi Python. Menentukan bahwa ini adalah aplikasi Python.
        armsPilotAutoEnable: 'on'
        armsPilotCreateAppName: "arms-python-server"    # Nama tampilan aplikasi di ARMS.
    spec:
      containers:
        - env:
          - name: CLIENT_URL
            value: 'http://arms-python-client-svc:8000'
        - image: registry.cn-hangzhou.aliyuncs.com/arms-default/python-agent:arms-python-server
          imagePullPolicy: Always
          name: server
          resources:
            requests:
              cpu: 250m
              memory: 300Mi
          terminationMessagePath: /dev/termination-log
          terminationMessagePolicy: File
      dnsPolicy: ClusterFirst
      restartPolicy: Always
      schedulerName: default-scheduler
      securityContext: {}
      terminationGracePeriodSeconds: 30

---

apiVersion: v1
kind: Service
metadata:
  labels:
    app: arms-python-server
  name: arms-python-server-svc
  namespace: arms-demo
spec:
  internalTrafficPolicy: Cluster
  ipFamilies:
    - IPv4
  ipFamilyPolicy: SingleStack
  ports:
    - name: http
      port: 8000
      protocol: TCP
      targetPort: 8000
  selector:
    app: arms-python-server
  sessionAffinity: None
  type: ClusterIP

apiVersion: v1
kind: Service
metadata:
  name: arms-python-client-svc
  namespace: arms-demo
  uid: 91f94804-594e-495b-9f57-9def1fdc7c1d
spec:
  internalTrafficPolicy: Cluster
  ipFamilies:
    - IPv4
  ipFamilyPolicy: SingleStack
  ports:
    - name: http
      port: 8000
      protocol: TCP
      targetPort: 8000
  selector:
    app: arms-python-client
  sessionAffinity: None
  type: ClusterIP

1. Masuk ke Konsol ACK. Pada panel navigasi kiri, klik Clusters.

3. Pada halaman Deployments, temukan aplikasi target dan pilih > Edit YAML dari kolom Actions.

   Klik Create From YAML untuk membuat aplikasi baru.

4. Pada file YAML, tambahkan labels berikut di bawah `spec.template.metadata`.

   labels:
     aliyun.com/app-language: python # Wajib untuk aplikasi Python. Menentukan bahwa ini adalah aplikasi Python.
     armsPilotAutoEnable: 'on'
     armsPilotCreateAppName: "deployment-name"    # Nama tampilan aplikasi di ARMS.

   Penting

   Jika versi komponen ack-onepilot yang Anda instal lebih baru dari 5.0.0, komponen tersebut secara otomatis mengunduh dan menyuntikkan paket agen Python pada langkah ini. Ini memberikan pengalaman instalasi sepenuhnya non-intrusif. Jika Anda tidak ingin menggunakan fitur ini, atau jika Anda telah menginstal agen Python secara manual di kontainer, kami menyarankan Anda menonaktifkan fitur penyuntikan non-intrusif untuk Python menggunakan label berikut:

   labels:
     aliyun.com/app-language: python # Wajib untuk aplikasi Python. Menentukan bahwa ini adalah aplikasi Python.
     armsPilotAutoEnable: 'on'
     armsPilotCreateAppName: "deployment-name"    # Nama tampilan aplikasi di ARMS.
     armsAutoInstrumentationEnable: "off"  # Menonaktifkan fitur penyuntikan non-intrusif untuk aplikasi Python.

   

5. Klik Update.

Hasil

Instalasi agen berhasil jika aplikasi Python muncul di halaman Application Monitoring > Applications di Konsol ARMS dan mulai melaporkan data dalam waktu sekitar satu menit.