Tujuan log yang didukung Prasyarat Mengonfigurasikan pencatatan log Skema dan format log Log jam agen Log metadata agen Log penggunaan indeks Log sinkronisasi file basis pengetahuan Pertimbangan keamanan

Memantau Amazon Quick menggunakan CloudWatch Log

Anda dapat menggunakan Amazon CloudWatch Log s untuk menyampaikan percakapan obrolan, umpan balik pengguna, penggunaan jam agen, dan penggunaan penyimpanan indeks di Amazon Quick untuk Anda analisis. Log ini dapat dikirim ke beberapa tujuan, seperti CloudWatch, Amazon S3, atau Amazon Data Firehose (tarif standar berlaku).

penting

Siapkan pengiriman log yang dijual segera setelah mengaktifkan fitur Amazon Quick AI. Log tidak bersifat retroaktif — Anda hanya menerima peristiwa yang terjadi setelah pengiriman dikonfigurasi.

Berikut ini adalah contoh tugas yang dapat Anda selesaikan dengan log dari Amazon Quick:

Identifikasi pertanyaan umum pengguna dan masalah dengan meninjau konten pesan obrolan.
Pantau kualitas tanggapan dengan melihat metrik sepertifeedbackReason.
Memahami sentimen dan kepuasan pengguna dengan menganalisis data umpan balik, termasuk komentar dan peringkat kegunaan.
Hasilkan dasbor dan laporan khusus untuk melacak metrik dan tren utama dari waktu ke waktu.
Mengidentifikasi dan menganalisis kasus di mana obrolan tidak mengembalikan jawaban atau permintaan pengguna diblokir.
Pantau penggunaan jam agen.
Lacak penggunaan penyimpanan indeks di seluruh basis pengetahuan dan Spaces.
Lacak operasi sinkronisasi basis pengetahuan dan identifikasi kegagalan crawling atau pengindeksan dokumen.

penting

Log dari percakapan mungkin termasuk data sensitif atau identitas pribadi yang diteruskan dalam obrolan. Anda dapat menyaring informasi ini dari log Anda saat menyiapkan langganan log. Atau Anda dapat menutupi data ini di log Anda menggunakan kebijakan pen CloudWatch yamaran log. Untuk informasi selengkapnya, lihat Membantu melindungi data log sensitif dengan masking.

Tujuan log yang didukung

Amazon Quick dapat mengirimkan log ke tujuan berikut:

Amazon CloudWatch Logs — Untuk pemantauan dan analisis real-time
Amazon S3 — Untuk penyimpanan jangka panjang dan pemrosesan batch
Amazon Data Firehose — Untuk analitik streaming dan transformasi data

Prasyarat

Sebelum Anda dapat mengaktifkan logging, pastikan Anda memiliki yang berikut:

Instans Amazon Quick aktif dengan langganan Enterprise atau Professional
Izin IAM yang sesuai untuk mengkonfigurasi pengiriman log
Tujuan yang dikonfigurasi untuk log Anda (CloudWatch Log, bucket Amazon S3, atau Firehose)

Mengonfigurasikan pencatatan log

Untuk mengaktifkan logging untuk obrolan cepat dan umpan balik Amazon, konfigurasikan izin IAM, buat sumber pengiriman dan tujuan, dan verifikasi pengiriman log.

Menyiapkan izin IAM

Untuk mengatur CloudWatch Log untuk Amazon Quick, gunakan contoh kebijakan IAM berikut untuk memberikan izin yang diperlukan.


{
    "Version": "2012-10-17",
    "Statement": [{
        "Sid": "QuicksightLogDeliveryPermissions",
        "Effect": "Allow",
        "Action": "quicksight:AllowVendedLogDeliveryForResource",
        "Resource": "arn:aws:quicksight:region:account-id:account/account-id"
    }]
}

Anda juga harus mengizinkan prinsi delivery.logs.amazonaws.com pal layanan dalam kebijakan AWS KMS kunci yang dikelola pelanggan Anda.


{
    "Effect": "Allow",
    "Principal": {
        "Service": "delivery.logs.amazonaws.com"
    },
    "Action": [
        "kms:GenerateDataKey",
        "kms:Decrypt"
    ],
    "Resource": "*",
    "Condition": {
        "StringEquals": {
            "kms:EncryptionContext:SourceArn": "arn:partition:logs:region:account-id:*"
        }
    }
}

