ASP.NET の使用と API の呼び出し

Cloud Logging クライアント ライブラリを使用するには、次の 3 つの方法があります。

オプション 1: ASP.NET Core 統合を使用する

Google.Cloud.Diagnostics.AspNetCore は、標準の ASP.NET ログを Cloud Logging に送信するライブラリです。

Google.Cloud.Diagnostics.AspNetCore を使用してロギングを開始するには、次のコマンドのいずれかを使用してライブラリをインストールします。

パッケージ マネージャ

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

.NET CLI

> dotnet add package Google.Cloud.Diagnostics.AspNetCore --version 2.0.1

次に、Startup.cs ファイルに次の変更を加えます。

  1. 次の using ステートメントを Startup.cs の先頭に追加します。

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

  2. Configure 関数を変更します。ILoggerFactory loggerFactory を追加して、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. Visual Studio でコードをコンパイルして実行します。Cloud Logging のログビューアの Global リソースの下にログエントリが表示されていることを確認します。

    ログビューアに移動

オプション 2: Log4Net 統合を使用する

Log4Net は Apache ライブラリで、ログ ステートメントをさまざまな出力先に出力できます。

Log4Net 統合を使用して Logging を開始するには、次のコマンドで Google.Cloud.Logging.Log4Net ライブラリをインストールします。

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

次に、以下の操作を行います。

  1. ウェブアプリケーションの、次のコードを含む Web.config ファイルに Log4Net XML 構成セクションを追加します。

    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. Logging を使用するように Log4net を構成するには、アプリケーションの Global.asax.cs ファイルに次のコードの行を追加します。

    log4net.Config.XmlConfigurator.Configure();

    前の行をコードに追加したら、Global.asax.cs の Application_Start() メソッドを次のように変更します。

    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. log4net をアプリケーション コードで使用するには、以下のステートメントを追加してクライアント ライブラリを含めます。

    using log4net;

  4. 次のコードをアプリケーションに追加し、Globalリソースの下の Google Cloud オペレーション スイートのログビューアに表示されるログを書き込みます。ログ名は、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. Visual Studio でコードをコンパイルして実行します。Logging のログビューアの Global リソースの下にログエントリが表示されていることを確認します。

    ログビューアに移動

オプション 3: Logging API を使用してカスタムログを書き込む

代わりに、Cloud Logging API を直接呼び出してカスタムログを書き込むこともできます。

Google.Cloud.Logging.V2 を使用してログを開始するには、次のいずれかのコマンドを使用してライブラリをインストールします。

パッケージ マネージャ

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

.NET CLI

> dotnet add package Google.Cloud.Logging.V2 --version 2.2.0

Logging クライアントをインストールしたら、次の文をアプリケーションコードに追加して、アプリケーションのログを Logging に送信できます。

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

以下のメソッドをカスタマイズして、アプリケーション コードに追加します。

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}.");
}

WriteLogEntry() を呼び出すロギングコードをいくつか作成します。ログエントリが生成されて、ログビューアの Global リソースの下に表示されます。

ログビューアに移動

ログビューアの詳細については、ログの表示をご覧ください。