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 instance Grafana Anda selama penyelidikan insiden. Integrasi ini mengikuti proses dua langkah: pendaftaran tingkat akun Grafana, diikuti dengan menghubungkannya ke Spaces Agen individu.

Untuk meningkatkan keamanan, integrasi Grafana hanya mengaktifkan alat baca-saja. 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. Titik akhir jaringan publik dan pribadi didukung. Dengan konektivitas jaringan pribadi, instance 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 dibagi di antara semua Ruang Agen di akun itu. Setiap pendaftaran sesuai dengan satu contoh Grafana. Untuk mendaftarkan instans Grafana tambahan, ulangi proses ini untuk masing-masing instans dan berikan Nama Layanan masing-masing pendaftaran.

Langkah 1: Konfigurasikan Grafana

  1. Masuk ke Konsol AWS Manajemen

  2. Arahkan ke konsol AWS DevOps Agen

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

  4. Temukan Grafana di bagian Penyedia yang tersedia di bawah Telemetri dan pilih 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 dari 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 instance Grafana Anda, buka Administrasi > Akun layanan, buat akun layanan dengan peran Penampil, 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. Pilih Berikutnya

Langkah 2: Tinjau dan kirimkan pendaftaran Grafana

  1. Tinjau semua detail konfigurasi Grafana

  2. Pilih Kirim untuk menyelesaikan pendaftaran

  3. Setelah pendaftaran berhasil, Grafana muncul di bagian Terdaftar saat ini di halaman Penyedia Kemampuan

Menambahkan Grafana ke Ruang Agen

Setelah mendaftarkan Grafana di tingkat akun, Anda dapat menghubungkannya ke Spaces Agen individu:

  1. Di konsol AWS DevOps Agen, pilih Ruang Agen Anda

  2. Buka tab Capabilities

  3. Di bagian Telemetri, pilih Tambah

  4. Pilih pendaftaran Grafana yang ingin Anda sambungkan ke Ruang Agen ini.

  5. Pilih Simpan.

Satu Ruang Agen dapat menggunakan lebih dari satu pendaftaran Grafana. Untuk menghubungkan pendaftaran lain, ulangi langkah-langkah ini.

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 kredensia, lihat. Memanggil A DevOps gen melalui Webhook

Jika Anda kehilangan rahasia webhook, putar webhook untuk menghasilkan rahasia baru. URL webhook tidak berubah. Untuk petunjuk tentang mengelola kredentif webhook, lihat Mengelola kreden tif webhook.

Langkah 1: Buat template pemberitahuan kustom

Di instance Grafana Anda, navigasikan ke Per ingatan > Titik kontak > Template notifikasi dan buat templat 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 muatan webhook yang diharapkan oleh Agen. AWS DevOps Ini memetakan label peringatan, anotasi, dan status ke bidang yang sesuai, dan menyalin setiap label peringatan kedata.metadata. Untuk informasi selengkapnya tentang apa yang diterima agendata, lihat Bat asan.

Langkah 2: Buat titik kontak webhook

  1. Di Grafana, navigasikan ke Per ingatan > Poin kontak dan pilih Tambahkan titik kontak

  2. Pilih Webhook sebagai tipe integrasi

  3. Mengatur URL ke titik akhir webhook AWS DevOps Agen Anda

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

  5. Atur bidang Custom Payload untuk menggunakan template kustom Anda: {{ template "devops-agent-payload" . }}

  6. Pilih Simpan titik kontak

Langkah 3: Tetapkan titik kontak ke kebijakan notifikasi

  1. Arahkan ke Peringatan > Kebijakan notifikasi

  2. Mengedit kebijakan yang sudah ada atau membuat yang baru

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

  4. Pilih Simpan kebijakan

Ketika peringatan yang cocok diaktifkan, Grafana akan mengirim muatan yang diformat ke A AWS DevOps gen, yang akan memulai penyelidikan secara otomatis.

Batasan

  • Label peringatan di data - Template notifikasi menyalin setiap label peringatan ke dalamdata.metadata. Bidang ini tumbuh dengan jumlah label pada aturan peringatan Anda. Webhook menerimadata, tetapi tidak menyertakan isinya dalam konteks investigasi. Hanyatitle,description,priority, dan referensi insiden mencapai agen. Masukkan apa pun yang dibutuhkan investigasi dalam an summary otasi peringatan, yang dipetakan oleh templatedescription.

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

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

Pertimbangan Grafana yang Dikelola Amazon

Jika Anda menggunakan Amazon Managed Grafana (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 AWS DevOps Agen. Untuk detailnya, lihat Memper ingatkan titik kontak di Amazon Managed Graf ana.

  • Kedaluwarsa token akun layanan — Token akun layanan AMG memiliki kedaluwarsa maksimum 30 hari. Anda perlu memutar token dan memperbarui pendaftaran Grafana Anda di AWS DevOps Agen sebelum kedaluwarsa. Lihat M engelola koneksi Grafana untuk cara memperbarui kredenSIAL. Untuk detail tentang batas token AMG, lihat Akun layanan di Graf ana yang Dikelola Amazon.

Mengelola koneksi Grafana

  • Memperbarui kredenSIAL — Jika token akun layanan Anda kedaluwarsa atau perlu diperbarui, Anda dapat memutarnya tanpa membatalkan pendaftaran. Pada halaman Penyedia Kemampuan, pilih pendaftaran Grafana Anda, pilih Per barui dari menu Tindakan, dan masukkan token baru. Asosiasi Agen Space Anda dipertahankan.

  • 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 sambungan Grafana dari Ruang Agen, pilih di bagian Telemetri dan pilih Hapus. Untuk menghapus pendaftaran sepenuhnya, hapus dari semua Ruang Agen terlebih dahulu, lalu hapus pendaftaran dari halaman Penyedia Kemampuan.