Konfigurasikan langganan log

Misalnya kebijakan IAM dengan semua izin yang diperlukan untuk tujuan pencatatan spesifik Anda, lihat Meng aktifkan pencatatan dari AWS layanan di Panduan Pengguna Amazon CloudWatch Log.

Buat sumber pengiriman dengan operasi PutDeliverySource CloudWatch Logs API. Berikan nama sumber pengiriman dan untukresourceArn, tentukan ARN aplikasi Anda. UntuklogType, tent CHAT_LOGS ukan,AGENT_HOURS_LOGS,AGENT_METADATA_LOGS,FEEDBACK_LOGS,INDEX_USAGE_LOGS, atauKB_FILE_SYNC_LOGS.


{
    "logType": "CHAT_LOGS",
    "name": "my-quick-suite-delivery-source",
    "resourceArn": "arn:aws:quicksight:your-region:your-account-id:account/account-id"
}


{
    "logType": "FEEDBACK_LOGS",
    "name": "my-quick-suite-delivery-source",
    "resourceArn": "arn:aws:quicksight:your-region:your-account-id:account/account-id"
}


{
    "logType": "AGENT_HOURS_LOGS",
    "name": "my-quick-suite-delivery-source",
    "resourceArn": "arn:aws:quicksight:your-region:your-account-id:account/account-id"
}


{
    "logType": "INDEX_USAGE_LOGS",
    "name": "my-quick-index-usage-delivery-source",
    "resourceArn": "arn:aws:quicksight:your-region:your-account-id:account/account-id"
}


{
    "logType": "KB_FILE_SYNC_LOGS",
    "name": "my-quick-kb-file-sync-delivery-source",
    "resourceArn": "arn:aws:quicksight:your-region:your-account-id:account/account-id"
}


{
    "logType": "AGENT_METADATA_LOGS",
    "name": "my-quick-agent-metadata-delivery-source",
    "resourceArn": "arn:aws:quicksight:your-region:your-account-id:account/account-id"
}

Untuk mengaktifkan pencatatan percakapan pengguna dengan operasi CloudWatch Logs API, Anda memanggil operasi PutDeliverySourcePutDeliveryDestination,, dan CreateDelivery API.

catatan

Vended-log Pengiriman per Wilayah. Setiap pengiriman hanya menangkap aktivitas yang terjadi di Wilayah yang ditentukan oleh resourceArn inPutDeliverySource. Untuk menerima log dari beberapa Wilayah, konfigurasikan pengiriman terpisah di setiap Wilayah.

Verifikasi pengiriman log

Setelah Anda mengonfigurasi pengiriman log, verifikasi bahwa log sedang dikirimkan ke tujuan Anda:

Verifikasi pengaturan: Verifikasi daftar pengiriman yang telah dibuat di akun dengan menggunakan DescribeDeliveries API di CloudWatch Log.
CloudWatch Log: Periksa grup log yang ditentukan untuk aliran log baru.
Amazon S3: Pantau bucket Anda untuk file log baru.
Firehose: Verifikasi data mengalir melalui aliran pengiriman Anda.

Skema dan format log

Amazon Quick log mengikuti skema terstruktur dengan bidang umum yang dibagikan di semua jenis log dan bidang khusus untuk log obrolan dan umpan balik.

Bidang umum

Semua peristiwa log menyertakan bidang umum ini:

resource_arn— Sumber daya ARN akun Amazon Quick Anda (misalnya,arn:aws:quicksight:us-east-1:111122223333:account/111122223333:)
event_timestamp— Waktu zaman Unix dalam milidetik (misalnya,) 1763532110061
logType— Jenis log (misalnya, CHAT_LOGS atauFEEDBACK_LOGS)
accountId— ID AWS akun (misalnya,123456789012)
user_arn— Pengguna Amazon Quick ARN terkait dengan acara (misalnya,"arn:aws:quicksight:us-west-2:111122223333:user/default/user")

Log obrolan

Log obrolan menangkap interaksi percakapan:

catatan

Percakapan sementara yang dikecualikan dari riwayat dan memori masih dikirimkan ke log obrolan. Setiap catatan termasuk pengguna user_arn dan user_type pengguna yang memulai percakapan.

user_arn— Pengguna Amazon Quick ARN terkait dengan acara
user_type— Jenis pengguna Amazon Quick yang terkait dengan acara (misalnya,ADMIN_PRO)
status_code— Status permintaan obrolan (misalnya,success,request_blocked,no_answer_found)
conversation_id— ID unik untuk percakapan pengguna
system_message_id— ID System-generated pesan
message_scope— Lingkup pesan (misalnya,all_resources,specific_resources,no_resources)
user_message_id— ID unik dari pesan pengguna
user_message— Pesan pengguna dalam percakapan
agent_id— ID unik agen obrolan, atau SYSTEM untuk agen default
flow_id— ID unik Amazon Quick Flow, atau - jika bukan pemanggilan aliran
system_text_message— Respons sistem dalam percakapan
user_selected_resources— Daftar sumber daya yang dipilih oleh pengguna
action_connectors— Daftar konektor tindakan yang tersedia dalam percakapan
cited_resource— Daftar sumber yang dikutip
file_attachment— Daftar file yang dilampirkan oleh pengguna
resource_arn— Sumber daya ARN dari akun Amazon Quick Anda
event_timestamp— Stempel waktu acara
logType – CHAT_LOGS
accountId— ID AWS akun

Berikut ini adalah contoh log obrolan:


{
    "user_arn": "arn:aws:quicksight:us-east-1:111122223333:user/default/johndoe",
    "user_type": "ADMIN_PRO",
    "status_code": "success",
    "conversation_id": "c11ba72c-ff18-4213-9686-1952bb547c19",
    "system_message_id": "42a37690-1804-442b-8368-3d34570dd2cd",
    "message_scope": "all_resources",
    "user_message_id": "5ec45e03-bf22-40c7-b32a-d69eb015f86b",
    "user_message": "What is in this document?",
    "agent_id": "SYSTEM",
    "flow_id": "-",
    "system_text_message": "Here is a summary of the attached document.",
    "user_selected_resources": [{"resourceId": "ALL", "resourceType": "space"}],
    "action_connectors": [{"actionConnectorId": "quicksuite-documentation"}, {"actionConnectorId": "quicksuite-websearch"}],
    "cited_resource": [{"citedResourceType": "document", "citedResourceId": null, "citedResourceName": "example-document.html"}],
    "file_attachment": [{"fileAttachmentType": "html", "fileAttachmentName": "example-document.html"}],
    "resource_arn": "arn:aws:quicksight:us-east-1:111122223333:account/111122223333",
    "event_timestamp": 1787185484508,
    "logType": "CHAT_LOGS",
    "accountId": "111122223333"
}

Log umpan balik

Log umpan balik menangkap umpan balik pengguna pada tanggapan obrolan:

user_arn— Pengguna Amazon Quick ARN terkait dengan acara
user_type— Jenis pengguna Amazon Quick yang terkait dengan acara (misalnya,ADMIN_PRO)
status_code— Status pengiriman acara
conversation_id— ID unik percakapan
system_message_id— ID pesan yang dihasilkan sistem
user_message_id— ID unik pesan pengguna
feedback_type— Jenis umpan balik (misalnya,Not Useful,Useful)
feedback_reason— Alasan umpan balik yang dipilih oleh pengguna
feedback_details— (Opsional) Rincian tambahan yang disediakan oleh pengguna
resource_arn— Sumber daya ARN dari akun Amazon Quick Anda
event_timestamp— Stempel waktu acara
logType – FEEDBACK_LOGS
accountId— ID AWS akun

Berikut ini adalah contoh log umpan balik:


{
    "user_arn": "arn:aws:quicksight:us-east-1:111122223333:user/default/johndoe",
    "user_type": "ADMIN_PRO",
    "status_code": "success",
    "conversation_id": "c11ba72c-ff18-4213-9686-1952bb547c19",
    "system_message_id": "42a37690-1804-442b-8368-3d34570dd2cd",
    "user_message_id": "5ec45e03-bf22-40c7-b32a-d69eb015f86b",
    "feedback_type": "Not Useful",
    "feedback_reason": "Too wordy",
    "feedback_details": "The answer included too much background information.",
    "resource_arn": "arn:aws:quicksight:us-east-1:111122223333:account/111122223333",
    "event_timestamp": 1787185500123,
    "logType": "FEEDBACK_LOGS",
    "accountId": "111122223333"
}

