├── CHANGES.md ├── .gitattributes ├── assets └── Serilog.snk ├── README.md ├── appveyor.yml ├── src └── Serilog.Sinks.AzureEventHub │ ├── Serilog.Sinks.AzureEventHub.nuspec │ ├── Serilog.Sinks.AzureEventHub.csproj │ ├── Sinks │ └── AzureEventHub │ │ ├── AzureEventHubSink.cs │ │ └── AzureEventHubBatchingSink.cs │ ├── app.config │ ├── AuditLoggerConfigurationAzureEventHubExtensions.cs │ └── LoggerConfigurationAzureEventHubExtensions.cs ├── serilog-sinks-azureeventhub.sln ├── Build.ps1 ├── .gitignore └── LICENSE /CHANGES.md: -------------------------------------------------------------------------------- 1 | 1.5 2 | * Moved from serilog/serilog 3 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | 3 | * text=auto 4 | -------------------------------------------------------------------------------- /assets/Serilog.snk: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serilog-contrib/serilog-sinks-azureeventhub/HEAD/assets/Serilog.snk -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # serilog-sinks-azureeventhub 2 | 3 | [![Build status](https://ci.appveyor.com/api/projects/status/3rokais2ssrnsw3q/branch/master?svg=true)](https://ci.appveyor.com/project/serilog/serilog-sinks-azureeventhub/branch/master) 4 | 5 | A Serilog sink that writes events to Azure EventHubs 6 | -------------------------------------------------------------------------------- /appveyor.yml: -------------------------------------------------------------------------------- 1 | version: '{build}' 2 | skip_tags: true 3 | image: Visual Studio 2017 4 | configuration: Release 5 | install: 6 | - ps: mkdir -Force ".\build\" | Out-Null 7 | build_script: 8 | - ps: ./Build.ps1 9 | test: off 10 | artifacts: 11 | - path: artifacts/Serilog.*.nupkg 12 | deploy: 13 | - provider: NuGet 14 | api_key: 15 | secure: pvGk80Hl+hnqiV0ucxBI2ZkYUlR6l7TrGZek37OCFh9Fro4BOhEBI2+UMkDwtgjt 16 | skip_symbols: true 17 | on: 18 | branch: /^(master|dev)$/ 19 | - provider: GitHub 20 | auth_token: 21 | secure: p4LpVhBKxGS5WqucHxFQ5c7C8cP74kbNB0Z8k9Oxx/PMaDQ1+ibmoexNqVU5ZlmX 22 | artifact: /Serilog.*\.nupkg/ 23 | tag: v$(appveyor_build_version) 24 | on: 25 | branch: master 26 | -------------------------------------------------------------------------------- /src/Serilog.Sinks.AzureEventHub/Serilog.Sinks.AzureEventHub.nuspec: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Serilog.Sinks.AzureEventHub 5 | $version$ 6 | Ben Gale 7 | Serilog event sink that writes to Azure Event Hubs. 8 | en-US 9 | http://serilog.net 10 | Apache-2.0 11 | http://serilog.net/images/serilog-sink-nuget.png 12 | 13 | serilog logging azure 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /serilog-sinks-azureeventhub.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio 15 4 | VisualStudioVersion = 15.0.27004.2009 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Serilog.Sinks.AzureEventHub", "src\Serilog.Sinks.AzureEventHub\Serilog.Sinks.AzureEventHub.csproj", "{4F30F48A-E294-456B-810F-E6D5B0191421}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|Any CPU = Debug|Any CPU 11 | Release|Any CPU = Release|Any CPU 12 | EndGlobalSection 13 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 14 | {4F30F48A-E294-456B-810F-E6D5B0191421}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 15 | {4F30F48A-E294-456B-810F-E6D5B0191421}.Debug|Any CPU.Build.0 = Debug|Any CPU 16 | {4F30F48A-E294-456B-810F-E6D5B0191421}.Release|Any CPU.ActiveCfg = Release|Any CPU 17 | {4F30F48A-E294-456B-810F-E6D5B0191421}.Release|Any CPU.Build.0 = Release|Any CPU 18 | EndGlobalSection 19 | GlobalSection(SolutionProperties) = preSolution 20 | HideSolutionNode = FALSE 21 | EndGlobalSection 22 | GlobalSection(ExtensibilityGlobals) = postSolution 23 | SolutionGuid = {E0B607D3-51F2-4422-AD79-617F980AE0F1} 24 | EndGlobalSection 25 | EndGlobal 26 | -------------------------------------------------------------------------------- /Build.ps1: -------------------------------------------------------------------------------- 1 | echo "build: Build started" 2 | 3 | Push-Location $PSScriptRoot 4 | 5 | if(Test-Path .\artifacts) { 6 | echo "build: Cleaning .\artifacts" 7 | Remove-Item .\artifacts -Force -Recurse 8 | } 9 | 10 | & dotnet restore --no-cache 11 | 12 | $branch = @{ $true = $env:APPVEYOR_REPO_BRANCH; $false = $(git symbolic-ref --short -q HEAD) }[$env:APPVEYOR_REPO_BRANCH -ne $NULL]; 13 | $revision = @{ $true = "{0:00000}" -f [convert]::ToInt32("0" + $env:APPVEYOR_BUILD_NUMBER, 10); $false = "local" }[$env:APPVEYOR_BUILD_NUMBER -ne $NULL]; 14 | $suffix = @{ $true = ""; $false = "$($branch.Substring(0, [math]::Min(10,$branch.Length)))-$revision"}[$branch -eq "master" -and $revision -ne "local"] 15 | $commitHash = $(git rev-parse --short HEAD) 16 | $buildSuffix = @{ $true = "$($suffix)-$($commitHash)"; $false = "$($branch)-$($commitHash)" }[$suffix -ne ""] 17 | 18 | echo "build: Package version suffix is $suffix" 19 | echo "build: Build version suffix is $buildSuffix" 20 | 21 | foreach ($src in ls src/*) { 22 | Push-Location $src 23 | 24 | echo "build: Packaging project in $src" 25 | 26 | & dotnet build -c Release --version-suffix=$buildSuffix 27 | if ($suffix) { 28 | & dotnet pack -c Release --include-source -o ..\..\artifacts --version-suffix=$suffix --no-build 29 | } else { 30 | & dotnet pack -c Release --include-source -o ..\..\artifacts --no-build 31 | } 32 | if($LASTEXITCODE -ne 0) { exit 1 } 33 | 34 | Pop-Location 35 | } 36 | 37 | Pop-Location -------------------------------------------------------------------------------- /src/Serilog.Sinks.AzureEventHub/Serilog.Sinks.AzureEventHub.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | Write Serilog events to Azure Event Hub 4 | 6.0.1 5 | Serilog Contributors 6 | netstandard2.0;net461 7 | true 8 | Serilog.Sinks.AzureEventHub 9 | ../../assets/Serilog.snk 10 | true 11 | true 12 | Serilog.Sinks.AzureEventHub 13 | serilog;azure;eventhub 14 | http://serilog.net 15 | Apache-2.0 16 | https://github.com/serilog/serilog-sinks-azureeventhub 17 | git 18 | false 19 | Serilog 20 | true 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /src/Serilog.Sinks.AzureEventHub/Sinks/AzureEventHub/AzureEventHubSink.cs: -------------------------------------------------------------------------------- 1 | // Copyright 2014 Serilog Contributors 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | using System; 16 | using System.Collections.Generic; 17 | using System.IO; 18 | using System.Text; 19 | using Azure.Messaging.EventHubs; 20 | using Azure.Messaging.EventHubs.Producer; 21 | using Serilog.Core; 22 | using Serilog.Events; 23 | using Serilog.Formatting; 24 | 25 | namespace Serilog.Sinks.AzureEventHub 26 | { 27 | /// 28 | /// Writes log events to an Azure Event Hub. 29 | /// 30 | public class AzureEventHubSink : ILogEventSink 31 | { 32 | readonly EventHubProducerClient _eventHubClient; 33 | readonly ITextFormatter _formatter; 34 | 35 | /// 36 | /// Construct a sink that saves log events to the specified EventHubClient. 37 | /// 38 | /// The EventHubClient to use in this sink. 39 | /// Provides formatting for outputting log data 40 | public AzureEventHubSink( 41 | EventHubProducerClient eventHubClient, 42 | ITextFormatter formatter) 43 | { 44 | _eventHubClient = eventHubClient; 45 | _formatter = formatter; 46 | } 47 | 48 | /// 49 | /// Emit the provided log event to the sink. 50 | /// 51 | /// The log event to write. 52 | public void Emit(LogEvent logEvent) 53 | { 54 | byte[] body; 55 | using (var render = new StringWriter()) 56 | { 57 | _formatter.Format(logEvent, render); 58 | body = Encoding.UTF8.GetBytes(render.ToString()); 59 | } 60 | var eventHubData = new EventData(body); 61 | eventHubData.Properties.Add("Type", "SerilogEvent"); 62 | eventHubData.Properties.Add("Level", logEvent.Level.ToString()); 63 | 64 | //Unfortunately no support for async in Serilog yet 65 | //https://github.com/serilog/serilog/issues/134 66 | _eventHubClient.SendAsync(new List() { eventHubData } , new SendEventOptions() { PartitionKey = Guid.NewGuid().ToString() }).GetAwaiter().GetResult(); 67 | } 68 | } 69 | } -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | 4 | # User-specific files 5 | *.suo 6 | *.user 7 | *.sln.docstates 8 | 9 | # Build results 10 | [Dd]ebug/ 11 | [Dd]ebugPublic/ 12 | [Rr]elease/ 13 | [Rr]eleases/ 14 | x64/ 15 | x86/ 16 | build/ 17 | bld/ 18 | [Bb]in/ 19 | [Oo]bj/ 20 | 21 | # Roslyn cache directories 22 | *.ide/ 23 | 24 | # MSTest test Results 25 | [Tt]est[Rr]esult*/ 26 | [Bb]uild[Ll]og.* 27 | 28 | #NUNIT 29 | *.VisualState.xml 30 | TestResult.xml 31 | 32 | # Build Results of an ATL Project 33 | [Dd]ebugPS/ 34 | [Rr]eleasePS/ 35 | dlldata.c 36 | 37 | *_i.c 38 | *_p.c 39 | *_i.h 40 | *.ilk 41 | *.meta 42 | *.obj 43 | *.pch 44 | *.pdb 45 | *.pgc 46 | *.pgd 47 | *.rsp 48 | *.sbr 49 | *.tlb 50 | *.tli 51 | *.tlh 52 | *.tmp 53 | *.tmp_proj 54 | *.log 55 | *.vspscc 56 | *.vssscc 57 | .builds 58 | *.pidb 59 | *.svclog 60 | *.scc 61 | 62 | # Chutzpah Test files 63 | _Chutzpah* 64 | 65 | # Visual C++ cache files 66 | ipch/ 67 | *.aps 68 | *.ncb 69 | *.opensdf 70 | *.sdf 71 | *.cachefile 72 | 73 | # Visual Studio profiler 74 | *.psess 75 | *.vsp 76 | *.vspx 77 | 78 | # TFS 2012 Local Workspace 79 | $tf/ 80 | 81 | # Guidance Automation Toolkit 82 | *.gpState 83 | 84 | # ReSharper is a .NET coding add-in 85 | _ReSharper*/ 86 | *.[Rr]e[Ss]harper 87 | *.DotSettings.user 88 | 89 | # JustCode is a .NET coding addin-in 90 | .JustCode 91 | 92 | # TeamCity is a build add-in 93 | _TeamCity* 94 | 95 | # DotCover is a Code Coverage Tool 96 | *.dotCover 97 | 98 | # NCrunch 99 | _NCrunch_* 100 | .*crunch*.local.xml 101 | 102 | # MightyMoose 103 | *.mm.* 104 | AutoTest.Net/ 105 | 106 | # Web workbench (sass) 107 | .sass-cache/ 108 | 109 | # Installshield output folder 110 | [Ee]xpress/ 111 | 112 | # DocProject is a documentation generator add-in 113 | DocProject/buildhelp/ 114 | DocProject/Help/*.HxT 115 | DocProject/Help/*.HxC 116 | DocProject/Help/*.hhc 117 | DocProject/Help/*.hhk 118 | DocProject/Help/*.hhp 119 | DocProject/Help/Html2 120 | DocProject/Help/html 121 | 122 | # Click-Once directory 123 | publish/ 124 | 125 | # Publish Web Output 126 | *.[Pp]ublish.xml 127 | *.azurePubxml 128 | # TODO: Comment the next line if you want to checkin your web deploy settings 129 | # but database connection strings (with potential passwords) will be unencrypted 130 | *.pubxml 131 | *.publishproj 132 | 133 | # NuGet Packages 134 | *.nupkg 135 | # The packages folder can be ignored because of Package Restore 136 | **/packages/* 137 | # except build/, which is used as an MSBuild target. 138 | !**/packages/build/ 139 | # If using the old MSBuild-Integrated Package Restore, uncomment this: 140 | #!**/packages/repositories.config 141 | 142 | # Windows Azure Build Output 143 | csx/ 144 | *.build.csdef 145 | 146 | # Windows Store app package directory 147 | AppPackages/ 148 | 149 | # Others 150 | sql/ 151 | *.Cache 152 | ClientBin/ 153 | [Ss]tyle[Cc]op.* 154 | ~$* 155 | *~ 156 | *.dbmdl 157 | *.dbproj.schemaview 158 | *.pfx 159 | *.publishsettings 160 | node_modules/ 161 | 162 | # RIA/Silverlight projects 163 | Generated_Code/ 164 | 165 | # Backup & report files from converting an old project file 166 | # to a newer Visual Studio version. Backup files are not needed, 167 | # because we have git ;-) 168 | _UpgradeReport_Files/ 169 | Backup*/ 170 | UpgradeLog*.XML 171 | UpgradeLog*.htm 172 | 173 | # SQL Server files 174 | *.mdf 175 | *.ldf 176 | 177 | # Business Intelligence projects 178 | *.rdl.data 179 | *.bim.layout 180 | *.bim_*.settings 181 | 182 | # Microsoft Fakes 183 | FakesAssemblies/ 184 | 185 | # Visual Studio 2015/2017 cache/options directory 186 | .vs/ -------------------------------------------------------------------------------- /src/Serilog.Sinks.AzureEventHub/Sinks/AzureEventHub/AzureEventHubBatchingSink.cs: -------------------------------------------------------------------------------- 1 | // Copyright 2014 Serilog Contributors 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | using System; 16 | using System.Collections.Generic; 17 | using System.IO; 18 | using System.Text; 19 | using System.Threading.Tasks; 20 | using Azure.Messaging.EventHubs; 21 | using Azure.Messaging.EventHubs.Producer; 22 | using Serilog.Events; 23 | using Serilog.Formatting; 24 | using Serilog.Sinks.PeriodicBatching; 25 | 26 | namespace Serilog.Sinks.AzureEventHub 27 | { 28 | /// 29 | /// Writes log events to an Azure Event Hub in batches. 30 | /// 31 | public class AzureEventHubBatchingSink : PeriodicBatchingSink 32 | { 33 | private readonly EventHubProducerClient _eventHubClient; 34 | private readonly ITextFormatter _formatter; 35 | 36 | /// 37 | /// Construct a sink that saves log events to the specified EventHubClient. 38 | /// 39 | /// The EventHubClient to use in this sink. 40 | /// Provides formatting for outputting log data 41 | /// 42 | /// 43 | public AzureEventHubBatchingSink( 44 | EventHubProducerClient eventHubClient, 45 | ITextFormatter formatter, 46 | int batchSizeLimit, 47 | TimeSpan period) 48 | : base(batchSizeLimit, period) 49 | { 50 | if (batchSizeLimit < 1 || batchSizeLimit > 100) 51 | { 52 | throw new ArgumentException( 53 | "batchSizeLimit must be between 1 and 100."); 54 | } 55 | 56 | _eventHubClient = eventHubClient; 57 | _formatter = formatter; 58 | } 59 | 60 | /// 61 | /// Emit a batch of log events, running to completion synchronously. 62 | /// 63 | /// The events to emit. 64 | protected override Task EmitBatchAsync(IEnumerable events) 65 | { 66 | var batchedEvents = new List(); 67 | var batchPartitionKey = Guid.NewGuid().ToString(); 68 | 69 | // Possible optimizations for the below: 70 | // 1. Reuse a StringWriter object for the whole batch, or possibly across batches. 71 | // 2. Reuse byte[] buffers instead of reallocating every time. 72 | foreach (var logEvent in events) 73 | { 74 | byte[] body; 75 | using (var render = new StringWriter()) 76 | { 77 | _formatter.Format(logEvent, render); 78 | body = Encoding.UTF8.GetBytes(render.ToString()); 79 | } 80 | var eventHubData = new EventData(body); 81 | 82 | eventHubData.Properties.Add("Type", "SerilogEvent"); 83 | eventHubData.Properties.Add("Level", logEvent.Level.ToString()); 84 | 85 | batchedEvents.Add(eventHubData); 86 | } 87 | return _eventHubClient.SendAsync(batchedEvents, new SendEventOptions() { PartitionKey = batchPartitionKey }); 88 | } 89 | } 90 | } 91 | -------------------------------------------------------------------------------- /src/Serilog.Sinks.AzureEventHub/app.config: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 12 | 13 | 14 | 15 | 16 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 28 | 30 | 32 | 33 | 34 | 36 | 38 | 40 | 42 | 44 | 45 | 46 | 48 | 50 | 52 | 54 | 56 | 58 | 60 | 61 | 62 | 63 | 64 | -------------------------------------------------------------------------------- /src/Serilog.Sinks.AzureEventHub/AuditLoggerConfigurationAzureEventHubExtensions.cs: -------------------------------------------------------------------------------- 1 | // Copyright 2019 Serilog Contributors 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | using System; 16 | using System.Diagnostics.CodeAnalysis; 17 | using Azure.Messaging.EventHubs.Producer; 18 | using Serilog.Configuration; 19 | using Serilog.Core; 20 | using Serilog.Events; 21 | using Serilog.Formatting; 22 | using Serilog.Formatting.Display; 23 | using Serilog.Sinks.AzureEventHub; 24 | 25 | namespace Serilog 26 | { 27 | /// 28 | /// Adds the `AuditTo.AzureEventHub()` extension methods to . 29 | /// 30 | [SuppressMessage("ReSharper", "MemberCanBePrivate.Global")] 31 | public static class AuditLoggerConfigurationAzureEventHubExtensions 32 | { 33 | const string DefaultOutputTemplate = "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level}] {Message}{NewLine}{Exception}"; 34 | 35 | /// 36 | /// A sink that puts log events into a provided Azure Event Hub. 37 | /// 38 | /// The logger configuration. 39 | /// The Event Hub to use to insert the log entries to. 40 | /// Supplies culture-specific formatting information, or null. 41 | /// A message template describing the format used to write to the sink. 42 | /// the default is "{Timestamp} [{Level}] {Message}{NewLine}{Exception}". 43 | /// The minimum log event level required in order to write an event to the sink. 44 | /// Logger configuration, allowing configuration to continue. 45 | /// A required parameter is null. 46 | public static LoggerConfiguration AzureEventHub( 47 | this LoggerAuditSinkConfiguration loggerConfiguration, 48 | EventHubProducerClient eventHubClient, 49 | string outputTemplate = DefaultOutputTemplate, 50 | IFormatProvider formatProvider = null, 51 | LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum 52 | ) 53 | { 54 | if (loggerConfiguration == null) 55 | throw new ArgumentNullException("loggerConfiguration"); 56 | if (eventHubClient == null) 57 | throw new ArgumentNullException("eventHubClient"); 58 | if (outputTemplate == null) 59 | throw new ArgumentNullException("outputTemplate"); 60 | 61 | var formatter = new MessageTemplateTextFormatter(outputTemplate, formatProvider); 62 | 63 | return AzureEventHub(loggerConfiguration, formatter, eventHubClient, restrictedToMinimumLevel); 64 | } 65 | 66 | /// 67 | /// A sink that puts log events into a provided Azure Event Hub. 68 | /// 69 | /// The logger configuration. 70 | /// Formatter used to convert log events to text. 71 | /// The Event Hub to use to insert the log entries to. 72 | /// The minimum log event level required in order to write an event to the sink. 73 | /// Logger configuration, allowing configuration to continue. 74 | /// A required parameter is null. 75 | public static LoggerConfiguration AzureEventHub( 76 | this LoggerAuditSinkConfiguration loggerConfiguration, 77 | ITextFormatter formatter, 78 | EventHubProducerClient eventHubClient, 79 | LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum) 80 | { 81 | if (loggerConfiguration == null) 82 | throw new ArgumentNullException("loggerConfiguration"); 83 | if (eventHubClient == null) 84 | throw new ArgumentNullException("eventHubClient"); 85 | 86 | var sink = new AzureEventHubSink(eventHubClient, formatter); 87 | return loggerConfiguration.Sink(sink, restrictedToMinimumLevel); 88 | } 89 | 90 | /// 91 | /// A sink that puts log events into a provided Azure Event Hub. 92 | /// 93 | /// The logger configuration. 94 | /// The Event Hub connection string. 95 | /// The Event Hub name. 96 | /// /// Supplies culture-specific formatting information, or null. 97 | /// A message template describing the format used to write to the sink. 98 | /// the default is "{Timestamp} [{Level}] {Message}{NewLine}{Exception}". 99 | /// The minimum log event level required in order to write an event to the sink. 100 | /// Logger configuration, allowing configuration to continue. 101 | /// A required parameter is null. 102 | public static LoggerConfiguration AzureEventHub( 103 | this LoggerAuditSinkConfiguration loggerConfiguration, 104 | string connectionString, 105 | string eventHubName, 106 | string outputTemplate = DefaultOutputTemplate, 107 | IFormatProvider formatProvider = null, 108 | LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum 109 | ) 110 | { 111 | if (loggerConfiguration == null) 112 | throw new ArgumentNullException("loggerConfiguration"); 113 | if (string.IsNullOrWhiteSpace(connectionString)) 114 | throw new ArgumentNullException("connectionString"); 115 | if (string.IsNullOrWhiteSpace(eventHubName)) 116 | throw new ArgumentNullException("eventHubName"); 117 | 118 | var client = new EventHubProducerClient(connectionString, eventHubName); 119 | 120 | return AzureEventHub(loggerConfiguration, client, outputTemplate, formatProvider, restrictedToMinimumLevel); 121 | } 122 | 123 | /// 124 | /// A sink that puts log events into a provided Azure Event Hub. 125 | /// 126 | /// The logger configuration. 127 | /// Formatter used to convert log events to text. 128 | /// The Event Hub connection string. 129 | /// The Event Hub name. 130 | /// The minimum log event level required in order to write an event to the sink. 131 | /// Logger configuration, allowing configuration to continue. 132 | /// A required parameter is null. 133 | public static LoggerConfiguration AzureEventHub( 134 | this LoggerAuditSinkConfiguration loggerConfiguration, 135 | ITextFormatter formatter, 136 | string connectionString, 137 | string eventHubName, 138 | LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum 139 | ) 140 | { 141 | if (loggerConfiguration == null) 142 | throw new ArgumentNullException("loggerConfiguration"); 143 | if (string.IsNullOrWhiteSpace(connectionString)) 144 | throw new ArgumentNullException("connectionString"); 145 | if (string.IsNullOrWhiteSpace(eventHubName)) 146 | throw new ArgumentNullException("eventHubName"); 147 | 148 | var client = new EventHubProducerClient(connectionString, eventHubName); 149 | return AzureEventHub(loggerConfiguration, formatter, client, restrictedToMinimumLevel); 150 | } 151 | } 152 | } 153 | -------------------------------------------------------------------------------- /src/Serilog.Sinks.AzureEventHub/LoggerConfigurationAzureEventHubExtensions.cs: -------------------------------------------------------------------------------- 1 | // Copyright 2014 Serilog Contributors 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | using System; 16 | using System.Diagnostics.CodeAnalysis; 17 | using Azure.Messaging.EventHubs.Producer; 18 | using Serilog.Configuration; 19 | using Serilog.Core; 20 | using Serilog.Events; 21 | using Serilog.Formatting; 22 | using Serilog.Formatting.Display; 23 | using Serilog.Sinks.AzureEventHub; 24 | 25 | namespace Serilog 26 | { 27 | /// 28 | /// Adds the WriteTo.AzureEventHub() extension metho to . 29 | /// 30 | [SuppressMessage("ReSharper", "MemberCanBePrivate.Global")] 31 | public static class LoggerConfigurationAzureEventHubExtensions 32 | { 33 | const string DefaultOutputTemplate = "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level}] {Message}{NewLine}{Exception}"; 34 | 35 | /// 36 | /// A reasonable default for the number of events posted in each batch. 37 | /// 38 | private const int DefaultBatchPostingLimit = 50; 39 | 40 | /// 41 | /// A reasonable default time to wait between checking for event batches. 42 | /// 43 | private static readonly TimeSpan DefaultPeriod = TimeSpan.FromSeconds(2); 44 | 45 | /// 46 | /// A sink that puts log events into a provided Azure Event Hub. 47 | /// 48 | /// The logger configuration. 49 | /// The Event Hub to use to insert the log entries to. 50 | /// Supplies culture-specific formatting information, or null. 51 | /// A message template describing the format used to write to the sink. 52 | /// the default is "{Timestamp} [{Level}] {Message}{NewLine}{Exception}". 53 | /// The minimum log event level required in order to write an event to the sink. 54 | /// Use a periodic batching sink, as opposed to a synchronous one-at-a-time sink; this alters the partition 55 | /// key used for the events so is not enabled by default. 56 | /// The maximum number of events to post in a single batch. 57 | /// The time to wait between checking for event batches. 58 | /// Logger configuration, allowing configuration to continue. 59 | /// A required parameter is null. 60 | public static LoggerConfiguration AzureEventHub( 61 | this LoggerSinkConfiguration loggerConfiguration, 62 | EventHubProducerClient eventHubClient, 63 | string outputTemplate = DefaultOutputTemplate, 64 | IFormatProvider formatProvider = null, 65 | LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum, 66 | bool writeInBatches = false, 67 | TimeSpan? period = null, 68 | int? batchPostingLimit = null 69 | ) 70 | { 71 | if (loggerConfiguration == null) 72 | throw new ArgumentNullException("loggerConfiguration"); 73 | if (eventHubClient == null) 74 | throw new ArgumentNullException("eventHubClient"); 75 | if (outputTemplate == null) 76 | throw new ArgumentNullException("outputTemplate"); 77 | 78 | var formatter = new MessageTemplateTextFormatter(outputTemplate, formatProvider); 79 | 80 | return AzureEventHub(loggerConfiguration, formatter, eventHubClient, restrictedToMinimumLevel,writeInBatches, period, batchPostingLimit); 81 | } 82 | 83 | /// 84 | /// A sink that puts log events into a provided Azure Event Hub. 85 | /// 86 | /// The logger configuration. 87 | /// Formatter used to convert log events to text. 88 | /// The Event Hub to use to insert the log entries to. 89 | /// The minimum log event level required in order to write an event to the sink. 90 | /// Use a periodic batching sink, as opposed to a synchronous one-at-a-time sink; this alters the partition 91 | /// key used for the events so is not enabled by default. 92 | /// The maximum number of events to post in a single batch. 93 | /// The time to wait between checking for event batches. 94 | /// Logger configuration, allowing configuration to continue. 95 | /// A required parameter is null. 96 | public static LoggerConfiguration AzureEventHub( 97 | this LoggerSinkConfiguration loggerConfiguration, 98 | ITextFormatter formatter, 99 | EventHubProducerClient eventHubClient, 100 | LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum, 101 | bool writeInBatches = false, 102 | TimeSpan? period = null, 103 | int? batchPostingLimit = null) 104 | { 105 | if (loggerConfiguration == null) 106 | throw new ArgumentNullException("loggerConfiguration"); 107 | if (eventHubClient == null) 108 | throw new ArgumentNullException("eventHubClient"); 109 | 110 | var sink = writeInBatches ? 111 | (ILogEventSink)new AzureEventHubBatchingSink( 112 | eventHubClient, 113 | formatter, 114 | batchPostingLimit ?? DefaultBatchPostingLimit, 115 | period ?? DefaultPeriod) : 116 | new AzureEventHubSink(eventHubClient, formatter); 117 | 118 | return loggerConfiguration.Sink(sink, restrictedToMinimumLevel); 119 | } 120 | 121 | /// 122 | /// A sink that puts log events into a provided Azure Event Hub. 123 | /// 124 | /// The logger configuration. 125 | /// The Event Hub connection string. 126 | /// The Event Hub name. 127 | /// /// Supplies culture-specific formatting information, or null. 128 | /// A message template describing the format used to write to the sink. 129 | /// the default is "{Timestamp} [{Level}] {Message}{NewLine}{Exception}". 130 | /// The minimum log event level required in order to write an event to the sink. 131 | /// Use a periodic batching sink, as opposed to a synchronous one-at-a-time sink; this alters the partition 132 | /// key used for the events so is not enabled by default. 133 | /// The maximum number of events to post in a single batch. 134 | /// The time to wait between checking for event batches. 135 | /// Logger configuration, allowing configuration to continue. 136 | /// A required parameter is null. 137 | public static LoggerConfiguration AzureEventHub( 138 | this LoggerSinkConfiguration loggerConfiguration, 139 | string connectionString, 140 | string eventHubName, 141 | string outputTemplate = DefaultOutputTemplate, 142 | IFormatProvider formatProvider = null, 143 | LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum, 144 | bool writeInBatches = false, 145 | TimeSpan? period = null, 146 | int? batchPostingLimit = null 147 | ) 148 | { 149 | if (loggerConfiguration == null) 150 | throw new ArgumentNullException("loggerConfiguration"); 151 | if (string.IsNullOrWhiteSpace(connectionString)) 152 | throw new ArgumentNullException("connectionString"); 153 | if (string.IsNullOrWhiteSpace(eventHubName)) 154 | throw new ArgumentNullException("eventHubName"); 155 | 156 | var client = new EventHubProducerClient(connectionString, eventHubName); 157 | 158 | return AzureEventHub(loggerConfiguration, client, outputTemplate, formatProvider, restrictedToMinimumLevel, writeInBatches, period, batchPostingLimit); 159 | } 160 | 161 | /// 162 | /// A sink that puts log events into a provided Azure Event Hub. 163 | /// 164 | /// The logger configuration. 165 | /// Formatter used to convert log events to text. 166 | /// The Event Hub connection string. 167 | /// The Event Hub name. 168 | /// The minimum log event level required in order to write an event to the sink. 169 | /// Use a periodic batching sink, as opposed to a synchronous one-at-a-time sink; this alters the partition 170 | /// key used for the events so is not enabled by default. 171 | /// The maximum number of events to post in a single batch. 172 | /// The time to wait between checking for event batches. 173 | /// Logger configuration, allowing configuration to continue. 174 | /// A required parameter is null. 175 | public static LoggerConfiguration AzureEventHub( 176 | this LoggerSinkConfiguration loggerConfiguration, 177 | ITextFormatter formatter, 178 | string connectionString, 179 | string eventHubName, 180 | LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum, 181 | bool writeInBatches = false, 182 | TimeSpan? period = null, 183 | int? batchPostingLimit = null 184 | ) 185 | { 186 | if (loggerConfiguration == null) 187 | throw new ArgumentNullException("loggerConfiguration"); 188 | if (string.IsNullOrWhiteSpace(connectionString)) 189 | throw new ArgumentNullException("connectionString"); 190 | if (string.IsNullOrWhiteSpace(eventHubName)) 191 | throw new ArgumentNullException("eventHubName"); 192 | 193 | var client = new EventHubProducerClient(connectionString, eventHubName); 194 | 195 | return AzureEventHub(loggerConfiguration, formatter, client, restrictedToMinimumLevel, writeInBatches, period, batchPostingLimit); 196 | } 197 | } 198 | } 199 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | --------------------------------------------------------------------------------