Skip to content

XML config parity with JSON #167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 20, 2018
Merged

XML config parity with JSON #167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9574ce3
initial implementation
MV10 Oct 15, 2018
5c524cb
clarify external configuration options
MV10 Oct 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 64 additions & 22 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

78 changes: 30 additions & 48 deletions ...figuration/Microsoft.Extensions.Configuration/LoggerConfigurationMSSqlServerExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,9 +151,6 @@ private static string GetConnectionString(string nameOrConnectionString, IConfig
return cs;
}

// simulate using a property setter as an out parameter
delegate void PropertySetter<T>(T value);

/// <summary>
/// Create or add to the ColumnOptions object and apply any configuration changes to it.
/// </summary>
Expand Down Expand Up @@ -184,7 +181,8 @@ void AddRemoveStandardColumns()
{
foreach (var col in addStd.GetChildren().ToList())
{
if (Enum.TryParse(col.Value, ignoreCase: true, result: out StandardColumn stdcol))
if (Enum.TryParse(col.Value, ignoreCase: true, result: out StandardColumn stdcol)
&& !opts.Store.Contains(stdcol))
opts.Store.Add(stdcol);
}
}
Expand All @@ -195,7 +193,8 @@ void AddRemoveStandardColumns()
{
foreach (var col in removeStd.GetChildren().ToList())
{
if (Enum.TryParse(col.Value, ignoreCase: true, result: out StandardColumn stdcol))
if (Enum.TryParse(col.Value, ignoreCase: true, result: out StandardColumn stdcol)
&& opts.Store.Contains(stdcol))
opts.Store.Remove(stdcol);
}
}
Expand All @@ -211,12 +210,12 @@ void AddAdditionalColumns()
{
foreach (var c in newcols)
{
if (!string.IsNullOrWhiteSpace(c.ColumnName))// && !string.IsNullOrWhiteSpace(c.DataType))
if (!string.IsNullOrWhiteSpace(c.ColumnName))
{
if (opts.AdditionalColumns == null)
opts.AdditionalColumns = new Collection<SqlColumn>();

opts.AdditionalColumns.Add(c);//.AsSqlColumn());
opts.AdditionalColumns.Add(c);
}
}
}
Expand All @@ -229,49 +228,49 @@ void ReadStandardColumns()
{
SetCommonColumnOptions(opts.Id);
#pragma warning disable 618 // deprecated: BigInt property
SetIfProvided<bool>((val) => { opts.Id.BigInt = val; }, section["bigInt"]);
SetProperty.IfNotNull<bool>(section["bigInt"], (val) => opts.Id.BigInt = val);
#pragma warning restore 618
}

section = config.GetSection("level");
if (section != null)
{
SetCommonColumnOptions(opts.Level);
SetIfProvided<bool>((val) => { opts.Level.StoreAsEnum = val; }, section["storeAsEnum"]);
SetProperty.IfNotNull<bool>(section["storeAsEnum"], (val) => opts.Level.StoreAsEnum = val);
}

section = config.GetSection("properties");
if (section != null)
{
SetCommonColumnOptions(opts.Properties);
SetIfProvided<bool>((val) => { opts.Properties.ExcludeAdditionalProperties = val; }, section["excludeAdditionalProperties"]);
SetIfProvided<string>((val) => { opts.Properties.DictionaryElementName = val; }, section["dictionaryElementName"]);
SetIfProvided<string>((val) => { opts.Properties.ItemElementName = val; }, section["itemElementName"]);
SetIfProvided<bool>((val) => { opts.Properties.OmitDictionaryContainerElement = val; }, section["omitDictionaryContainerElement"]);
SetIfProvided<bool>((val) => { opts.Properties.OmitSequenceContainerElement = val; }, section["omitSequenceContainerElement"]);
SetIfProvided<bool>((val) => { opts.Properties.OmitStructureContainerElement = val; }, section["omitStructureContainerElement"]);
SetIfProvided<bool>((val) => { opts.Properties.OmitElementIfEmpty = val; }, section["omitElementIfEmpty"]);
SetIfProvided<string>((val) => { opts.Properties.PropertyElementName = val; }, section["propertyElementName"]);
SetIfProvided<string>((val) => { opts.Properties.RootElementName = val; }, section["rootElementName"]);
SetIfProvided<string>((val) => { opts.Properties.SequenceElementName = val; }, section["sequenceElementName"]);
SetIfProvided<string>((val) => { opts.Properties.StructureElementName = val; }, section["structureElementName"]);
SetIfProvided<bool>((val) => { opts.Properties.UsePropertyKeyAsElementName = val; }, section["usePropertyKeyAsElementName"]);
SetProperty.IfNotNull<bool>(section["excludeAdditionalProperties"], (val) => opts.Properties.ExcludeAdditionalProperties = val);
SetProperty.IfNotNull<string>(section["dictionaryElementName"], (val) => opts.Properties.DictionaryElementName = val);
SetProperty.IfNotNull<string>(section["itemElementName"], (val) => opts.Properties.ItemElementName = val);
SetProperty.IfNotNull<bool>(section["omitDictionaryContainerElement"], (val) => opts.Properties.OmitDictionaryContainerElement = val);
SetProperty.IfNotNull<bool>(section["omitSequenceContainerElement"], (val) => opts.Properties.OmitSequenceContainerElement = val);
SetProperty.IfNotNull<bool>(section["omitStructureContainerElement"], (val) => opts.Properties.OmitStructureContainerElement = val);
SetProperty.IfNotNull<bool>(section["omitElementIfEmpty"], (val) => opts.Properties.OmitElementIfEmpty = val);
SetProperty.IfNotNull<string>(section["propertyElementName"], (val) => opts.Properties.PropertyElementName = val);
SetProperty.IfNotNull<string>(section["rootElementName"], (val) => opts.Properties.RootElementName = val);
SetProperty.IfNotNull<string>(section["sequenceElementName"], (val) => opts.Properties.SequenceElementName = val);
SetProperty.IfNotNull<string>(section["structureElementName"], (val) => opts.Properties.StructureElementName = val);
SetProperty.IfNotNull<bool>(section["usePropertyKeyAsElementName"], (val) => opts.Properties.UsePropertyKeyAsElementName = val);
// TODO PropertiesFilter would need a compiled Predicate<string> (high Roslyn overhead, see Serilog Config repo #106)
}