Log jam agen

Jenis log ini menangkap log penggunaan untuk agen yang berbeda dalam akun Quick Anda yang digunakan untuk penetapan harga:

user_arn— Pengguna Amazon Quick ARN terkait dengan acara
subscription_type— Tingkat berlangganan pengguna. Nilai:ENTERPRISE,PROFESSIONAL.
reporting_service— Permukaan cepat yang menghabiskan jam agen. Nilai saat ini termasukFLOW,AUTOMATION, danRESEARCH. Nilai baru mungkin muncul saat fitur Cepat tambahan mulai mengukur jam agen.
usage_group— Apakah penggunaan ditanggung oleh hak berlangganan atau ditagih sebagai kelebihan biaya. Nilai:
- Included— Penggunaan dalam hibah hak harian untuk tingkat berlangganan. Tidak ada biaya tambahan.
- Extra— Kelebihan di luar hibah harian. Ditagih berdasarkan konsumsi.
usage_hours— Nilai desimal yang menunjukkan jam agen yang dikonsumsi untuk catatan ini
service_resource_arn— ARN dari sumber daya yang menghabiskan jam (misalnya, aliran, otomatisasi, atau sesi penelitian)
resource_arn— Sumber daya ARN dari akun Amazon Quick Anda
event_timestamp— Stempel waktu acara
logType – AGENT_HOURS_LOGS
accountId— ID AWS akun

Berikut ini adalah contoh log Jam Agen:


{
    "user_arn": "arn:aws:quicksight:us-east-1:111122223333:user/default/johndoe",
    "subscription_type": "ENTERPRISE",
    "reporting_service": "RESEARCH",
    "usage_group": "Included",
    "usage_hours": 0.0928,
    "service_resource_arn": "arn:aws:quicksight::111122223333:research/a11b2bbc-c123-3abc-a12b-12a34b5c678d",
    "resource_arn": "arn:aws:quicksight:us-east-1:111122223333:account/111122223333",
    "event_timestamp": 1787183715000,
    "logType": "AGENT_HOURS_LOGS",
    "accountId": "111122223333"
}

Log metadata agen

Log metadata agen menangkap peristiwa siklus hidup untuk agen obrolan, termasuk pembuatan, pembaruan, perubahan izin, dan penghapusan. Satu catatan dipancarkan per operasi agen:

user_arn— Pengguna Amazon Quick ARN terkait dengan acara tersebut.
event_name— Operasi siklus hidup agen. Nilai termasukCreateAgent,UpdateAgent,DeleteAgent,UpdateAgentPermissions, dan lainnya saat operasi baru ditambahkan.
event_version— Versi skema dari catatan log.
agent_id— UUID agen.
agent_arn— ARN penuh agen.
agent_name— Menampilkan nama agen.
agent_status— Status agen saat ini (misalnya,ACTIVE).
request_id— Minta pengenal untuk operasi.
description— Teks deskripsi agen.
spaces— JSON array spasi yang melekat pada agen.
permissions_granted— Izin ditambahkan dalam operasi ini.
permissions_revoked— Izin dihapus dalam operasi ini.
permissions_state— Izin saat ini setelah operasi.
update_action— Tindakan pembaruan dilakukan.
version— Nomor versi agen.
icon_id— Pengidentifikasi ikon untuk agen.
magic_builder_query— Kueri bahasa alami yang digunakan untuk membuat agen melalui pembangun.
instructions— Instruksi agen.
failed_to_add_spaces— Ruang yang tidak bisa dilampirkan.
failed_to_remove_spaces— Ruang yang tidak bisa dilepaskan.
draft_discarded— Apakah draf dibuang.
custom_prompt_input— Input prompt kustom dikonfigurasi untuk agen.
welcome_message— Pesan selamat datang ditampilkan kepada pengguna agen.
starter_prompts— Prompt pemula disarankan kepada pengguna agen.
resource_arn— Sumber daya ARN dari akun Amazon Quick Anda.
event_timestamp— Stempel waktu acara.
log_type – AGENT_METADATA_LOGS.
account_id— ID AWS akun.

