Unduh protologbeat - unduhan kode sumber protologbeat

protologbeat

Kategori lainnya

Version 0.2.0

Unduh

Protologbeat

Keterangan

Aplikasi ini dimaksudkan sebagai pengganti udplogbeat. Meskipun sangat mirip, ia memiliki beberapa perbaikan dan memungkinkan Anda memulai melalui UDP atau TCP. Itu dapat bertindak menerima log teks biasa atau JSON dan juga bertindak sebagai pengganti tujuan syslog.

Pastikan folder ini berada di lokasi berikut: ${GOPATH}/github.com/harfordfive

Memulai dengan Protologbeat

Opsi Konfigurasi

protologbeat.protocol : Baik tcp atau udp (Default: udp)
protologbeat.address : Alamat dimana proses akan dilisensi (Deafult: 127.0.0.1)
protologbeat.port : Port tempat proses akan mendengarkan (Default = 5000)
protologbeat.max_message_size : Ukuran pesan maksimum yang diterima (Default = 4096)
protologbeat.json_mode : Mengaktifkan pencatatan hanya pesan berformat JSON (Default = false)
protolog.merge_fields_to_root : Saat json_mode diaktifkan, apakah akan menggabungkan bidang yang diurai ke tingkat root. (Bawaan = salah)
protologbeat.default_es_log_type : Tipe Elasticsearch untuk ditetapkan ke suatu peristiwa jika tidak ditentukan (Default: protologbeat)
protologbeat.enable_syslog_format_only : Nilai Boolean yang menunjukkan apakah hanya pesan syslog yang boleh diterima. (Bawaan = salah)
protologbeat.enable_gelf : Nilai Boolean yang menunjukkan apakah proses harus dalam mode untuk hanya menerima pesan berformat GELF
protologbeat.enable_json_validation : Nilai Boolean yang menunjukkan apakah validasi skema JSON harus diterapkan untuk pesan format json (Default = false)
protologbeat.validate_all_json_types : Ketika json_mode diaktifkan, menunjukkan apakah SEMUA tipe harus memiliki skema yang ditentukan. Entri log dengan tipe yang tidak memiliki skema tidak akan dipublikasikan. (Bawaan = salah)
protologbeat.json_schema : Hash yang terdiri dari tipe Elasticsearch sebagai kunci, dan jalur file skema lokal absolut sebagai nilainya.

Contoh Konfigurasi

Berikut ini adalah contoh blok konfigurasi untuk bagian protologbeat .

Blok konfigurasi untuk logging teks biasa
Blok konfigurasi yang menerapkan skema JSON hanya untuk tipe Elasticsearch yang ditunjukkan
Blok konfigurasi yang menerapkan skema JSON untuk semua tipe Elasticsearch
Blok konfigurasi untuk penggantian syslog, dengan tipe ES khusus 'myapp'

Skema JSON dapat dibuat secara otomatis dari objek di sini: http://jsonschema.net/. Anda juga dapat melihat skema email_contact dan stock_item sebagai contoh.

Pertimbangan

Jika Anda bermaksud menggunakan ini sebagai pengganti drop-in untuk login dengan Rsyslog, metode ini tidak akan menyimpan data Anda ke file di disk.
Jika protologbeat tidak aktif karena alasan tertentu, pesan yang dikirim ke port UDP yang dikonfigurasi tidak akan pernah diproses atau dikirim ke cluster ELK Anda.
Jika Anda memerlukan jaminan 100% setiap pesan akan terkirim setidaknya satu kali, ini mungkin bukan solusi terbaik untuk Anda.
Jika potensi hilangnya peristiwa log dapat diterima oleh Anda, maka ini mungkin solusi yang masuk akal bagi Anda.
Aplikasi ini ditujukan untuk skenario di mana aplikasi Anda dapat masuk ke protologbeat yang berjalan pada host fisik yang sama. Tidak disarankan menggunakan ini untuk logging lintas server/lintas wilayah/lintas pusat data.
Tanggal/waktu saat ini secara otomatis ditambahkan ke setiap entri log setelah diterima oleh protologbeat.
Mengingat ini dapat mencatat data dengan jenis bidang apa pun, disarankan agar Anda menambahkan nama dan jenis bidang yang diperlukan ke templat indeks protologbeat.template-es2x.json atau protologbeat.template.json ( ES 5.x ).

Klien Sampel

Silakan lihat direktori _samples/ untuk contoh klien dalam berbagai bahasa.

Persyaratan

Golang 1.7

Proyek Init

Untuk menjalankan Protologbeat dan juga menginstal dependensi, jalankan perintah berikut:

 make setup

Ini akan membuat riwayat git yang bersih untuk setiap langkah besar. Perhatikan bahwa Anda selalu dapat menulis ulang riwayat jika diinginkan sebelum melakukan perubahan.

Untuk mendorong Protologbeat di repositori git, jalankan perintah berikut:

 git remote set-url origin https://github.com/harfordfive/protologbeat
git push origin master

Untuk pengembangan lebih lanjut, lihat panduan pengembang beat.

Membangun

Untuk membangun biner untuk Protologbeat, jalankan perintah di bawah ini. Ini akan menghasilkan biner di direktori yang sama dengan nama protologbeat.

 make

Jika Anda ingin membuat biner untuk OSX, Linux dan/atau Windows, Anda dapat menjalankan perintah berikut:

 ./build-bin [TAG_VERSION]

Biner yang dihasilkan akan ditempatkan di direktori bin/

Berlari

Untuk menjalankan Protologbeat dengan keluaran debugging diaktifkan, jalankan:

 ./protologbeat -c protologbeat.yml -e -d "*"

Tes

Untuk menguji Protologbeat, jalankan perintah berikut:

 make testsuite

alternatifnya:

 make unit-tests
make system-tests
make integration-tests
make coverage-report

Cakupan pengujian dilaporkan dalam folder ./build/coverage/

Memperbarui

Setiap ketukan memiliki templat untuk pemetaan di elasticsearch dan dokumentasi untuk bidang yang dibuat secara otomatis berdasarkan etc/fields.yml . Untuk menghasilkanetc/protologbeat.template.json danetc/protologbeat.asciidoc

 make update

Pembersihan

Untuk membersihkan kode sumber Protologbeat, jalankan perintah berikut:

 make fmt
make simplify

Untuk membersihkan direktori build dan artefak yang dihasilkan, jalankan:

 make clean

Klon

Untuk mengkloning Protologbeat dari repositori git, jalankan perintah berikut:

 mkdir -p ${GOPATH}/github.com/harfordfive
cd ${GOPATH}/github.com/harfordfive
git clone https://github.com/harfordfive/protologbeat

Untuk pengembangan lebih lanjut, lihat panduan pengembang beat.

Berjalan di Docker

Anda dapat menemukan gambar Docker untuk irama ini di sini. Harap perhatikan bahwa penampung dimulai dengan konfigurasi dasar yang mendengarkan protokol/alamat/port default dan menerima pesan teks biasa. Untuk penyesuaian apa pun, harap ubah contoh konfigurasi protologbeat.full.yml dan buat file Docker Anda sendiri yang menimpa file asli.

Kemasan

Kerangka kerja beat menyediakan alat untuk mengkompilasi silang dan mengemas beat Anda untuk berbagai platform. Ini memerlukan buruh pelabuhan dan vendor seperti dijelaskan di atas. Untuk membuat paket sesuai keinginan Anda, jalankan perintah berikut: