Runtime dan metode logging yang didukung Format log default Format JSON untuk log sistem Format JSON untuk log aplikasi Mengatur format log fungsi Anda

Mengkonfigurasi JSON dan format log teks biasa

Menangkap output log Anda sebagai pasangan nilai kunci JSON membuatnya lebih mudah untuk mencari dan memfilter saat men-debug fungsi Anda. Dengan log berformat JSON, Anda juga dapat menambahkan tag dan informasi kontekstual ke log Anda. Ini dapat membantu Anda melakukan analisis otomatis terhadap volume besar data log. Kecuali alur kerja pengembangan Anda bergantung pada alat yang ada yang menggunakan log Lambda dalam teks biasa, sebaiknya pilih JSON untuk format log Anda.

Instans Terkelola Lambda

Instans Terkelola Lambda hanya mendukung format log JSON. Saat Anda membuat fungsi Instans Terkelola, Lambda secara otomatis mengonfigurasi format log ke JSON dan Anda tidak dapat mengubahnya menjadi teks biasa. Untuk informasi selengkapnya tentang Instans Terkelola, lihatInstans Terkelola Lambda.

Untuk semua runtime yang dikelola Lambda, Anda dapat memilih apakah log sistem fungsi Anda dikirim ke CloudWatch Log dalam teks biasa yang tidak terstruktur atau format JSON. Log sistem adalah log yang dihasilkan Lambda dan kadang-kadang dikenal sebagai log peristiwa platform.

Untuk runtime yang didukung, saat Anda menggunakan salah satu metode logging bawaan yang didukung, Lambda juga dapat menampilkan log aplikasi fungsi Anda (log yang dihasilkan kode fungsi Anda) dalam format JSON terstruktur. Saat Anda mengonfigurasi format log fungsi Anda untuk runtime ini, konfigurasi yang Anda pilih berlaku untuk log sistem dan aplikasi.

Untuk runtime yang didukung, jika fungsi Anda menggunakan pustaka atau metode logging yang didukung, Anda tidak perlu membuat perubahan apa pun pada kode yang ada untuk Lambda untuk menangkap log dalam JSON terstruktur.

catatan

Menggunakan pemformatan log JSON menambahkan metadata tambahan dan mengkodekan pesan log sebagai objek JSON yang berisi serangkaian pasangan nilai kunci. Karena itu, ukuran pesan log fungsi Anda dapat meningkat.

Runtime dan metode logging yang didukung

Lambda saat ini mendukung opsi untuk menampilkan log aplikasi terstruktur JSON untuk runtime berikut.

Bahasa	Versi yang didukung
Java	Semua runtime Java kecuali Java 8 di Amazon Linux 1
.NET	.NET 8 dan yang lebih baru
Node.js	Node.js 16 dan setelahnya
Python	Python 3.8 dan yang lebih baru
Ruby	Ruby 4.0 dan yang lebih baru
Karat	n/a

Agar Lambda dapat mengirim log aplikasi fungsi Anda ke CloudWatch dalam format JSON terstruktur, fungsi Anda harus menggunakan alat logging bawaan berikut untuk menampilkan log:

Java: LambdaLogger Logger atau Log4j2. Untuk informasi selengkapnya, lihat Log dan pantau fungsi Java Lambda.
.NET: ILambdaLogger Instance pada objek konteks. Untuk informasi selengkapnya, lihat Log dan pantau fungsi C# Lambda.
Node.js- Metode konsolconsole.trace,console.debug,console.log,console.info,console.error, danconsole.warn. Untuk informasi selengkapnya, lihat Log dan pantau fungsi Node.js Lambda.
Python: Pust logging aka Python standar. Untuk informasi selengkapnya, lihat Log dan pantau fungsi Python Lambda.
Ruby: Pust Logger aka Ruby standar. Untuk informasi selengkapnya, lihat Log dan pantau fungsi Ruby Lambda.
Kar at: P tracing eti. Untuk informasi selengkapnya, lihat Log dan pantau fungsi Rust Lambda.

Untuk runtime Lambda terkelola lainnya, Lambda saat ini hanya secara native mendukung pengambilan log sistem dalam format JSON terstruktur. Namun, Anda masih dapat menangkap log aplikasi dalam format JSON terstruktur di runtime apa pun dengan menggunakan alat pencatatan seperti Powertools untuk output log berformat JSON AWS Lambda tersebut.

Format log default

Saat ini, format log default untuk semua runtime Lambda adalah teks biasa. Untuk Instans Terkelola Lambda, format log selalu JSON dan tidak dapat diubah.

Jika Anda sudah menggunakan pustaka logging seperti Powertools AWS Lambda untuk menghasilkan log fungsi Anda dalam format terstruktur JSON, Anda tidak perlu mengubah kode Anda jika Anda memilih pemformatan log JSON. Lambda tidak mengkodekan ulang log apa pun yang sudah dikodekan JSON, jadi log aplikasi fungsi Anda terus ditangkap seperti sebelumnya.

Format JSON untuk log sistem

Saat Anda mengonfigurasi format log fungsi Anda sebagai JSON, setiap item log sistem (peristiwa platform) ditangkap sebagai objek JSON yang berisi pasangan nilai kunci dengan kunci berikut:

"time"- waktu pesan log dihasilkan
"type"- jenis peristiwa yang dicatat
"record"- isi keluaran log

Format "record" nilai bervariasi sesuai dengan jenis peristiwa yang dicatat. Untuk mengetahui informasi selengkapnya, lihat Telemetri API Jenis objek peristiwa. Untuk informasi selengkapnya tentang tingkat log yang ditetapkan untuk peristiwa log sistem, lihatPemetaan peristiwa tingkat log sistem.

Sebagai perbandingan, dua contoh berikut menunjukkan output log yang sama dalam format teks biasa dan JSON terstruktur. Perhatikan bahwa dalam kebanyakan kasus, peristiwa log sistem berisi lebih banyak informasi saat output dalam format JSON daripada ketika output dalam teks biasa.

contoh teks biasa:


2024-03-13 18:56:24.046000 fbe8c1   INIT_START  Runtime Version: python:3.12.v18  Runtime Version ARN: arn:aws:lambda:eu-west-1::runtime:edb5a058bfa782cb9cedc6d534ac8b8c193bc28e9a9879d9f5ebaaf619cd0fc0

contoh JSON terstruktur:


{
  "time": "2024-03-13T18:56:24.046Z",
  "type": "platform.initStart",
  "record": {
    "initializationType": "on-demand",
    "phase": "init",
    "runtimeVersion": "python:3.12.v18",
    "runtimeVersionArn": "arn:aws:lambda:eu-west-1::runtime:edb5a058bfa782cb9cedc6d534ac8b8c193bc28e9a9879d9f5ebaaf619cd0fc0"
  }
}

catatan

Per Mengakses data telemetri real-time untuk ekstensi menggunakan API Telemetri istiwa platform selalu memancarkan seperti START dan REPORT dalam format JSON. Mengkonfigurasi format log sistem yang dikirim Lambda CloudWatch tidak memengaruhi perilaku API Telemetri Lambda.

Format JSON untuk log aplikasi

Saat Anda mengonfigurasi format log fungsi Anda sebagai JSON, output log aplikasi yang ditulis menggunakan pustaka logging yang didukung dan metode ditangkap sebagai objek JSON yang berisi pasangan nilai kunci dengan kunci berikut.

"timestamp"- waktu pesan log dihasilkan
"level"- tingkat log yang ditetapkan untuk pesan
"message"- isi pesan log
"requestId"(Python, .NET, dan Node.js) atau "AWSrequestId" (Java) - ID permintaan unik untuk pemanggilan fungsi

Bergantung pada runtime dan metode logging yang digunakan fungsi Anda, objek JSON ini mungkin juga berisi pasangan kunci tambahan. Misalnya, di Node.js, jika fungsi Anda menggunakan console metode untuk mencatat objek kesalahan menggunakan beberapa argumen, Objek JSON berisi pasangan nilai kunci tambahan dengan kuncierrorMessage,errorType, danstackTrace. Untuk mempelajari lebih lanjut tentang log berformat JSON di runtime Lambda yang berbeda, lihat, Log dan pantau fungsi Python Lambda Log dan pantau fungsi Node.js Lambda, dan. Log dan pantau fungsi Java Lambda

catatan

Kunci yang digunakan Lambda untuk nilai stempel waktu berbeda untuk log sistem dan log aplikasi. Untuk log sistem, Lambda menggunakan kunci "time" untuk menjaga konsistensi dengan Telemetry API. Untuk log aplikasi, Lambda mengikuti konvensi runtime dan penggunaan yang didukung. "timestamp"

Sebagai perbandingan, dua contoh berikut menunjukkan output log yang sama dalam format teks biasa dan JSON terstruktur.

contoh teks biasa:


2024-10-27T19:17:45.586Z 79b4f56e-95b1-4643-9700-2807f4e68189 INFO some log message

contoh JSON terstruktur:


{
    "timestamp":"2024-10-27T19:17:45.586Z",
    "level":"INFO",
    "message":"some log message",
    "requestId":"79b4f56e-95b1-4643-9700-2807f4e68189"
}

Mengatur format log fungsi Anda

Untuk mengkonfigurasi format log untuk fungsi Anda, Anda dapat menggunakan konsol Lambda atau AWS Command Line Interface (AWS CLI). Anda juga dapat mengonfigurasi format log fungsi menggunakan perintah CreateFunction dan UpdateFunctionConfiguration Lambda API, sumber daya AWS Serverless Application Model (AWS SAM) AWS::Serverless: :Function, dan sumber daya CloudFormation AWS::Lambda:: Function.

Mengubah format log fungsi Anda tidak memengaruhi log yang ada yang disimpan di CloudWatch Log. Hanya log baru yang menggunakan format yang diperbarui.

Jika Anda mengubah format log fungsi Anda ke JSON dan tidak menyetel level log, maka Lambda secara otomatis menetapkan tingkat log aplikasi fungsi Anda dan tingkat log sistem ke INFO. Ini berarti bahwa Lambda hanya mengirimkan output log dari level INFO dan lebih rendah ke CloudWatch Log. Untuk mempelajari selengkapnya tentang penyaringan tingkat log aplikasi dan sistem, lihat Log-level penyaringan

catatan

Untuk runtime Python, ketika format log fungsi Anda diatur ke teks biasa, pengaturan tingkat log default adalah WARN. Ini berarti bahwa Lambda hanya mengirimkan output log level WARN dan lebih rendah ke CloudWatch Logs. Mengubah format log fungsi Anda ke JSON mengubah perilaku default ini. Untuk mempelajari lebih lanjut tentang masuk di Python, lihatLog dan pantau fungsi Python Lambda.

Untuk Node.js fungsi yang memancarkan log format metrik tertanam (EMF), mengubah format log fungsi Anda ke JSON dapat mengaki CloudWatch batkan tidak dapat mengenali metrik Anda.

penting

Jika fungsi Anda menggunakan Powertools for AWS Lambda (TypeScript) atau pustaka klien EMF open-source untuk mengeluarkan log EMF, perbarui pustaka Powertools dan EMF Anda ke versi terbaru untuk memastikan bahwa CloudWatch dapat terus mengurai log Anda dengan benar. Jika Anda beralih ke format log JSON, kami juga menyarankan Anda melakukan pengujian untuk memastikan kompatibilitas dengan metrik tertanam fungsi Anda. Untuk saran lebih lanjut tentang fungsi node.js yang memancarkan log EMF, lihatMenggunakan pustaka klien format metrik tertanam (EMF) dengan log JSON terstruktur.

Untuk mengkonfigurasi format log fungsi (konsol)

Buka halaman Fungsi di konsol Lambda.
Pilih fungsi
Pada halaman konfigurasi fungsi, pilih Alat Pem antauan dan operasi.
Di panel konfigurasi logging, pilih Edit.
Di bawah Konten log, untuk Format log pilih Teks atau JSON.
Pilih Simpan.

Untuk mengubah format log dari fungsi yang ada (AWS CLI)

Untuk mengubah format log dari fungsi yang ada, gunakan perintah update-function-configuration. Atur LogFormat opsi LoggingConfig ke salah satu JSON atauText.
```
aws lambda update-function-configuration \
  --function-name myFunction \
  --logging-config LogFormat=JSON
```

Untuk mengatur format log saat Anda membuat fungsi (AWS CLI)

Untuk mengkonfigurasi format log saat Anda membuat fungsi baru, gunakan --logging-config opsi dalam perintah create-function. Setel LogFormat ke salah JSON satu atauText. Perintah contoh berikut membuat Node.js fungsi yang mengeluarkan log dalam JSON terstruktur.

Jika Anda tidak menentukan format log saat membuat fungsi, Lambda menggunakan format log default untuk versi runtime yang Anda pilih. Untuk informasi tentang format pencatatan default, lihatFormat log default.
```
aws lambda create-function \ 
  --function-name myFunction \ 
  --runtime nodejs24.x \
  --handler index.handler \
  --zip-file fileb://function.zip \
  --role arn:aws:iam::123456789012:role/LambdaRole \
  --logging-config LogFormat=JSON
```

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Log fungsi

Log-level penyaringan