Utilitas pemantauan dan pengumpulan diagnostik (dotnet-monitor)

Artikel ini berlaku untuk: ✔️ dotnet-monitor versi 6.0.0 dan versi yang lebih baru

Instal

Ada dua cara untuk mengunduh dotnet-monitor:

• alat global dotnet:

  Untuk menginstal versi rilis terbaru paket dotnet-monitorNuGet, gunakan perintah penginstalan alat dotnet:

  dotnet tool install --global dotnet-monitor
  

• Gambar Docker:

  Unduh gambar Docker untuk digunakan di lingkungan multi-kontainer:

  docker pull mcr.microsoft.com/dotnet/monitor
  

Sinopsis

dotnet-monitor [-h|--help] [--version] <command>

Deskripsi

Alat dotnet-monitor global adalah cara untuk memantau aplikasi .NET di lingkungan produksi dan mengumpulkan artefak diagnostik (misalnya, cadangan, jejak, log, dan metrik) sesuai permintaan atau menggunakan aturan otomatis untuk dikumpulkan dalam kondisi yang ditentukan.

Opsi

• --version

  Menampilkan versi utilitas dotnet-monitor.

• -h|--help

  Tampilkan bantuan baris perintah.

Perintah

dotnet-monitor collect

Pantau aplikasi .NET, izinkan pengumpulan artefak diagnostik, dan kirim hasilnya ke tujuan yang dipilih.

Sinopsis

dotnet-monitor collect [-h|--help] [-u|--urls] [-m|--metrics] [--metricUrls] [--diagnostic-port] [--no-auth] [--temp-apikey] [--no-http-egress]

Opsi

• -h|--help

  Tampilkan bantuan baris perintah.

• -u|--urls <urls>

  Pengikatan untuk api HTTP. Defaultnya adalah https://localhost:52323.

• -m|--metrics [true|false]

  Aktifkan penerbitan metrik untuk dirutekan /metrics . Standarnya adalah true

• --metricUrls <urls>

  Pengikatan untuk metrik API HTTP. Defaultnya adalah http://localhost:52325.

• --diagnostic-port <path>

  Jalur dan nama file port diagnostik yang sepenuhnya memenuhi syarat yang dapat disambungkan oleh instans runtime. Menentukan tempat dotnet-monitor opsi ini ke mode 'dengarkan'. Ketika tidak ditentukan, dotnet-monitor berada dalam mode 'sambungkan'.

  Pada Windows, ini haruslah nama pipa bernama yang valid. Di Linux dan macOS, ini harus merupakan jalur Soket Domain Unix yang valid.

• --no-auth

  Menonaktifkan autentikasi kunci API. Defaultnya adalah false.

  Sangat disarankan agar opsi ini tidak digunakan di lingkungan produksi.

• --temp-apikey

  Menghasilkan kunci API sementara untuk dotnet-monitor instans.

• --no-http-egress

  Menonaktifkan keluarnya artefak diagnostik melalui respons HTTP. Ketika ditentukan, artefak harus keluar menggunakan penyedia keluar.

dotnet-monitor config show

Menampilkan konfigurasi, seolah-olah dotnet-monitor collect dijalankan dengan parameter ini.

Sinopsis

dotnet-monitor config show [-h|--help] [-u|--urls] [-m|--metrics] [--metricUrls] [--diagnostic-port] [--no-auth] [--temp-apikey] [--no-http-egress] [--level] [--show-sources]

Opsi

• -h|--help

  Tampilkan bantuan baris perintah.

• -u|--urls <urls>

  Pengikatan untuk api HTTP. Defaultnya adalah https://localhost:52323.

  Nilai ini dipetakan ke dalam konfigurasi sebagai urls kunci.

• -m|--metrics [true|false]

  Aktifkan penerbitan metrik untuk dirutekan /metrics . Defaultnya adalah true.

  Nilai ini dipetakan ke dalam konfigurasi sebagai Metrics:Enabled kunci.

• --metricUrls <urls>

  Pengikatan untuk metrik API HTTP. Defaultnya adalah http://localhost:52325.

  Nilai ini dipetakan ke dalam konfigurasi sebagai Metrics:Endpoints kunci.

• --diagnostic-port <path>

  Jalur dan nama file port diagnostik yang sepenuhnya memenuhi syarat yang dapat disambungkan oleh instans runtime. Menentukan tempat dotnet-monitor opsi ini ke mode 'dengarkan'. Ketika tidak ditentukan, dotnet-monitor berada dalam mode 'sambungkan'.

  Pada Windows, ini haruslah nama pipa bernama yang valid. Di Linux dan macOS, ini harus merupakan jalur Soket Domain Unix yang valid.

  Nilai ini dipetakan ke dalam konfigurasi sebagai DiagnosticPort:EndpointName kunci.

• --no-auth

  Menonaktifkan autentikasi kunci API. Defaultnya adalah false.

  Sangat disarankan agar opsi ini tidak digunakan di lingkungan produksi.

  Nilai ini tidak dipetakan ke dalam konfigurasi.

• --temp-apikey

  Menghasilkan kunci API sementara untuk dotnet-monitor instans.

  Nilai ini dipetakan ke dalam konfigurasi sebagai Authentication:MonitorApiKey kunci.

• --no-http-egress

  Menonaktifkan keluarnya artefak diagnostik melalui respons HTTP. Ketika ditentukan, artefak harus keluar menggunakan penyedia keluar.

  Nilai ini tidak dipetakan ke dalam konfigurasi.

• --level

  Tingkat konfigurasi. Full konfigurasi dapat menampilkan informasi sensitif. Ada dua tingkat:

  • Full - Konfigurasi lengkap tanpa redaksi nilai apa pun.
  • Redacted - Konfigurasi lengkap tetapi informasi sensitif, seperti rahasia yang diketahui, diredaksi.

• --show-sources

  Mengidentifikasi dari sumber konfigurasi mana setiap nilai konfigurasi efektif disediakan.

dotnet-monitor generatekey

Buat kunci API dan hash untuk autentikasi HTTP.

Sinopsis

dotnet-monitor generatekey [-h|--help] [-o|--output] [-e|--expiration]

Opsi

• -h|--help

  Tampilkan bantuan baris perintah.

• -o|--output <Cmd|Json|MachineJson|PowerShell|Shell|Text>

  Format output di mana informasi kunci API ditulis ke output standar.

  Nilai yang diizinkan adalah:

  • Cmd - Output dalam format yang dapat digunakan di Windows Command Prompt atau file batch.
  • Json - Output dalam format objek JSON.
  • MachineJson - Output dalam format objek JSON tanpa komentar dan penjelasan. Berguna untuk skenario otomatisasi.
  • PowerShell - Output dalam format yang dapat digunakan dalam perintah dan skrip PowerShell.
  • Shell - Output dalam format yang dapat digunakan di shell Linux seperti Bash.
  • Text - Output dalam format yang merupakan teks biasa.

• -e|--expiration <expiration>

  Waktu kedaluwarsa setelah kunci API yang dihasilkan tidak akan lagi diterima. Nilai harus dalam format TimeSpan (misalnya, "7.00:00:00" selama 7 hari). Default: "7.00:00:00" (7 hari).

Lihat juga

• dotnet/dotnet-monitor