catatan

Bid custom_prompt_input angwelcome_message,, dan starter_prompts berisi konten sensitif. Saat Anda mengonfigurasi AWS KMS kunci yang dikelola pelanggan untuk pengiriman, bidang ini dienkripsi. Tanpa kunci, mereka dikirim dalam teks jelas.

Berikut ini adalah contoh log metadata agen untuk suatu CreateAgent peristiwa:


{
    "user_arn": "arn:aws:quicksight:us-east-1:111122223333:user/default/johndoe",
    "event_version": "1.0",
    "event_name": "CreateAgent",
    "agent_id": "12345678-90ab-cdef-1234-567890abcdef",
    "request_id": "fedcba98-7654-3210-fedc-ba9876543210",
    "agent_arn": "arn:aws:quicksight:us-east-1:111122223333:agent/12345678-90ab-cdef-1234-567890abcdef",
    "agent_name": "Project Status Assistant",
    "agent_status": "ACTIVE",
    "description": "An agent that helps track project status and find relevant documentation.",
    "spaces": "[{\"Arn\": \"arn:aws:quicksight:us-east-1:111122223333:space/11112222-3333-4444-5555-666677778888\"}]",
    "resource_arn": "arn:aws:quicksight:us-east-1:111122223333:account/111122223333",
    "event_timestamp": 1787185396000,
    "log_type": "AGENT_METADATA_LOGS",
    "account_id": "111122223333"
}

Log penggunaan indeks

Log penggunaan indeks menangkap metrik penyimpanan per sumber untuk basis pengetahuan dan Spaces. Peristiwa dipublikasikan setiap kali terjadi perubahan (dibuat, diperbarui, disinkronkan, atau dihapus):

user_arn— Pengguna Amazon Quick ARN terkait dengan acara
consumed_index_size— Ukuran total (dalam byte) yang dikonsumsi oleh seluruh indeks
source_typeJenis sumber: SPACE atau KB
source_name— Nama tampilan Ruang atau basis pengetahuan
source_arn— ARN penuh dari sumbernya
consumed_source_size— Ukuran (dalam byte) yang dikonsumsi oleh sumber individual ini
consumed_source_doc_count— Jumlah dokumen dalam sumber ini
resource_arn— Sumber daya ARN dari akun Amazon Quick Anda
event_timestamp— Stempel waktu acara
log_type – INDEX_USAGE_LOGS
account_id— ID AWS akun

Berikut ini adalah contoh log penggunaan indeks:


{
    "account_id": "111122223333",
    "event_timestamp": 1774911984257,
    "log_type": "INDEX_USAGE_LOGS",
    "user_arn": "arn:aws:quicksight::111122223333:user/default/user",
    "resource_arn": "arn:aws:quicksight:us-west-2:111122223333:account/111122223333",
    "consumed_index_size": 500000,
    "source_type": "SPACE",
    "source_name": "my-space",
    "source_arn": "arn:aws:quicksight:us-west-2:111122223333:space/2744af89-31b2-423b-93a2-69b0cd0d7fa1",
    "consumed_source_size": 244436,
    "consumed_source_doc_count": 2
}

catatan

Acara dipublikasikan per sumber pada perubahan. Tidak semua sumber memancarkan peristiwa setiap hari. Untuk merekonstruksi status saat ini, gunakan peristiwa terbaru per. source_arn

Untuk informasi tentang membangun dasbor dan menjalankan kueri terhadap log penggunaan indeks, lihatPantau penggunaan penyimpanan indeks.

Log sinkronisasi file basis pengetahuan

Log sinkronisasi file basis pengetahuan menangkap peristiwa status sinkronisasi per dokumen. Satu catatan log dipancarkan per dokumen per proses sinkronisasi:

