Mengonfigurasi Pembaruan Otomatis

Gunakan file konfigurasi appsettings.json untuk mengaktifkan pembaruan otomatis Amazon Kinesis Agent for Microsoft Windows dan file konfigurasi untuk Kinesis Agent for Windows. Untuk mengontrol perilaku pembaruan, tentukan pasangan kunci-nilai Plugins di tingkat yang sama dalam file konfigurasi sebagai Sources, Sinks, dan Pipes.

Pasangan kunci-nilai Plugins menentukan fungsionalitas umum tambahan yang harus digunakan yang tidak termasuk dalam kategori sumber, sink, dan pipa. Misalnya, ada plugin untuk memperbarui Kinesis Agent for Windows, dan ada plugin untuk memperbarui file konfigurasi appsettings.json. Plugin direpresentasikan sebagai objek JSON dan selalu memiliki pasangan kunci-nilai Type. Type menentukan pasangan kunci-nilai lainnya yang dapat ditentukan untuk plugin. Tipe plugin berikut didukung:

PackageUpdate

Menentukan bahwa Kinesis Agent for Windows harus secara berkala memeriksa file konfigurasi versi paket. Jika file versi paket menunjukkan bahwa versi yang berbeda dari Kinesis Agent for Windows harus diinstal, maka Kinesis Agent for Windows mengunduh versi tersebut dan menginstalnya. Pasangan kunci-nilai plugin PackageUpdate mencakup:

Type

Nilai harus berupa string PackageUpdate, dan hal itu diperlukan.

Interval

Menentukan seberapa sering untuk memeriksa perubahan file versi paket dalam menit yang direpresentasikan sebagai string. Pasangan kunci-nilai ini opsional. Jika tidak ada nilai yang ditentukan, nilai defaultnya adalah 60 menit. Jika nilai kurang dari 1, tidak ada pemeriksaan pembaruan yang terjadi.

PackageVersion

Menentukan lokasi file JSON versi paket. File tersebut dapat berada di pembagian file (file://), situs web (http://), atau Amazon S3 (s3://). Misalnya, nilai s3://mycompany/config/agent-package-version.json menunjukkan bahwa Kinesis Agent for Windows harus memeriksa isi file config/agent-package-version.json di bucket Amazon S3 mycompany. Agen Kinesis untuk Windows harus melakukan pembaruan berdasarkan isi file tersebut.

catatan

Nilai dari pasangan kunci-nilai PackageVersion peka terhadap huruf besar-kecil untuk Amazon S3.

Berikut ini adalah contoh isi file versi paket:

{
    "Name": "AWSKinesisTap",
    "Version": "1.0.0.106",
    "PackageUrl": "https://s3-us-west-2.amazonaws.com/kinesis-agent-windows/downloads/AWSKinesisTap.{Version}.nupkg"
}                     

Pasangan kunci-nilai Version menentukan versi Kinesis Agent for Windows yang harus diinstal jika belum diinstal. Referensi variabel {Version} dalam PackageUrl menyelesaikan nilai yang Anda tentukan untuk pasangan kunci-nilai Version. Dalam contoh ini, variabel memutuskan untuk string 1.0.0.106. Resolusi variabel ini disediakan sehingga dapat ada satu tempat dalam file versi paket di mana versi tertentu yang diinginkan disimpan. Anda dapat menggunakan beberapa file versi paket untuk mengontrol laju peluncuran Kinesis Agent for Windows versi baru untuk memvalidasi versi baru sebelum deployment yang lebih besar. Untuk mengembalikan deployment Kinesis Agent for Windows, ubah satu atau beberapa file versi paket untuk menentukan versi yang lebih lawas dari Kinesis Agent for Windows yang diketahui berfungsi di lingkungan Anda.

Nilai dari pasangan kunci-nilai PackageVersion dipengaruhi oleh substitusi variabel untuk memfasilitasi pemilihan otomatis file versi paket yang berbeda. Untuk informasi selengkapnya tentang substitusi variabel, lihat Mengonfigurasi Substitusi Variabel Sink.

AccessKey

Menentukan access key yang digunakan saat autentikasi akses ke file versi paket di Amazon S3. Pasangan kunci-nilai ini opsional. Kami tidak merekomendasikan penggunaan pasangan kunci-nilai ini. Untuk pendekatan autentikasi alternatif yang direkomendasikan, lihat Mengonfigurasi Autentikasi.

SecretKey

Menentukan kunci rahasia yang harus digunakan saat autentikasi akses ke file versi paket di Amazon S3. Pasangan kunci-nilai ini opsional. Kami tidak merekomendasikan penggunaan pasangan kunci-nilai ini. Untuk pendekatan autentikasi alternatif yang direkomendasikan, lihat Mengonfigurasi Autentikasi.

Region

Menentukan titik akhir Wilayah yang harus digunakan ketika mengakses file versi paket dari Amazon S3. Pasangan kunci-nilai ini opsional.

ProfileName

Menentukan profil keamanan yang harus digunakan saat autentikasi akses ke file versi paket di Amazon S3. Untuk informasi lebih lanjut, lihat Mengonfigurasi Autentikasi. Pasangan kunci-nilai ini opsional.

RoleARN

Menentukan peran yang harus diambil ketika autentikasi akses ke file versi paket di Amazon S3 dalam skenario lintas akun. Untuk informasi lebih lanjut, lihat Mengonfigurasi Autentikasi. Pasangan kunci-nilai ini opsional.

Jika tidak ada plugin PackageUpdate yang ditentukan, maka tidak ada file versi paket yang diperiksa untuk menentukan apakah pembaruan diperlukan.

ConfigUpdate

Menentukan bahwa Kinesis Agent for Windows harus secara berkala memeriksa file konfigurasi appsettings.json yang diperbarui yang disimpan di pembagian file, situs web, atau Amazon S3. Jika ada file konfigurasi yang diperbarui, file tersebut akan diunduh dan diinstal oleh Kinesis Agent for Windows. Pasangan kunci-nilai ConfigUpdate mencakup hal berikut:

Type

Nilai harus berupa string ConfigUpdate, dan hal itu diperlukan.

Interval

Menentukan seberapa sering untuk memeriksa file konfigurasi baru dalam menit yang direpresentasikan sebagai string. Pasangan kunci-nilai ini opsional, dan jika tidak ditentukan, defaultnya adalah 5 menit. Jika nilainya kurang dari 1, maka pembaruan file konfigurasi tidak diperiksa.

Source

Menentukan lokasi untuk mencari file konfigurasi yang diperbarui. File tersebut dapat berada di pembagian file (file://), situs web (http://), atau Amazon S3 (s3://). Misalnya, nilai s3://mycompany/config/appsettings.json menunjukkan bahwa Kinesis Agent for Windows harus memeriksa pembaruan untuk file config/appsettings.json di bucket Amazon S3 mycompany.

catatan

Nilai dari pasangan kunci-nilai Source peka terhadap huruf besar-kecil untuk Amazon S3.

Nilai dari pasangan kunci-nilai Source dipengaruhi oleh substitusi variabel untuk memfasilitasi pemilihan otomatis file konfigurasi yang berbeda. Untuk informasi selengkapnya tentang substitusi variabel, lihat Mengonfigurasi Substitusi Variabel Sink.

Destination

Menentukan lokasi untuk menyimpan file konfigurasi pada mesin lokal. Ini bisa berupa jalur relatif, jalur absolut, atau jalur yang berisi referensi variabel lingkungan seperti %PROGRAMDATA%. Jika jalurnya relatif, jalur relatif terhadap lokasi tempat Kinesis Agent for Windows diinstal. Biasanya nilai harus .\appsettings.json. Pasangan kunci-nilai ini wajib diisi.

AccessKey

Menentukan access key yang harus digunakan saat autentikasi akses ke file konfigurasi di Amazon S3. Pasangan kunci-nilai ini opsional. Kami tidak merekomendasikan penggunaan pasangan kunci-nilai ini. Untuk pendekatan autentikasi alternatif yang direkomendasikan, lihat Mengonfigurasi Autentikasi.

SecretKey

Menentukan kunci rahasia yang harus digunakan saat autentikasi akses ke file konfigurasi di Amazon S3. Pasangan kunci-nilai ini opsional. Kami tidak merekomendasikan penggunaan pasangan kunci-nilai ini. Untuk pendekatan autentikasi alternatif yang direkomendasikan, lihat Mengonfigurasi Autentikasi.

Region

Menentukan titik akhir Wilayah yang harus digunakan saat mengakses file konfigurasi dari Amazon S3. Pasangan kunci-nilai ini opsional.

ProfileName

Menentukan profil keamanan yang harus digunakan saat autentikasi akses ke file konfigurasi di Amazon S3. Untuk informasi lebih lanjut, lihat Mengonfigurasi Autentikasi. Pasangan kunci-nilai ini opsional.

RoleARN

Menentukan peran yang harus diambil ketika autentikasi akses ke file konfigurasi di Amazon S3 dalam skenario lintas akun. Untuk informasi lebih lanjut, lihat Mengonfigurasi Autentikasi. Pasangan kunci-nilai ini opsional.

Jika tidak ada plugin ConfigUpdate yang ditentukan, maka tidak ada file konfigurasi yang diperiksa untuk menentukan apakah pembaruan file konfigurasi diperlukan.

Berikut ini adalah contoh file konfigurasi appsettings.json yang menunjukkan menggunakan plugin PackageUpdate dan ConfigUpdate. Dalam contoh ini, ada file versi paket yang terletak di bucket Amazon S3 mycompany bernama config/agent-package-version.json. File ini diperiksa perubahannya kira-kira setiap 2 jam. Jika versi yang berbeda dari Kinesis Agent for Windows ditentukan dalam file versi paket, versi agen yang ditentukan diinstal dari lokasi yang ditentukan dalam file versi paket.

Selain itu, ada file konfigurasi appsettings.json yang disimpan dalam bucket Amazon S3 mycompany bernama config/appsettings.json. Kira-kira setiap 30 menit, file tersebut dibandingkan dengan file konfigurasi saat ini. Jika keduanya berbeda, file konfigurasi yang diperbarui diunduh dari Amazon S3 dan diinstal ke lokasi lokal yang biasanya untuk file konfigurasi appsettings.json.

{
  "Sources": [
    {
      "Id": "ApplicationLogSource",
      "SourceType": "DirectorySource",
      "Directory": "C:\\LogSource\\",
      "FileNameFilter": "*.log",
      "RecordParser": "SingleLine"
    }
  ],
  "Sinks": [
    {
       "Id": "ApplicationLogKinesisFirehoseSink",
       "SinkType": "KinesisFirehose",
       "StreamName": "ApplicationLogFirehoseDeliveryStream",
       "Region": "us-east-1"
    }  
    ],
  "Pipes": [
    {
      "Id": "ApplicationLogSourceToApplicationLogKinesisFirehoseSink",
      "SourceRef": "ApplicationLogSource",
      "SinkRef": "ApplicationLogKinesisFirehoseSink"
    }
  ],
  "Plugins": [
    {
      "Type": "PackageUpdate"
      "Interval": "120",
      "PackageVersion": "s3://mycompany/config/agent-package-version.json"
    },
    {
      "Type": "ConfigUpdate",
      "Interval": "30", 
      "Source": "s3://mycompany/config/appsettings.json",
      "Destination": ".\appSettings.json"      
    }
  ]
}