View a markdown version of this page

Menghubungkan Grafana - AWS DevOps Agen
Persyaratan GrafanaMendaftarkan Grafana (tingkat akun)Menambahkan Grafana ke Ruang AgenMengkonfigurasi webhook peringatan GrafanaBatasanMengelola koneksi Grafana

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

Menghubungkan Grafana

Integrasi Grafana memungkinkan AWS DevOps Agen untuk menanyakan metrik, dasbor, dan data peringatan dari instans Grafana Anda selama penyelidikan insiden. Integrasi ini mengikuti proses dua langkah: pendaftaran Grafana tingkat akun, diikuti dengan menghubungkannya ke Ruang Agen individu.

Untuk meningkatkan keamanan, integrasi Grafana hanya mengaktifkan alat hanya-baca. Alat tulis dinonaktifkan dan tidak dapat diaktifkan. Ini berarti agen dapat menanyakan dan membaca data dari instance Grafana Anda tetapi tidak dapat membuat, memodifikasi, atau menghapus sumber daya Grafana apa pun seperti dasbor, peringatan, atau anotasi. Untuk informasi selengkapnya, lihat Keamanan di AWS DevOps Agen.

Persyaratan Grafana

Sebelum menghubungkan Grafana, pastikan Anda memiliki:

  • Grafana versi 9.0 atau yang lebih baru. Beberapa fitur, terutama operasi terkait sumber data, mungkin tidak berfungsi dengan benar dengan versi sebelumnya karena titik akhir API yang hilang.

  • Instans Grafana dapat diakses melalui HTTPS. Endpoint jaringan publik dan pribadi didukung. Dengan konektivitas jaringan pribadi, instans Grafana Anda dapat di-host di dalam VPC tanpa akses internet publik. Lihat perinciannya di Menghubungkan ke alat yang dihosting secara pribadi.

  • Akun layanan Grafana dengan token akses yang memiliki izin baca yang sesuai

Mendaftarkan Grafana (tingkat akun)

Grafana terdaftar di tingkat AWS akun dan dibagikan di antara semua Ruang Agen di akun itu.

Langkah 1: Konfigurasikan Grafana

  1. Masuk ke Konsol AWS Manajemen

  2. Arahkan ke konsol AWS DevOps Agen

  3. Buka halaman Penyedia Kemampuan (dapat diakses dari navigasi samping)

  4. Temukan Grafana di bagian Penyedia yang tersedia di bawah Telemetri dan klik Daftar

  5. Pada halaman Konfigurasi Grafana, masukkan informasi berikut:

    • Nama Layanan (wajib) — Masukkan nama deskriptif untuk server Grafana Anda menggunakan karakter alfanumerik, tanda hubung, dan garis bawah saja. Misalnya, my-grafana-server.

    • URL Grafana (wajib) — Masukkan URL HTTPS lengkap instance Grafana Anda. Misalnya, https://myinstance.grafana.net.

    • Token Akses Akun Layanan (wajib) — Masukkan token akses akun layanan Grafana. Token biasanya dimulai denganglsa_. Untuk membuat token akun layanan, navigasikan ke instans Grafana Anda, buka Administrasi > Akun layanan, buat akun layanan dengan peran Viewer, dan buat token.

    • Deskripsi (opsional) — Tambahkan deskripsi untuk membantu mengidentifikasi tujuan server. Misalnya, Production Grafana server for monitoring.

  6. (Opsional) Tambahkan AWS tag ke pendaftaran untuk tujuan organisasi.

  7. Klik Berikutnya

Langkah 2: Tinjau dan kirimkan pendaftaran Grafana

  1. Tinjau semua detail konfigurasi Grafana

  2. Klik Submit untuk menyelesaikan pendaftaran

  3. Setelah pendaftaran berhasil, Grafana muncul di bagian Saat ini terdaftar di halaman Penyedia Kemampuan

Menambahkan Grafana ke Ruang Agen

Setelah mendaftarkan Grafana di tingkat akun, Anda dapat menghubungkannya ke Ruang Agen individual:

  1. Di konsol AWS DevOps Agen, pilih Ruang Agen

  2. Buka tab Kemampuan

  3. Di bagian Telemetri, klik Tambah

  4. Pilih Grafana dari daftar penyedia yang tersedia

  5. Klik Simpan

Mengkonfigurasi webhook peringatan Grafana

Anda dapat mengonfigurasi Grafana untuk secara otomatis memicu investigasi AWS DevOps Agen saat peringatan menyala dengan mengirimkan webhook melalui titik kontak Grafana. Untuk detail tentang metode otentikasi webhook dan manajemen kredensi, lihat. Memanggil DevOps Agen melalui Webhook

Langkah 1: Buat template notifikasi khusus

Dalam instance Grafana Anda, navigasikan ke Alerting > Contact points > Notification templates dan buat template baru dengan konten berikut:

{{ define "devops-agent-payload" }}
{
  "eventType": "incident",
  "incidentId": "{{ (index .Alerts 0).Labels.alertname }}-{{ (index .Alerts 0).Fingerprint }}",
  "action": "{{ if eq .Status "resolved" }}resolved{{ else }}created{{ end }}",
  "priority": "{{ if eq .Status "resolved" }}MEDIUM{{ else }}HIGH{{ end }}",
  "title": "{{ (index .Alerts 0).Labels.alertname }}",
  "description": "{{ (index .Alerts 0).Annotations.summary }}",
  "service": "{{ if (index .Alerts 0).Labels.job }}{{ (index .Alerts 0).Labels.job }}{{ else }}grafana{{ end }}",
  "timestamp": "{{ (index .Alerts 0).StartsAt }}",
  "data": {
    "metadata": {
      {{ range $k, $v := (index .Alerts 0).Labels }}
      "{{ $k }}": "{{ $v }}",
      {{ end }}
      "_source": "grafana"
    }
  }
}
{{ end }}

Template ini memformat peringatan Grafana ke dalam struktur payload webhook yang diharapkan oleh Agen. AWS DevOps Ini memetakan label peringatan, anotasi, dan status ke dalam bidang yang sesuai, dan mencakup semua label peringatan sebagai metadata.

Langkah 2: Buat titik kontak webhook

  1. Di Grafana, navigasikan ke Peringatan > Titik kontak dan klik Tambahkan titik kontak

  2. Pilih Webhook sebagai tipe integrasi

  3. Atur URL ke titik akhir webhook AWS DevOps Agen

  4. Di bawah pengaturan Webhook Opsional, konfigurasikan header otentikasi berdasarkan jenis webhook Anda. Lihat metode otentikasi Webhook untuk detailnya.

  5. Setel bidang Pesan untuk menggunakan templat kustom Anda: {{ template "devops-agent-payload" . }}

  6. Klik Simpan titik kontak

Langkah 3: Tetapkan titik kontak ke kebijakan pemberitahuan

  1. Arahkan ke Peringatan > Kebijakan pemberitahuan

  2. Mengedit kebijakan yang sudah ada atau membuat yang baru

  3. Atur titik kontak ke titik kontak webhook yang Anda buat

  4. Klik Simpan kebijakan

Saat peringatan yang cocok diaktifkan, Grafana akan mengirimkan muatan yang diformat ke AWS DevOps Agen, yang akan memulai penyelidikan secara otomatis.

Batasan

  • ClickHouse alat sumber ClickHouse data — alat sumber data saat ini tidak didukung.

  • Pencegahan insiden proaktif — saat ini Pencegahan insiden proaktif tidak menggunakan alat Grafana. Support direncanakan untuk rilis di masa depan.

Pertimbangan Grafana yang Dikelola Amazon

Jika Anda menggunakan Grafana Terkelola Amazon (AMG), perhatikan batasan berikut:

  • Titik kontak Webhook tidak didukung - AMG saat ini tidak mendukung titik kontak webhook dalam konfigurasi peringatannya. Anda tidak dapat menggunakan AMG untuk mengirim webhook peringatan langsung ke Agen. AWS DevOps Untuk detailnya, lihat Memperingatkan titik kontak di Grafana Terkelola Amazon.

  • Kedaluwarsa token akun layanan — Token akun layanan AMG memiliki masa kedaluwarsa maksimum 30 hari. Anda perlu memutar token dan memperbarui pendaftaran Grafana Anda di AWS DevOps Agen sebelum kedaluwarsa. Lihat Mengelola koneksi Grafana untuk mengetahui cara memperbarui kredensional. Untuk detail tentang batas token AMG, lihat Akun layanan di Grafana Terkelola Amazon.

Mengelola koneksi Grafana

  • Memperbarui kredensi — Jika token akun layanan Anda kedaluwarsa atau perlu diperbarui, deregister Grafana dari halaman Penyedia Kemampuan dan daftar ulang dengan token baru.

  • Melihat instans yang terhubung — Di konsol AWS DevOps Agen, pilih Ruang Agen Anda dan buka tab Kemampuan untuk melihat sumber telemetri yang terhubung.

  • Menghapus Grafana — Untuk memutuskan Grafana dari Ruang Agen, pilih Grafana di bagian Telemetri dan klik Hapus. Untuk menghapus pendaftaran sepenuhnya, hapus terlebih dahulu dari semua Ruang Agen, lalu deregister dari halaman Penyedia Kemampuan.