Serilog.Sinks.GoogleCloudLogging 2.2.0

Serilog.Sinks.GoogleCloudLogging

Serilog sink that writes events to Google Cloud Platform Stackdriver Logging. View release notes here: CHANGELOG.md

Getting started

Install package from Nuget:

dotnet add package Serilog.Sinks.GoogleCloudLogging

Configure Logger (using code):

var config = new GoogleCloudLoggingSinkOptions { ProjectId = "YOUR_PROJECT_ID", UseJsonOutput = true };
Log.Logger = new LoggerConfiguration().WriteTo.GoogleCloudLogging(config).CreateLogger();

Configure Logger (using config file):

This requires 'serilog-settings-configuration' to load sinks using an appsettings.json file.

"Serilog": {
  "Using": [ "Serilog.Sinks.GoogleCloudLogging" ],
  "MinimumLevel": "Warning",
  "WriteTo": [
    {
      "Name": "GoogleCloudLogging",
      "Args": {
        "projectID": "YOUR_PROJECT_ID",
        "useJsonOutput": "true",
        "resourceType": "k8s_cluster",
        "resourceLabels": {
          "project_id": "PROJECT-ID-HERE-12345",
          "location": "LOCATION-STRING-HERE-region-name",
          "cluster_name": "CLUSTER-NAME-HERE-container-cluster"
        }
      }
    }
  ]
}

var config = new ConfigurationBuilder().AddJsonFile("appsettings.json", optional: true, reloadOnChange: true).Build();
Log.Logger = new LoggerConfiguration().ReadFrom.Configuration(config).CreateLogger();

GCP authentication:

This library uses the Google-Cloud-Dotnet libraries which authenticate using the Application Default Credentials found on the host. This is automatic on GCE VMs or you can use the gcloud SDK to authenticate manually. The service account must have the Logs Writer permission to send logs.

Sink Options

Output Type

Serilog uses structured logging which means each log line is a formatting template with attached properties that are combined to create the final output. When UseJsonOutput is false, the output is sent as TextPayload to GCP with any properties serialized to string key/value labels.

If UseJsonOutput is set to true, the output will be sent as JsonPayload to maintain the original data types. This is helpful for querying child properties or numeric values in the Log Viewer, and will also capture property names even if they have null values.

WARNING: JSON output only accepts numeric values as double so all numbers will be converted. Large integers and floating-point values will lose precision. If you want the exact value preserved then log it as a string instead.

Viewing Logs

Logs will appear in the Google Cloud Console Log Viewer: https://console.cloud.google.com/logs/viewer

When using default options, logs will appear under these filter settings: