Logging: added the concept of KeyResolver that can format keys capture in a Log, and options to capture callstacks

- the default resolver use FdbKey.Dump(..) like before (no attempt at resolve prefix, only prettyfying)
- the DirectoryKeyResolver can scrape the content of a DirectoryLayer and replace key prefix by the name of their directory subspace
- logging options can enable capture callstacks, which are displayed in the log report
- when displaying a callstack, try looking for the first method of interest (method if application code, not the binding)
- this is a not complete or optimized yet!

Author: KrzysFR

FdbShell/Program.cs

@@ -43,13 +43,6 @@ private static StreamWriter GetLogFile(string name)
 			return stream;
 		}
 
-		private static IFdbDatabase GetLoggedDatabase(IFdbDatabase db, StreamWriter stream, bool autoFlush = false)
-		{
-			if (stream == null) return db;
-
-			return new FdbLoggedDatabase(db, false, false, (tr) => { stream.WriteLine(tr.Log.GetTimingsReport(true)); if (autoFlush) stream.Flush(); });
-		}
-
 		public static async Task RunAsyncCommand(Func<IFdbDatabase, TextWriter, CancellationToken, Task> command, CancellationToken cancel)
 		{
 			TextWriter log = null;

FoundationDB.Client/Filters/FdbDatabaseFilter.cs

@@ -60,7 +60,7 @@ public abstract class FdbDatabaseFilter : IFdbDatabase
 
 		#region Constructors...
 
-		protected FdbDatabaseFilter(IFdbDatabase database, bool forceReadOnly, bool ownsDatabase)
+		protected FdbDatabaseFilter([NotNull] IFdbDatabase database, bool forceReadOnly, bool ownsDatabase)
 		{
 			if (database == null) throw new ArgumentNullException("database");
 
@@ -296,7 +296,14 @@ public int DefaultMaxRetryDelay
 
 		protected void ThrowIfDisposed()
 		{
-			if (m_disposed) throw new ObjectDisposedException(this.GetType().Name);
+			// this should be inlined by the caller
+			if (m_disposed) ThrowFilterAlreadyDisposed(this);
+		}
+
+		[ContractAnnotation("=> halt")]
+		private static void ThrowFilterAlreadyDisposed([NotNull] FdbDatabaseFilter filter)
+		{
+			throw new ObjectDisposedException(filter.GetType().Name);
 		}
 
 		public void Dispose()

FoundationDB.Client/Filters/FdbTransactionFilter.cs

@@ -1,5 +1,5 @@
 #region BSD Licence
-/* Copyright (c) 2013-2014, Doxense SAS
+/* Copyright (c) 2013-2015, Doxense SAS
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -33,6 +33,7 @@ namespace FoundationDB.Filters
 	using System.Collections.Generic;
 	using System.Threading;
 	using System.Threading.Tasks;
+	using JetBrains.Annotations;
 
 	/// <summary>Base class for simple transaction filters</summary>
 	public abstract class FdbTransactionFilter : IFdbTransaction
@@ -50,7 +51,7 @@ public abstract class FdbTransactionFilter : IFdbTransaction
 		/// <param name="trans">Underlying transaction that will be exposed as read-only</param>
 		/// <param name="forceReadOnly">If true, force the transaction to be read-only. If false, use the read-only mode of the underlying transaction</param>
 		/// <param name="ownsTransaction">If true, the underlying transaction will also be disposed when this instance is disposed</param>
-		protected FdbTransactionFilter(IFdbTransaction trans, bool forceReadOnly, bool ownsTransaction)
+		protected FdbTransactionFilter([NotNull] IFdbTransaction trans, bool forceReadOnly, bool ownsTransaction)
 		{
 			if (trans == null) throw new ArgumentNullException("trans");
 
@@ -61,7 +62,14 @@ protected FdbTransactionFilter(IFdbTransaction trans, bool forceReadOnly, bool o
 
 		protected void ThrowIfDisposed()
 		{
-			if (m_disposed) throw new ObjectDisposedException(this.GetType().Name);
+			// this should be inlined by the caller
+			if (m_disposed) ThrowFilterAlreadyDisposed(this);
+		}
+
+		[ContractAnnotation("=> halt")]
+		private static void ThrowFilterAlreadyDisposed([NotNull] FdbTransactionFilter filter)
+		{
+			throw new ObjectDisposedException(filter.GetType().Name);
 		}
 
 		public void Dispose()

FoundationDB.Client/Filters/Logging/FdbLoggedDatabase.cs

@@ -39,18 +39,22 @@ public sealed class FdbLoggedDatabase : FdbDatabaseFilter
 		/// <summary>Handler called everytime a transaction is successfully committed</summary>
 		public Action<FdbLoggedTransaction> OnCommitted { get; private set; }
 
-		public FdbLoggedDatabase(IFdbDatabase database, bool forceReadOnly, bool ownsDatabase, Action<FdbLoggedTransaction> onCommitted)
+		public FdbLoggingOptions LoggingOptions { get; private set; }
+
+		public FdbLoggedDatabase(IFdbDatabase database, bool forceReadOnly, bool ownsDatabase, Action<FdbLoggedTransaction> onCommitted, FdbLoggingOptions defaultOptions = FdbLoggingOptions.Default)
 			: base(database, forceReadOnly, ownsDatabase)
 		{
 			this.OnCommitted = onCommitted;
+			this.LoggingOptions = defaultOptions;
 		}
 
 		public override IFdbTransaction BeginTransaction(FdbTransactionMode mode, CancellationToken cancellationToken = default(CancellationToken), FdbOperationContext context = null)
 		{
 			return new FdbLoggedTransaction(
 				base.BeginTransaction(mode, cancellationToken, context),
 				true,
-				this.OnCommitted
+				this.OnCommitted,
+				this.LoggingOptions
 			);
 		}
 	}