Mengonfigurasi peringatan di Layanan Amazon OpenSearch

Konfigurasikan peringatan di OpenSearch Layanan Amazon untuk mendapatkan pemberitahuan saat data dari satu atau beberapa indeks memenuhi persyaratan tertentu. Misalnya, Anda mungkin ingin menerima email jika aplikasi Anda mencatat lebih dari lima kesalahan HTTP 503 dalam satu jam, atau Anda mungkin ingin halaman developer jika tidak ada dokumen baru yang diindeks dalam 20 menit terakhir.

Peringatan membutuhkan OpenSearch atau Elasticsearch 6.2 atau yang lebih baru.

catatan

Dokumentasi ini memberikan gambaran singkat tentang peringatan dan menyoroti bagaimana peringatan pada domain OpenSearch Layanan Amazon berbeda dari peringatan pada kluster open source. OpenSearch Untuk dokumentasi peringatan lengkap, termasuk referensi API yang komprehensif, daftar bidang permintaan yang tersedia untuk monitor komposit, dan deskripsi variabel pemicu dan tindakan yang tersedia, lihat Peringatan dalam dokumentasi. OpenSearch

Izin peringatan

Peringatan mendukung kontrol akses yang sangat baik. Untuk detail tentang pencampuran dan pencocokan izin agar sesuai dengan kasus penggunaan Anda, lihat Memperingatkan keamanan dalam dokumentasi. OpenSearch

Untuk mengakses halaman Peringatan dalam OpenSearch Dasbor, Anda setidaknya harus dipetakan ke peran yang alerting_read_access telah ditentukan sebelumnya, atau diberikan izin yang setara. Peran ini memberikan izin untuk melihat peringatan, tujuan, dan monitor, tetapi tidak untuk mengakui peringatan atau memodifikasi tujuan atau monitor.

Memulai dengan peringatan

Untuk membuat peringatan, Anda mengonfigurasi monitor, yang merupakan pekerjaan yang berjalan pada jadwal yang ditentukan dan OpenSearch indeks kueri. Anda juga mengonfigurasi satu atau beberapa pemicu, yang menentukan kondisi yang menghasilkan peristiwa. Terakhir, Anda mengonfigurasi tindakan, yang terjadi setelah peringatan dipicu.

Untuk memulai peringatan

1. Pilih Peringatan dari menu utama OpenSearch Dasbor dan pilih Buat monitor.

2. Buat monitor per kueri, per-bucket, per-cluster, atau per-dokumen. Untuk petunjuk, lihat Membuat monitor.

3. Untuk Pemicu, buat satu atau lebih pemicu. Untuk petunjuk, lihat Membuat pemicu.

4. Untuk Tindakan, siapkan saluran notifikasi untuk peringatan tersebut. Pilih antara Slack, Amazon Chime, webhook khusus, atau Amazon SNS. Seperti yang Anda bayangkan, notifikasi memerlukan konektivitas ke saluran. Misalnya, domain OpenSearch Layanan Anda harus dapat terhubung ke internet untuk memberi tahu saluran Slack atau mengirim webhook khusus ke server pihak ketiga. Webhook kustom harus memiliki alamat IP publik agar domain OpenSearch Layanan dapat mengirim peringatan kepadanya.

   Tip

   Setelah tindakan berhasil mengirim pesan, mengamankan akses ke pesan tersebut (misalnya, akses ke saluran Slack) adalah tanggung jawab Anda. Jika domain Anda berisi data sensitif, pertimbangkan untuk menggunakan pemicu tanpa tindakan dan secara berkala memeriksa Dashboard untuk peringatan.

Pemberitahuan

Peringatan terintegrasi dengan Notifikasi, yang merupakan sistem terpadu untuk notifikasi. OpenSearch Pemberitahuan memungkinkan Anda mengonfigurasi layanan komunikasi mana yang ingin Anda gunakan dan melihat statistik dan informasi pemecahan masalah yang relevan. Untuk dokumentasi komprehensif, lihat Pemberitahuan dalam OpenSearch dokumentasi.