section = config.GetSection("timeStamp");
if (section != null)
{
SetCommonColumnOptions(opts.TimeStamp);
SetIfProvided<bool>((val) => { opts.TimeStamp.ConvertToUtc = val; }, section["convertToUtc"]);
SetProperty.IfNotNull<bool>(section["convertToUtc"], (val) => opts.TimeStamp.ConvertToUtc = val);
}

section = config.GetSection("logEvent");
if (section != null)
{
SetCommonColumnOptions(opts.LogEvent);
SetIfProvided<bool>((val) => { opts.LogEvent.ExcludeAdditionalProperties = val; }, section["excludeAdditionalProperties"]);
SetIfProvided<bool>((val) => { opts.LogEvent.ExcludeStandardColumns = val; }, section["ExcludeStandardColumns"]);
SetProperty.IfNotNull<bool>(section["excludeAdditionalProperties"], (val) => opts.LogEvent.ExcludeAdditionalProperties = val);
SetProperty.IfNotNull<bool>(section["ExcludeStandardColumns"], (val) => opts.LogEvent.ExcludeStandardColumns = val);
}

section = config.GetSection("message");
Expand All @@ -289,18 +288,18 @@ void ReadStandardColumns()
// Standard Columns are subclasses of the SqlColumn class
void SetCommonColumnOptions(SqlColumn target)
{
SetIfProvided<string>((val) => { target.ColumnName = val; }, section["columnName"]);
SetIfProvided<string>((val) => { target.SetDataTypeFromConfigString(val); }, section["dataType"]);
SetIfProvided<bool>((val) => { target.AllowNull = val; }, section["allowNull"]);
SetIfProvided<int>((val) => { target.DataLength = val; }, section["dataLength"]);
SetIfProvided<bool>((val) => { target.NonClusteredIndex = val; }, section["nonClusteredIndex"]);
SetProperty.IfNotNullOrEmpty<string>(section["columnName"], (val) => target.ColumnName = val);
SetProperty.IfNotNull<string>(section["dataType"], (val) => target.SetDataTypeFromConfigString(val));
SetProperty.IfNotNull<bool>(section["allowNull"], (val) => target.AllowNull = val);
SetProperty.IfNotNull<int>(section["dataLength"], (val) => target.DataLength = val);
SetProperty.IfNotNull<bool>(section["nonClusteredIndex"], (val) => target.NonClusteredIndex = val);
}
}

void ReadMiscColumnOptions()
{
SetIfProvided<bool>((val) => { opts.DisableTriggers = val; }, config["disableTriggers"]);
SetIfProvided<bool>((val) => { opts.ClusteredColumnstoreIndex = val; }, config["clusteredColumnstoreIndex"]);
SetProperty.IfNotNull<bool>(config["disableTriggers"], (val) => opts.DisableTriggers = val);
SetProperty.IfNotNull<bool>(config["clusteredColumnstoreIndex"], (val) => opts.ClusteredColumnstoreIndex = val);

string pkName = config["primaryKeyColumnName"];
if (!string.IsNullOrEmpty(pkName))
Expand Down Expand Up @@ -334,23 +333,6 @@ void ReadMiscColumnOptions()
throw new ArgumentException($"Could not match the configured primary key column name \"{pkName}\" with a data column in the table.");
}
}

