View a markdown version of this page

Instrumentasi kode C # di AWS Lambda - AWS Lambda

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Instrumentasi kode C # di AWS Lambda

Lambda terintegrasi dengan AWS X-Ray untuk membantu Anda melacak, men-debug, dan mengoptimalkan aplikasi Lambda. Anda dapat menggunakan X-Ray untuk melacak permintaan saat melintasi sumber daya dalam aplikasi Anda, yang mungkin termasuk fungsi Lambda dan layanan lainnya AWS .

Untuk mengirim data pelacakan ke X-Ray, Anda dapat menggunakan salah satu dari tiga pustaka SDK:

Masing-masing SDK menawarkan cara untuk mengirim data telemetri Anda ke layanan. X-Ray Anda kemudian dapat menggunakannya X-Ray untuk melihat, memfilter, dan mendapatkan wawasan tentang metrik kinerja aplikasi Anda untuk mengidentifikasi masalah dan peluang untuk pengoptimalan.

penting

X-Ray dan Powertools untuk AWS Lambda SDK adalah bagian dari solusi instrumentasi terintegrasi yang ditawarkan oleh. AWS Lapisan ADOT Lambda adalah bagian dari standar industri untuk melacak instrumentasi yang mengumpulkan lebih banyak data secara umum, tetapi mungkin tidak cocok untuk semua kasus penggunaan. Anda dapat menerapkan pelacakan ujung ke ujung dalam X-Ray menggunakan salah satu solusi. Untuk mempelajari selengkapnya tentang memilih di antara keduanya, lihat Memilih antara AWS Distro untuk Telemetri Terbuka dan X-Ray SDK.

Menggunakan Powertools untuk AWS Lambda (.NET) dan AWS SAM untuk menelusuri

Ikuti langkah-langkah di bawah ini untuk mengunduh, membangun, dan menerapkan contoh aplikasi Hello World C# dengan modul Powertools untuk AWS Lambda (.NET) terintegrasi menggunakan. AWS SAM Aplikasi ini mengimplementasikan backend API dasar dan menggunakan Powertools untuk memancarkan log, metrik, dan jejak. Ini terdiri dari titik akhir Amazon API Gateway dan fungsi Lambda. Saat Anda mengirim permintaan GET ke titik akhir API Gateway, fungsi Lambda memanggil, mengirimkan log dan metrik menggunakan Format Metrik Tertanam ke CloudWatch, dan mengirimkan jejak ke. AWS X-Ray Fungsi mengembalikan pesan hello world.

Prasyarat

Untuk menyelesaikan langkah-langkah di bagian ini, Anda harus memiliki hal-hal berikut:

Menyebarkan sampel AWS SAM application
  1. Inisialisasi aplikasi menggunakan TypeScript template Hello World.

    sam init --app-template hello-world-powertools-dotnet --name sam-app --package-type Zip --runtime dotnet6 --no-tracing
  2. Bangun aplikasi.

    cd sam-app && sam build
  3. Terapkan aplikasi.

    sam deploy --guided
  4. Ikuti petunjuk di layar. Untuk menerima opsi default yang disediakan dalam pengalaman interaktif, tekanEnter.

    catatan

    Karena HelloWorldFunction mungkin tidak memiliki otorisasi yang ditentukan, Apakah ini baik-baik saja? , pastikan untuk masuky.

  5. Dapatkan URL aplikasi yang digunakan:

    aws cloudformation describe-stacks --stack-name sam-app --query 'Stacks[0].Outputs[?OutputKey==`HelloWorldApi`].OutputValue' --output text
  6. Memanggil titik akhir API:

    curl <URL_FROM_PREVIOUS_STEP>

    Jika berhasil, Anda akan melihat respons ini:

    {"message":"hello world"}
  7. Untuk mendapatkan jejak fungsi, jalankan sam tracing.

    sam traces

    Output jejak terlihat seperti ini:

    New XRay Service Graph Start time: 2023-02-20 23:05:16+08:00 End time: 2023-02-20 23:05:16+08:00 Reference Id: 0 - AWS::Lambda - sam-app-HelloWorldFunction-pNjujb7mEoew - Edges: [1] Summary_statistics: - total requests: 1 - ok count(2XX): 1 - error count(4XX): 0 - fault count(5XX): 0 - total response time: 2.814 Reference Id: 1 - AWS::Lambda::Function - sam-app-HelloWorldFunction-pNjujb7mEoew - Edges: [] Summary_statistics: - total requests: 1 - ok count(2XX): 1 - error count(4XX): 0 - fault count(5XX): 0 - total response time: 2.429 Reference Id: 2 - (Root) AWS::ApiGateway::Stage - sam-app/Prod - Edges: [0] Summary_statistics: - total requests: 1 - ok count(2XX): 1 - error count(4XX): 0 - fault count(5XX): 0 - total response time: 2.839 Reference Id: 3 - client - sam-app/Prod - Edges: [2] Summary_statistics: - total requests: 0 - ok count(2XX): 0 - error count(4XX): 0 - fault count(5XX): 0 - total response time: 0 XRay Event [revision 3] at (2023-02-20T23:05:16.521000) with id (1-63f38c2c-270200bf1d292a442c8e8a00) and duration (2.877s) - 2.839s - sam-app/Prod [HTTP: 200] - 2.836s - Lambda [HTTP: 200] - 2.814s - sam-app-HelloWorldFunction-pNjujb7mEoew [HTTP: 200] - 2.429s - sam-app-HelloWorldFunction-pNjujb7mEoew - 0.230s - Initialization - 2.389s - Invocation - 0.600s - ## FunctionHandler - 0.517s - Get Calling IP - 0.039s - Overhead
  8. Ini adalah titik akhir API publik yang dapat diakses melalui internet. Kami menyarankan Anda menghapus titik akhir setelah pengujian.

    sam delete

X-Ray tidak melacak semua permintaan ke aplikasi Anda. X-Ray menerapkan algoritma sampling untuk memastikan bahwa pelacakan efisien, sambil tetap memberikan sampel yang representatif dari semua permintaan. Tingkat pengambilan sampel adalah 1 permintaan per detik dan 5 persen dari permintaan tambahan. Anda tidak dapat mengonfigurasi la X-Ray ju pengambilan sampel untuk fungsi Anda.

Menggunakan X-Ray SDK untuk instrumen fungsi.NET Anda

Anda dapat menggunakan instrumen kode fungsi Anda untuk merekam metadata dan melacak panggilan downstream. Untuk merekam detail tentang panggilan yang dilakukan fungsi Anda ke sumber daya dan layanan lain, gunakan AWS X-Ray SDK for .NET. Untuk mendapatkan SDK, tambahkan paket AWSXRayRecorder ke file proyek Anda.

<Project Sdk="Microsoft.NET.Sdk"> <PropertyGroup> <TargetFramework>net8.0</TargetFramework> <GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles> <AWSProjectType>Lambda</AWSProjectType> </PropertyGroup> <ItemGroup> <PackageReference Include="Amazon.Lambda.Core" Version="2.1.0" /> <PackageReference Include="Amazon.Lambda.SQSEvents" Version="2.1.0" /> <PackageReference Include="Amazon.Lambda.Serialization.Json" Version="2.1.0" /> <PackageReference Include="AWSSDK.Core" Version="3.7.103.24" /> <PackageReference Include="AWSSDK.Lambda" Version="3.7.104.3" /> <PackageReference Include="AWSXRayRecorder.Core" Version="2.13.0" /> <PackageReference Include="AWSXRayRecorder.Handlers.AwsSdk" Version="2.11.0" /> </ItemGroup> </Project>

Ada berbagai paket Nuget yang menyediakan instrumentasi otomatis untuk AWS SDK, Entity Framework dan permintaan HTTP. Untuk melihat rangkaian lengkap opsi konfigurasi, lihat AWS X-Ray SDK untuk.NET di Panduan Peng AWS X-Ray embang.

