Serilog.Sinks.Firestore 0.1.3

Installation

Using the dotnet cli:

dotnet add package Serilog.Sinks.Firestore

Usage

To use with default settings, add the Firestore Sink using one of the following methods:

var project = "myProject";
var collection = "myLogs";

var log = new LoggerConfiguration()
    .MinimumLevel.Information()
    .WriteTo.Firestore(project, collection)
    .CreateLogger();

// or

var firestoreConfiguration = new FirestoreConfiguration(project, collection);

var log = new LoggerConfiguration()
    .MinimumLevel.Information()
    .WriteTo.Firestore(firestoreConfiguration)
    .CreateLogger();

Credential types

By default if no credentials are specified the default environment variables credentials for Google Cloud in the following structureGOOGLE_APPLICATION_CREDENTIALS - path/credentials.json

In order to explicitly set other credentials, the optional parameters of both sink configurations provide a credentialType and credentialValue parameter.

Examples

JsonCredentials - a string (in JSON format) containing service account credentials

var firestoreApiClient = new FirestoreConfiguration(CredentialType.JsonCredentials, "project", "logs", "{ \"creds\" : \"value\"}");

CredentialsPath - a path to a JSON file containing service account credentials

var firestoreApiClient = new FirestoreConfiguration(CredentialType.CredentialsPath, "project", "logs", @"C:\creds.json");

Default - null/not used (Credentials loaded from Environment Variable)

var firestoreConfiguration = new FirestoreConfiguration("project", "logs");

Batching

This sink utilises PeriodicBatchingSink to write logs in batches to Firestore, because batch jobs have a limit of 500 operations, this limit is enforced in the configuration.