Domain Anda harus menjalankan OpenSearch versi 2.3 atau yang lebih baru untuk menggunakan notifikasi.

catatan

OpenSearch pemberitahuan terpisah dari pemberitahuan OpenSearch Layanan, yang memberikan rincian tentang pembaruan perangkat lunak layanan, penyempurnaan Auto-Tune, dan informasi tingkat domain penting lainnya. OpenSearch notifikasi khusus plugin.

Saluran notifikasi menggantikan tujuan peringatan dimulai dengan OpenSearch versi 2.0. Tujuan secara resmi tidak digunakan lagi, dan semua pemberitahuan peringatan akan dikelola melalui saluran ke depan.

Saat Anda memutakhirkan domain ke versi 2.3 atau yang lebih baru (karena dukungan OpenSearch Layanan untuk 2.x dimulai dengan 2.3), tujuan yang ada akan dimigrasikan secara otomatis ke saluran notifikasi. Jika tujuan gagal bermigrasi, monitor akan terus menggunakannya hingga monitor dimigrasikan ke saluran notifikasi. Untuk informasi lebih lanjut, lihat Pertanyaan tentang tujuan dalam dokumentasi. OpenSearch

Untuk memulai notifikasi, masuk ke OpenSearch Dasbor dan pilih Notifikasi, Saluran, dan Buat saluran.

Amazon Simple Notification Service (Amazon SNS) adalah jenis saluran yang didukung untuk notifikasi. Untuk mengautentikasi pengguna, Anda harus memberi pengguna akses penuh ke Amazon SNS, atau membiarkan mereka mengambil peran IAM yang memiliki izin untuk mengakses Amazon SNS. Untuk petunjuk, lihat Amazon SNS sebagai jenis saluran.

Perbedaan

Dibandingkan dengan versi open-source OpenSearch, peringatan di Amazon OpenSearch Service memiliki beberapa perbedaan penting.

Pengaturan peringatan

OpenSearch Layanan memungkinkan Anda mengubah pengaturan peringatan berikut:

• plugins.scheduled_jobs.enabled

• plugins.alerting.alert_history_enabled

• plugins.alerting.alert_history_max_age

• plugins.alerting.alert_history_max_docs

• plugins.alerting.alert_history_retention_period

• plugins.alerting.alert_history_rollover_period

• plugins.alerting.filter_by_backend_roles

Semua pengaturan lainnya menggunakan nilai default yang tidak dapat Anda ubah.

Untuk menonaktifkan peringatan, kirim permintaan berikut:

PUT _cluster/settings
{
  "persistent" : {
    "plugins.scheduled_jobs.enabled" : false
  }
}

Permintaan berikut mengonfigurasi peringatan untuk menghapus indeks riwayat secara otomatis setelah tujuh hari, bukan 30 hari default:

PUT _cluster/settings
{
  "persistent": {
    "plugins.alerting.alert_history_retention_period": "7d"
  }
}

Jika sebelumnya Anda membuat monitor dan ingin menghentikan pembuatan indeks peringatan harian, hapus semua indeks riwayat peringatan:

DELETE .plugins-alerting-alert-history-*

Untuk mengurangi jumlah pecahan untuk indeks riwayat, buat templat indeks. Permintaan berikut menetapkan indeks riwayat untuk peringatan ke satu pecahan dan satu replika:

PUT _index_template/template-name
{
  "index_patterns": [".opendistro-alerting-alert-history-*"],
  "template": {
    "settings": {
      "number_of_shards": 1,
      "number_of_replicas": 1
    }
  }
}

Tergantung pada toleransi kehilangan data, Anda mungkin dapat mempertimbangkan untuk menggunakan nol replika. Untuk informasi selengkapnya tentang membuat dan mengelola templat indeks, lihat Templat indeks dalam OpenSearch dokumentasi.