Como usar o ASP.NET ou chamar a API

Existem três maneiras de usar a biblioteca de cliente do Cloud Logging:

Opção 1: usar uma integração básica do ASP.NET

O Google.Cloud.Diagnostics.AspNetCore é uma biblioteca que envia os registros padrão do ASP.NET para o Cloud Logging.

Para iniciar a geração de registros usando o Google.Cloud.Diagnostics.AspNetCore, instale a biblioteca com um destes comandos:

Administrador de pacotes

PM> Install-Package Google.Cloud.Diagnostics.AspNetCore

CLI do .NET

> dotnet add package Google.Cloud.Diagnostics.AspNetCore

Em seguida, edite o arquivo Startup.cs com as seguintes alterações:

  1. Adicione o seguinte usando as instruções na parte superior do Startup.cs:

    logging/api/AspNetCore/Startup.cs
    
using Google.Cloud.Diagnostics.AspNetCore;
using Microsoft.Extensions.Logging;

  2. Modifique a função Configure. Adicione um ILoggerFactory loggerFactory e uma chamada para loggerFactory.AddGoogle("YOUR-PROJECT-ID"):

    logging/api/AspNetCore/Startup.cs
    public void Configure(IApplicationBuilder app, IHostingEnvironment env,
    ILoggerFactory loggerFactory)
{
    // Log to Google.
    loggerFactory.AddGoogle(app.ApplicationServices, "YOUR-PROJECT-ID");

  3. Compile e execute o código no Visual Studio. Consulte as entradas de registro no recurso Global do Explorador de registros.

    Acessar o Explorador de registros

Opção 2: usar uma integração do Log4Net

Log4Net (em inglês) é uma biblioteca Apache que permite a emissão de log statements para uma variedade de destinos de saída.

Para iniciar o registro usando a integração do Log4Net, instale a biblioteca Google.Cloud.Logging.Log4Net com este comando:

    PM> Install-Package Google.Cloud.Logging.Log4Net

Em seguida, faça o seguinte:

  1. Adicione uma seção de configuração XML do Log4Net ao arquivo Web.config do aplicativo da Web contendo o seguinte código:

    logging/api/Log4Net/Web.config
    <configuration>
  <configSections>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
  </configSections>
  <log4net>
    <appender name="CloudLogger" type="Google.Cloud.Logging.Log4Net.GoogleStackdriverAppender,Google.Cloud.Logging.Log4Net">
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%-4timestamp [%thread] %-5level %logger %ndc - %message" />
      </layout>
      <projectId value="YOUR-PROJECT-ID" />
      <logId value="mySampleLog" />
    </appender>
    <root>
      <level value="ALL" />
      <appender-ref ref="CloudLogger" />
    </root>
  </log4net>

  2. Adicione a seguinte linha de código ao arquivo Global.asax.cs (em inglês) do aplicativo para configurar o Log4net e usar o Logging:

    log4net.Config.XmlConfigurator.Configure();

    Depois de adicionar a linha anterior ao código, altere o método Application_Start() em Global.asax.cs para o seguinte:

    logging/api/Log4Net/Global.asax.cs
            protected void Application_Start()
        {
            GlobalConfiguration.Configure(WebApiConfig.Register);

            // Configure log4net to use Stackdriver logging from the XML configuration file.
            log4net.Config.XmlConfigurator.Configure();
        }

  3. Para usar o log4net no código do aplicativo, adicione a seguinte instrução para incluir a biblioteca de cliente:

    using log4net;

  4. Adicione o código a seguir ao aplicativo para gravar registros que serão exibidos no recurso Global do Explorador de registros. O nome do registro é especificado no arquivo Web.config:

    logging/api/Log4Net/App_Start/WebApiConfig.cs
                        // Retrieve a logger for this context.
                    ILog log = LogManager.GetLogger(typeof(WebApiConfig));

                    // Log some information to Google Stackdriver Logging.
                    log.Info("Hello World.");

  5. Compile e execute o código no Visual Studio. Consulte as entradas de registro no Visualizador de registros do Logging no recurso Global.

    Acessar o Explorador de registros

Opção 3: gravar registros personalizados usando a API Logging

Também é possível gravar registros personalizados chamando diretamente a API Cloud Logging.

Para iniciar o registro usando o Google.Cloud.Logging.V2, instale a biblioteca com um destes comandos:

Administrador de pacotes

PM> Install-Package Google.Cloud.Logging.V2

CLI do .NET

> dotnet add package Google.Cloud.Logging.V2

Depois que o cliente do Logging estiver instalado, será possível começar a enviar os registros do aplicativo para o Logging adicionando as seguintes instruções ao código do aplicativo:

using Google.Cloud.Logging.V2;
using Google.Cloud.Logging.Type;
using Google.Cloud.Api;

Personalize o seguinte método e o adicione ao código do aplicativo:

logging/api/LoggingSample/Program.cs
private void WriteLogEntry(string logId, string message)
{
    var client = LoggingServiceV2Client.Create();
    LogName logName = new LogName(s_projectId, logId);
    LogEntry logEntry = new LogEntry
    {
        LogName = logName.ToString(),
        Severity = LogSeverity.Info,
        TextPayload = $"{typeof(LoggingSample).FullName} - {message}"
    };
    MonitoredResource resource = new MonitoredResource { Type = "global" };
    IDictionary<string, string> entryLabels = new Dictionary<string, string>
    {
        { "size", "large" },
        { "color", "red" }
    };
    client.WriteLogEntries(LogNameOneof.From(logName), resource, entryLabels,
        new[] { logEntry }, _retryAWhile);
    Console.WriteLine($"Created log entry in log-id: {logId}.");
}

Escreva algum código de geração de registros que chame WriteLogEntry(). A entrada de registro resultante estará no recurso Global do Explorador de registros:

Acessar o Explorador de registros

Para mais detalhes sobre o Explorador de registros, consulte Como usar o Explorador de registros.