document_id— Pengidentifikasi dokumen asli seperti URL atau jalur file.
document_title— Judul dokumen.
document_status— Status dokumen terminal. Nilai:ADDED,MODIFIED,UNMODIFIED,DELETED,SKIPPED,FAILED.
sync_result— hasil High-level ketersediaan. Nilai: AVAILABLE atauUNAVAILABLE.
sync_id— Sinkronkan ID eksekusi pekerjaan.
data_source_id— Pengidentifikasi sumber data yang terhubung dengan basis pengetahuan.
source_uri— URL sumber dokumen.
error_message— Deskripsi kesalahan saat status FAILED atauSKIPPED.
error_mitigation— Panduan yang dapat ditindaklanjuti untuk menyelesaikan kesalahan.
error_type— Kode kesalahan saat status FAILED atauSKIPPED.
knowledge_base_id— UUID dari basis pengetahuan yang menghasilkan log.

Tabel berikut menjelaskan document_status nilai-nilai dan kesesuaiannyasync_result.

status_dokumen	sinkroniserkan_hasil	Arti
`ADDED`	`AVAILABLE`	Dokumen baru berhasil diindeks
`MODIFIED`	`AVAILABLE`	Dokumen yang ada diindeks ulang dengan perubahan
`UNMODIFIED`	`AVAILABLE`	Konten dokumen tidak berubah, tidak perlu pengindeksan ulang
`DELETED`	`UNAVAILABLE`	Dokumen dihapus dari indeks
`SKIPPED`	`UNAVAILABLE`	Dokumen difilter selama perayapan, seperti dengan robots.txt atau batas ukuran
`FAILED`	`UNAVAILABLE`	Dokumen gagal selama crawling atau pengindeksan

Contoh berikut menunjukkan log sinkronisasi file basis pengetahuan yang berhasil di mana dokumen ditambahkan ke basis pengetahuan:


{
    "resource_arn": "arn:aws:quicksight:us-west-2:111122223333:account/111122223333",
    "event_timestamp": 1781296858575,
    "log_type": "KB_FILE_SYNC_LOGS",
    "account_id": "111122223333",
    "document_id": "https://docs.aws.amazon.com/quick/latest/userguide/monitoring-cloudwatch-logs.html",
    "document_title": "Monitoring Amazon QuickSight usage using CloudWatch Logs",
    "document_status": "ADDED",
    "sync_result": "AVAILABLE",
    "sync_id": "86a70a9a-cad9-4fc6-8881-e3909c8954d2",
    "data_source_id": "56225744-18bc-4373-a91f-861dd1c3d566",
    "source_uri": "https://docs.aws.amazon.com/quick/latest/userguide/monitoring-cloudwatch-logs.html",
    "knowledge_base_id": "b0bd0a47-8095-439d-9dff-c64bd5fe3fa3"
}

Contoh berikut menunjukkan log dokumen yang dilewati di mana crawling dilewati karena kesalahan validasi:


{
    "resource_arn": "arn:aws:quicksight:us-west-2:111122223333:account/111122223333",
    "event_timestamp": 1781296492951,
    "log_type": "KB_FILE_SYNC_LOGS",
    "account_id": "111122223333",
    "document_id": "https://docs.aws.amazon.com/quick/latest/userguide/blocked-page.html",
    "document_title": "Blocked Page",
    "document_status": "SKIPPED",
    "sync_result": "UNAVAILABLE",
    "sync_id": "86a70a9a-cad9-4fc6-8881-e3909c8954d2",
    "data_source_id": "56225744-18bc-4373-a91f-861dd1c3d566",
    "source_uri": "https://docs.aws.amazon.com/quick/latest/userguide/blocked-page.html",
    "error_message": "This URL wasn't crawled because crawling isn't allowed by its robots.txt file.",
    "error_mitigation": "Contact the website administrator for assistance.",
    "error_type": "VALIDATION_ERROR",
    "knowledge_base_id": "b0bd0a47-8095-439d-9dff-c64bd5fe3fa3"
}

Pertimbangan keamanan

Enkripsi — Gunakan AWS KMS kunci yang dikelola pelanggan untuk data sensitif.
Kontrol akses — Menerapkan kebijakan IAM dengan hak istimewa terendah.
Retensi data — Konfigurasikan kebijakan penyimpanan yang sesuai untuk persyaratan kepatuhan Anda.

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

Respons insiden, pencatatan, dan pemantauan di Amazon Quick

Pemantauan menggunakan CloudTrail