Ir para o conteúdo

Horse Logger: Provider LogFile

O Horse Logger: Provider LogFile é um provedor oficial para o middleware horse-logger para imprimir os logs em suas APIs, em um arquivo físico.

⭕ Pré-requisitos

horse-logger - Horse Logger é um middleware para você registrar logs em suas APIs.

horse-utils-clientip - Horse Utils Client IP é um middleware para você capturar o IP dos Clientes em suas APIs.

Obs: Se você usa Boss (gerenciador de dependências para Delphi), o Horse Logger e o horse-utils-clientip serão instalados automaticamente ao instalar o horse-logger-provider-console.

⚙️ Instalação

Você pode instalar facilmente utilizando o comando boss install:

boss install horse-logger-provider-logfile

Ou, se você preferir instalar manualmente, basta adicionar as pastas em seu projeto, em Project > Options > Resource Compiler > Directories and Conditionals > Include file search path:

../horse-logger-provider-logfile/src

✔️ Compatibilidade

Delphi Lazarus
  ✔️    ✔️

🔠 Formatação

Você pode formatar a saída do log:

Padrão: ${request_clientip} [${time}] ${request_user_agent} "${request_method} ${request_path_info} ${request_version}" ${response_status} ${response_content_length}

Valores possíveis: time,time_short,execution_time,request_clientip,request_method,request_version,request_url,request_query,request_path_info,request_path_translated,request_cookie,request_accept,request_from,request_host,request_referer,request_user_agent,request_connection,request_derived_from,request_remote_addr,request_remote_host,request_script_name,request_server_port,request_remote_ip,request_internal_path_info,request_raw_path_info,request_cache_control,request_script_name,request_authorization,request_content_encoding,request_content_type,request_content_length,request_content_version,request_content,response_version,response_reason,response_server,response_realm,response_allow,response_location,response_log_message,response_title,response_content_encoding,response_content_type,response_content_length,response_content_version,response_content,response_status

🤙 Exemplos de Uso

uses
  Horse,
  Horse.Logger, // Esta unit é necessária
  Horse.Logger.Provider.LogFile, // Esta unit é necessária
  System.SysUtils;

var
  LLogFileConfig: THorseLoggerLogFileConfig;

begin
  LLogFileConfig := THorseLoggerLogFileConfig.New
    .SetLogFormat('${request_clientip} [${time}] ${response_status}')
    .SetDir('D:\Servidores\Log');

  // Você também pode especificar o formato do log e o diretório que ele vai ser salvo:
  // THorseLoggerManager.RegisterProvider(THorseLoggerProviderLogFile.New(LLogFileConfig));

  // Aqui você definirá o provedor que será usado.
  THorseLoggerManager.RegisterProvider(THorseLoggerProviderLogFile.New());

  // Necessário para adicionar o Middleware no Horse:
  THorse.Use(THorseLoggerManager.HorseCallback);

  THorse.Get('/ping',
    procedure(Req: THorseRequest; Res: THorseResponse; Next: TProc)
    begin
      Res.Send('pong');
    end);

  THorse.Listen(9000);
end;

{$MODE DELPHI}{$H+}

uses
  {$IFDEF UNIX}{$IFDEF UseCThreads}
  cthreads,
  {$ENDIF}{$ENDIF}
  Horse,
  Horse.Logger, // Esta unit é necessária
  Horse.Logger.Provider.LogFile, // Esta unit é necessária
  SysUtils;

var
  LLogFileConfig: THorseLoggerLogFileConfig;

procedure GetPing(Req: THorseRequest; Res: THorseResponse; Next: TNextProc);
begin
  Res.Send('Pong');
end;

begin
  LLogFileConfig := THorseLoggerLogFileConfig.New
    .SetLogFormat('${request_clientip} [${time}] ${response_status}')
    .SetDir('D:\Servidores\Log');

  // Você também pode especificar o formato do log e o diretório que ele vai ser salvo:
  THorseLoggerManager.RegisterProvider(THorseLoggerProviderLogFile.New(LLogFileConfig));

  // Aqui você definirá o provedor que será usado.
  // THorseLoggerManager.RegisterProvider(THorseLoggerProviderLogFile.New());

  // Necessário para adicionar o Middleware no Horse:
  THorse.Use(THorseLoggerManager.HorseCallback);

  THorse.Get('/ping');

  THorse.Listen(9000, OnListen);
end.

📝 Exemplos de Saída

Usando a opção de formatação padrão de log, a saída será algo assim:

0:0:0:0:0:0:0:1 [06/outubro/2021 10:34:53.949] PostmanRuntime/7.28.4 "GET /ping HTTP/1.1" 200 4
0:0:0:0:0:0:0:1 [06/outubro/2021 10:34:55.842] PostmanRuntime/7.28.4 "GET /ping HTTP/1.1" 200 4
0:0:0:0:0:0:0:1 [06/outubro/2021 10:34:56.887] PostmanRuntime/7.28.4 "GET /ping HTTP/1.1" 200 4
0:0:0:0:0:0:0:1 [06/outubro/2021 10:35:24.458] PostmanRuntime/7.28.4 "GET /ping HTTP/1.1" 200 4
0:0:0:0:0:0:0:1 [06/outubro/2021 10:35:31.638] PostmanRuntime/7.28.4 "GET /ping HTTP/1.1" 200 4
0:0:0:0:0:0:0:1 [06/outubro/2021 10:35:32.685] PostmanRuntime/7.28.4 "GET /ping HTTP/1.1" 200 4
0:0:0:0:0:0:0:1 [06/outubro/2021 10:35:33.590] PostmanRuntime/7.28.4 "GET /ping HTTP/1.1" 200 4

⚠️ Avisos