MonitoringPlugin pt PT

MonitoringPlugin

MonitoringPlugin é um ASF oficial plugin, o que permite monitorar o processo do ASF através de Prometheus banco de dados de séries de tempo.

---

Screenshots

Mostrar

---

Requisitos

Devido a restrições técnicas, este plugin requer a variante genérica do ASF.

---

Ativando o plugin

O ASF não vem com o MonitoringPlugin agrupado por padrão, no entanto, ele está incluso como adição opcional toda vez que ele for lançado pelo ASF. Baixe o plugin do oficialrelease** que corresponde à sua versão do ASF, então crie um plugins/ArchiSteamFarm dedicado. Diretório fficialPlugins.Monitorando para o plugin e finalmente extrair o arquivo lá.

Na próxima inicialização do ASF, os logs indicarão que o plugin foi carregado com sucesso através do mecanismo padrão de registro do ASF. Você também pode verificar isso navegando até a URL /Api/metrics na sua interface IPC. Se você está usando a senha IPC, você precisará de autorização adequada, acrescentando ?password=<YourIPCPassword> à URL /Api/metrics. O conteúdo que você vê deve se parecer com o mesmo conteúdo abaixo:

# TYPE asf_build_info gauge
# HELP asf_build_info Build informações sobre o ASF em forma de rótulo valores
asf_build_info{variant="source",version="6.0.2. "} 1 1713715703686

# TYPE asf_runtime_info gauge
# HELP asf_runtime_info Runtime sobre o ASF no formato dos valores de rótulo
asf_runtime_info{framework=". ET 8.0.4",operating_system="Trixame do GNU/Linux",runtime="linux-x64"} 1 1713715703686
(...)

Métricas do ASF e os bots dedicaram o prefixo asf_ em seus nomes. Outras métricas, por exemplo, sobre o tempo de execução .NET ou o HttpClient do ASF são geradas automaticamente com base nas regras de processo .NET universais e não carregam esse prefixo.

---

Configuração do Prometheus

Uma vez que você verificou que o plugin está funcionando corretamente, você pode adicionar uma configuração scrape para sua Prometheus como tal:

scrape_configs:
  - job_name: ArchiSteamFarm
    metric_name_escaping_scheme: underscores # Remova se estiver usando Prometheus V2. - leia mais abaixo
    metrics_path: /Api/metrics
    params:
      senha:
        - YourIPCPassword
    static_configs:
      - alvos:
          - 127. .0.1:1242

Naturalmente, você precisa garantir que sua instância hospedada Prometheus seja capaz de acessar a interface IPC do ASF, adaptar password e alvo de acordo com sua utilização. Se você não tem a definição de senha IPC (o que não é recomendado), você pode pular a adição da seção params. Caso você esteja executando várias instâncias do ASF com diferentes senhas IPC, você pode adicionar configurações adicionais de scrape um por exemplo, já que os parâmetros de consulta não podem ser definidos para uma base por destino. Caso contrário, você pode declarar vários alvos se eles compartilharem a mesma senha.

---

Painel do Grafana

Uma vez que suas métricas são coletadas por Prometheus, é possível usar Grafana para visualização. A extensão vem com /grafana-dashboard. arquivo son servido pelos mecanismos padrão do IPC, então assumindo que você está executando sua instância ASF com as configurações padrão você pode baixá-lo here. Como alternativa, você também pode pegar o arquivo JSON do nosso repository também.

---

Prometheus, painel Grafana e sistema de métricas para escapar

O ASF suporta várias métricas escapando desde V6.3.8.4, com uma solução completa e unificada, começando em V6.3.9.4 (como parte de #3607).

Infelizmente, isto causa uma ligeira questão no que se refere ao nosso painel de controlo do Grafana. para que isso funcione você precisa de nomes métricos precisos, como analisado pelo Prometheus, e esse software se comporta de duas maneiras diferentes por padrão, dependendo se você usa o V2. Versão ou V3.x dela. Veja UTF-8 Prometheus docs para mais informações.

Enquanto esperamos que Prometheus V3.x seja amplamente adotado (com debian estável como o guia atual), recomendamos a abordagem antiga, que é:

• Nosso painel Grafana vem com nomes de sublinhado por padrão, que são reconhecidos pelo Prometheus V2.x
• Use metric_name_escaping_scheme: underscores como parte da configuração de scrape do ASF (como por exemplo acima), se usando Prometheus V3.x

Isto porque, enquanto Prometheus V3.x pode ser facilmente configurado para usar a abordagem legada, Prometheus V2. não tem uma opção de emprego tão específica para forçar o novo a ser usado.

No futuro, iremos provavelmente refatorar nosso painel Grafana para usar os novos padrões recomendados, e a configuração não será mais necessária. Hoje, isso causaria problemas aos mais velhos utilizadores Prometeus, o que não se justifica.

Claro, o plugin no ASF suporta todas as diferentes opções de formatação, então você sempre pode escolher qual quiser e adaptar o painel do Grafana a ele mesmo - só estamos facilitando o processo com uma recomendação simples de configuração em uma linha.