MonitoringPlugin tr TR

MonitoringPlugin

MonitoringPlugin, ASF'nin resmi plugin'idir ve Prometheus zaman serisi veritabanı aracılığıyla ASF sürecini izlemenizi sağlar.

---

Ekran Görüntüleri

Göster

---

Gereksinimler

Teknik kısıtlamalar nedeniyle, bu eklenti generic varyantındaki ASF'yi gerektirir.

---

Enabling the plugin

ASF varsayılan olarak MonitoringPlugin ile birlikte gelmez, ancak her ASF sürümünde isteğe bağlı bir ek olarak dahil edilmiştir. Eklentiyi, ASF sürümünüzle uyumlu olan resmi yayın'den indirin, ardından eklenti için özel bir plugins/ArchiSteamFarm.OfficialPlugins.Monitoring dizini oluşturun ve arşivi buraya çıkartın.

ASF'nin bir sonraki başlatılmasında, günlükler eklentinin başarılı bir şekilde yüklendiğini standart ASF günlükleme mekanizması aracılığıyla belirtecektir. Ayrıca, /Api/metrics URL'sine IPC arayüzünüzden erişerek bunu doğrulayabilirsiniz. IPC şifresi kullanıyorsanız, uygun yetkilendirme gerektiğinden, /Api/metrics URL'sine ?password=<YourIPCPassword> eklemeniz gerekecektir. Görüntülediğiniz içerik aşağıdakine benzer olmalıdır:

# TYPE asf_build_info gauge
# HELP asf_build_info Build information about ASF in form of label values
asf_build_info{variant="source",version="6.0.2.5"} 1 1713715703686

# TYPE asf_runtime_info gauge
# HELP asf_runtime_info Runtime information about ASF in form of label values
asf_runtime_info{framework=".NET 8.0.4",operating_system="Debian GNU/Linux trixie/sid",runtime="linux-x64"} 1 1713715703686
(...)

ASF ve botlarla ilgili metrikler, adlarında asf_ öneki ile özel olarak belirlenmiştir. Diğer metrikler (örneğin .NET runtime veya ASF'nin HttpClient'ı ile ilgili olanlar), evrensel .NET süreç kurallarına dayalı olarak otomatik olarak üretilir ve bu tür bir öneki taşımaz.

---

Prometheus Yapılandırması

Eklentinin düzgün çalıştığını doğruladıktan sonra, Prometheus örneğinize aşağıdaki gibi bir scrape yapılandırması ekleyebilirsiniz:

scrape_configs:
  - job_name: ArchiSteamFarm
    metric_name_escaping_scheme: underscores # Remove if using Prometheus V2.x - read more below
    metrics_path: /Api/metrics
    params:
      password:
        - YourIPCPassword
    static_configs:
      - targets:
          - 127.0.0.1:1242

Doğal olarak, barındırılan Prometheus örneğinizin ASF'nin IPC arayüzüne erişebildiğinden emin olmanız gerekir, password ve targets'ı kullanımınıza göre uyarlayın. IPC şifreniz ayarlı değilse (bu önerilmez), params bölümünü eklemeyi atlayabilirsiniz. Birden fazla ASF örneği çalıştırıyorsanız ve farklı IPC şifreleri kullanıyorsanız, ek scrape yapılandırmaları ekleyebilirsiniz; her örnek için bir tane. Aksi takdirde, aynı şifreyi paylaşan birkaç targets'ı belirtebilirsiniz.

---

Grafana Panosu

Metrikleriniz Prometheus tarafından toplandıktan sonra, Grafana kullanarak görselleştirme yapabilirsiniz. Bu nedenle, ASF örneğinizi varsayılan ayarlarla çalıştırdığınızı varsayarak, dosyayı buradan indirebilirsiniz. Alternatif olarak, JSON dosyasını repository'dan da alabilirsiniz.

---

Prometheus, Grafana dashboard and metrics escaping scheme

ASF supports various metrics escaping schemes since V6.3.8.4, with unified, complete solution starting from V6.3.9.4 (as part of #3607).

This unfortunately causes a slight issue in regards to our Grafana dashboard, since for that to work you need precise metric names as parsed by Prometheus, and that software behaves in two different ways by default depending on whether you use V2.x or V3.x version of it. See UTF-8 Prometheus docs for more info.

While waiting for Prometheus V3.x to get widely adopted (with debian stable as current guideline), we recommend legacy approach, that is:

• Our Grafana dashboard comes with underscore names by default, that are recognized by Prometheus V2.x
• Use metric_name_escaping_scheme: underscores as part of ASF scrape config (as in example above), if using Prometheus V3.x

This is because, while Prometheus V3.x can be easily configured to use the legacy approach, Prometheus V2.x has no such job-specific option to force the new one to be used.

In the future, we'll likely refactor our Grafana dashboard to use the new recommended defaults, and the setting will no longer be required. Today doing that would cause issues for older Prometheus users, which is not warranted.

Of course, the plugin in ASF itself supports all different formatting options, so you can always pick the one you like and adapt the Grafana dashboard to it yourself - we're just making it easier for you with a simple one-line config change recommendation.