// This is used to only set a column property when it is actually specified in the config.
// When a value is requested from config, it returns null if that value hasn't been specified.
// This also means you can't use config to set a property to null.
void SetIfProvided<T>(PropertySetter<T> setter, string value)
{
if(value == null)
return;
try
{
var setting = (T)Convert.ChangeType(value, typeof(T));
setter(setting);
}
// don't change the property if the conversion failed
catch (InvalidCastException) { }
catch (OverflowException) { }
}
}
}
}
1 change: 0 additions & 1 deletion ...log.Sinks.MSSqlServer/Configuration/NetFramework.ConfigurationManager/ColumnCollection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
// See the License for the specific language governing permissions and
// limitations under the License.

using System.ComponentModel;
using System.Configuration;

// Disable XML comment warnings for internal config classes which are required to have public members
Expand Down
49 changes: 25 additions & 24 deletions ...Serilog.Sinks.MSSqlServer/Configuration/NetFramework.ConfigurationManager/ColumnConfig.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.

using Serilog.Sinks.MSSqlServer;
using System;
using System.Configuration;
using System.Data;

// Disable XML comment warnings for internal config classes which are required to have public members
#pragma warning disable 1591
Expand All @@ -24,67 +22,70 @@ namespace Serilog.Sinks.MSSqlServer
{
public class ColumnConfig : ConfigurationElement
{
public ColumnConfig() { }
public ColumnConfig()
{ }

public ColumnConfig(string columnName, string dataType)
{
ColumnName = columnName;
DataType = dataType;
}

// inheritors can override to set IsRequired = false
[ConfigurationProperty("ColumnName", IsRequired = true, IsKey = true)]
public string ColumnName
public virtual string ColumnName
{
get { return (string)this["ColumnName"]; }
set { this["ColumnName"] = value; }
}

[ConfigurationProperty("DataType", IsRequired = true, IsKey = false, DefaultValue ="varchar")]
[ConfigurationProperty("DataType")]
public string DataType
{
get { return (string)this["DataType"]; }
set { this["DataType"] = value; }
}

[ConfigurationProperty("DataLength", IsRequired = false, IsKey = false, DefaultValue = 128)]
public int DataLength
[ConfigurationProperty("DataLength")]
public string DataLength
{
get { return (int)this["DataLength"]; }
get { return (string)this["DataLength"]; }
set { this["DataLength"] = value; }
}

[ConfigurationProperty("AllowNull", IsRequired = false, IsKey = false, DefaultValue = true)]
public bool AllowNull
[ConfigurationProperty("AllowNull")]
public string AllowNull
{
get { return (bool)this["AllowNull"]; }
get { return (string)this["AllowNull"]; }
set { this["AllowNull"] = value; }
}

[ConfigurationProperty("NonClusteredIndex", IsRequired = false, IsKey = false, DefaultValue = false)]
public bool NonClusteredIndex
[ConfigurationProperty("NonClusteredIndex")]
public string NonClusteredIndex
{
get { return (bool)this["NonClusteredIndex"]; }
get { return (string)this["NonClusteredIndex"]; }
set { this["NonClusteredIndex"] = value; }
}

internal SqlColumn AsSqlColumn()
{
var commonColumn = new SqlColumn
{
ColumnName = ColumnName,
AllowNull = AllowNull,
DataLength = DataLength,
NonClusteredIndex = NonClusteredIndex
};
var commonColumn = new SqlColumn();

if (!SqlDataTypes.TryParseIfSupported(DataType, out SqlDbType sqlType))
throw new ArgumentException($"SQL column data type {DataType} is not recognized or supported by this sink.");
// inheritors can override IsRequired; config might not change the names of Standard Columns
SetProperty.IfProvidedNotEmpty<string>(this, "ColumnName", (val) => commonColumn.ColumnName = val);

commonColumn.DataType = sqlType;
if (DataType != null)
commonColumn.SetDataTypeFromConfigString(DataType);

SetProperty.IfProvided<int>(this, "DataLength", (val) => commonColumn.DataLength = val);

if (commonColumn.DataLength == 0 && SqlDataTypes.DataLengthRequired.Contains(commonColumn.DataType))
throw new ArgumentException($"SQL column data type {commonColumn.DataType.ToString()} requires a non-zero DataLength property.");

SetProperty.IfProvided<bool>(this, "AllowNull", (val) => commonColumn.AllowNull = val);

SetProperty.IfProvided<bool>(this, "NonClusteredIndex", (val) => commonColumn.NonClusteredIndex = val);

return commonColumn;
}
}
Expand Down
Loading