Setelah Anda menambahkan paket Nuget yang diinginkan, konfigurasikan instrumentasi otomatis. Praktik terbaik adalah melakukan konfigurasi ini di luar fungsi handler fungsi Anda. Ini memanfaatkan lingkungan eksekusi yang digunakan kembali untuk meningkatkan kinerja fungsi Anda. Dalam contoh kode berikut, RegisterXRayForAllServices metode dipanggil dalam konstruktor fungsi untuk menambahkan instrumentasi untuk semua panggilan AWS SDK.

[assembly: LambdaSerializer(typeof(Amazon.Lambda.Serialization.SystemTextJson.DefaultLambdaJsonSerializer))] namespace GetProductHandler; public class Function { private readonly IDatabaseRepository _repo; public Function() { // Add auto instrumentation for all AWS SDK calls // It is important to call this method before initializing any SDK clients AWSSDKHandler.RegisterXRayForAllServices(); this._repo = new DatabaseRepository(); } public async Task<APIGatewayProxyResponse> FunctionHandler(APIGatewayProxyRequest request) { var id = request.PathParameters["id"]; var databaseRecord = await this._repo.GetById(id); return new APIGatewayProxyResponse { StatusCode = (int)HttpStatusCode.OK, Body = JsonSerializer.Serialize(databaseRecord) }; } }

Mengaktifkan pelacakan dengan konsol Lambda

Untuk mengaktifkan pelacakan aktif pada fungsi Lambda Anda dengan konsol, ikuti langkah-langkah berikut:

Untuk mengaktifkan penelusuran aktif
  1. Buka halaman Fungsi di konsol Lambda.

  2. Pilih fungsi.

  3. Pilih Konfigurasi dan kemudian pilih Alat Pemantauan dan operasi.

  4. Di bawah Alat pemantauan tambahan, pilih Edit.

  5. Di bawah CloudWatch Sinyal Aplikasi dan AWS X-Ray, pilih Aktifkan untuk pelac akan layanan Lambda.

  6. Pilih Simpan.

Mengaktifkan pelacakan dengan API Lambda

Konfigurasikan pelacakan pada fungsi Lambda Anda dengan AWS CLI atau AWS SDK, gunakan operasi API berikut:

Per AWS CLI intah contoh berikut memungkinkan pelacakan aktif pada fungsi bernama my-function.

aws lambda update-function-configuration --function-name my-function \ --tracing-config Mode=Active

Mode pelacakan adalah bagian dari konfigurasi khusus versi saat Anda menerbitkan versi fungsi Anda. Anda tidak dapat mengubah mode pelacakan pada versi yang telah diterbitkan.

Mengaktifkan pelacakan dengan CloudFormation

Untuk mengaktifkan pelacakan pada AWS::Lambda::Function sumber daya dalam CloudFormation template, gunakan TracingConfig properti.

contoh fungsi-inline.yml — Konfigurasi penelusuran
Resources: function: Type: AWS::Lambda::Function Properties: TracingConfig: Mode: Active ...

Untuk AWS::Serverless::Function sumber daya AWS Serverless Application Model (AWS SAM), gunakan Tracing properti.

contoh template.yml — Konfigurasi penelusuran
Resources: function: Type: AWS::Serverless::Function Properties: Tracing: Active ...

Menafsirkan X-Ray jejak

Fungsi Anda memerlukan izin untuk mengunggah data jejak ke X-Ray. Saat Anda mengaktifkan pelacakan di konsol Lambda, Lambda menambahkan izin yang diperlukan ke peran eksekusi fungsi Anda. Atau, tambahkan kebijakan AWSXRayDaemonWriteAccess ke peran eksekusi.

Setelah mengonfigurasi pelacakan aktif, Anda dapat mengamati permintaan tertentu melalui aplikasi Anda. Grafik X-Ray layanan menunjukkan informasi tentang aplikasi Anda dan semua komponennya. Contoh berikut menunjukkan aplikasi dengan dua fungsi. Fungsi utama memproses kejadian dan terkadang mengembalikan kesalahan. Fungsi kedua di bagian atas memproses kesalahan yang muncul di grup log pertama dan menggunakan AWS SDK untuk memanggil X-Ray, Amazon Simple Storage Service (Amazon S3), dan Amazon CloudWatch Logs.

Diagram yang menunjukkan dua aplikasi terpisah dan peta layanan masing-masing di X-Ray

X-Ray tidak melacak semua permintaan ke aplikasi Anda. X-Ray menerapkan algoritma sampling untuk memastikan bahwa pelacakan efisien, sambil tetap memberikan sampel yang representatif dari semua permintaan. Tingkat pengambilan sampel adalah 1 permintaan per detik dan 5 persen dari permintaan tambahan. Anda tidak dapat mengonfigurasi la X-Ray ju pengambilan sampel untuk fungsi Anda.

Dalam X-Ray, jejak mencatat informasi tentang permintaan yang diproses oleh satu atau lebih layanan. Lambda merekam 2 segmen per jejak, yang membuat dua node pada grafik layanan. Gambar berikut menyoroti dua node ini:

Peta X-Ray layanan dengan fungsi tunggal.

Node pertama di sebelah kiri mewakili layanan Lambda, yang menerima permintaan pemanggilan. Node kedua mewakili fungsi Lambda spesifik Anda. Contoh berikut menunjukkan jejak dengan dua segmen ini. Keduanya dinamai fungsi saya, tetapi yang satu memiliki asal AWS::Lambda dan yang lainnya memiliki asal dari. AWS::Lambda::Function Jika AWS::Lambda segmen menunjukkan kesalahan, layanan Lambda mengalami masalah. Jika AWS::Lambda::Function segmen menunjukkan kesalahan, fungsi Anda mengalami masalah.

Jej X-Ray ak yang menunjukkan latensi di setiap subsegmen dari pemanggilan Lambda tertentu.

Contoh ini memperluas AWS::Lambda::Function segmen untuk menunjukkan tiga subsegmennya.

catatan

AWS saat ini menerapkan perubahan pada layanan Lambda. Karena perubahan ini, Anda mungkin melihat perbedaan kecil antara struktur dan konten pesan log sistem dan segmen jejak yang dipancarkan oleh fungsi Lambda yang berbeda di Anda Akun AWS.

Contoh jejak yang ditampilkan di sini menggambarkan segmen fungsi gaya lama. Perbedaan antara segmen gaya lama dan baru dijelaskan dalam paragraf berikut.

Perubahan ini akan diterapkan selama beberapa minggu mendatang, dan semua fungsi di semua Wilayah AWS kecuali China dan GovCloud wilayah akan beralih untuk menggunakan pesan log format baru dan segmen pelacakan.

Segmen fungsi gaya lama berisi subsegmen berikut:

  • Inisialisasi – Mewakili waktu yang dihabiskan untuk memuat fungsi dan menjalankan kode inisialisasi. Subsegmen ini hanya muncul untuk peristiwa pertama yang diproses oleh setiap instance fungsi Anda.

  • Pemanggilan — Merupakan waktu yang dihabiskan untuk menjalankan kode handler Anda.

  • Overhead — Merupakan waktu yang dihabiskan runtime Lambda untuk mempersiapkan untuk menangani acara berikutnya.

Segmen fungsi gaya baru tidak berisi Invocation subsegmen. Sebaliknya, subsegmen pelanggan dilampirkan langsung ke segmen fungsi. Untuk informasi lebih lanjut tentang struktur segmen fungsi gaya lama dan baru, lihatMemahami X-Ray jejak.

Anda juga dapat melakukan instrumentasi klien HTTP, merekam kueri SQL, dan membuat subsegmen khusus dengan anotasi dan metadata. Untuk informasi selengkapnya, lihat AWS X-Ray SDK for .NET di Panduan AWS X-Ray Pengembang.

Harga

Anda dapat menggunakan X-Ray pelacakan secara gratis setiap bulan hingga batas tertentu sebagai bagian dari AWS Tingkat Gratis. Di luar ambang batas itu, X-Ray biaya untuk penyimpanan dan pengambilan jejak. Untuk informasi lebih lanjut, lihat Harga AWS X-Ray.