Merge pull request #73 from serilog/dev

1.0.0 Release

Author: nblumhardt

.gitattributes

@@ -0,0 +1,3 @@
+# Auto detect text files and perform LF normalization
+
+* text=auto

.gitignore

@@ -1,7 +1,7 @@
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.
 ##
-## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
+## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
 
 # User-specific files
 *.rsuser
@@ -23,6 +23,7 @@ mono_crash.*
 [Rr]eleases/
 x64/
 x86/
+[Ww][Ii][Nn]32/
 [Aa][Rr][Mm]/
 [Aa][Rr][Mm]64/
 bld/
@@ -61,6 +62,9 @@ project.lock.json
 project.fragment.lock.json
 artifacts/
 
+# ASP.NET Scaffolding
+ScaffoldingReadMe.txt
+
 # StyleCop
 StyleCopReport.xml
 
@@ -86,6 +90,7 @@ StyleCopReport.xml
 *.tmp_proj
 *_wpftmp.csproj
 *.log
+*.tlog
 *.vspscc
 *.vssscc
 .builds
@@ -137,6 +142,11 @@ _TeamCity*
 .axoCover/*
 !.axoCover/settings.json
 
+# Coverlet is a free, cross platform Code Coverage Tool
+coverage*.json
+coverage*.xml
+coverage*.info
+
 # Visual Studio code coverage results
 *.coverage
 *.coveragexml
@@ -284,6 +294,17 @@ node_modules/
 # Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
 *.vbw
 
+# Visual Studio 6 auto-generated project file (contains which files were open etc.)
+*.vbp
+
+# Visual Studio 6 workspace and project file (working project files containing files to include in project)
+*.dsw
+*.dsp
+
+# Visual Studio 6 technical files
+*.ncb
+*.aps
+
 # Visual Studio LightSwitch build output
 **/*.HTMLClient/GeneratedArtifacts
 **/*.DesktopClient/GeneratedArtifacts
@@ -340,6 +361,9 @@ ASALocalRun/
 # Local History for Visual Studio
 .localhistory/
 
+# Visual Studio History (VSHistory) files
+.vshistory/
+
 # BeatPulse healthcheck temp database
 healthchecksdb
 
@@ -348,3 +372,28 @@ MigrationBackup/
 
 # Ionide (cross platform F# VS Code tools) working folder
 .ionide/
+
+# Fody - auto-generated XML schema
+FodyWeavers.xsd
+
+# VS Code files for those working on multiple tools
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
+
+# Windows Installer files from build outputs
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# JetBrains Rider
+*.sln.iml
+/test/Serilog.Sinks.OpenTelemetry.Tests/PublicApiVisibilityTests.received.txt

.idea/.idea.serilog-sinks-opentelemetry/.idea/.gitignore

@@ -0,0 +1,26 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            // Use IntelliSense to find out which attributes exist for C# debugging
+            // Use hover for the description of the existing attributes
+            // For further information visit https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md
+            "name": ".NET Core Launch (console)",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "build",
+            // If you have changed target frameworks, make sure to update the program path.
+            "program": "${workspaceFolder}/test/Serilog.Sinks.OpenTelemetry.Tests/bin/Debug/net6.0/Serilog.Sinks.OpenTelemetry.Tests.dll",
+            "args": [],
+            "cwd": "${workspaceFolder}/test/Serilog.Sinks.OpenTelemetry.Tests",
+            // For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console
+            "console": "internalConsole",
+            "stopAtEntry": false
+        },
+        {
+            "name": ".NET Core Attach",
+            "type": "coreclr",
+            "request": "attach"
+        }
+    ]
+}

.idea/.idea.serilog-sinks-opentelemetry/.idea/encodings.xml

@@ -0,0 +1,41 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "build",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "build",
+                "${workspaceFolder}/test/Serilog.Sinks.OpenTelemetry.Tests/Serilog.Sinks.OpenTelemetry.Tests.csproj",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary"
+            ],
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "label": "publish",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "publish",
+                "${workspaceFolder}/test/Serilog.Sinks.OpenTelemetry.Tests/Serilog.Sinks.OpenTelemetry.Tests.csproj",
+                "/property:GenerateFullPaths=true",
+                "/consoleloggerparameters:NoSummary"
+            ],
+            "problemMatcher": "$msCompile"
+        },
+        {
+            "label": "watch",
+            "command": "dotnet",
+            "type": "process",
+            "args": [
+                "watch",
+                "run",
+                "--project",
+                "${workspaceFolder}/test/Serilog.Sinks.OpenTelemetry.Tests/Serilog.Sinks.OpenTelemetry.Tests.csproj"
+            ],
+            "problemMatcher": "$msCompile"
+        }
+    ]
+}

.idea/.idea.serilog-sinks-opentelemetry/.idea/indexLayout.xml

@@ -0,0 +1,61 @@
+Write-Output "build: Build started"
+
+Push-Location $PSScriptRoot
+
+if(Test-Path .\artifacts) {
+	Write-Output "build: Cleaning ./artifacts"
+	Remove-Item ./artifacts -Force -Recurse
+}
+
+& dotnet restore --no-cache
+
+$branch = @{ $true = $env:APPVEYOR_REPO_BRANCH; $false = $(git symbolic-ref --short -q HEAD) }[$NULL -ne $env:APPVEYOR_REPO_BRANCH];
+$revision = @{ $true = "{0:00000}" -f [convert]::ToInt32("0" + $env:APPVEYOR_BUILD_NUMBER, 10); $false = "local" }[$NULL -ne $env:APPVEYOR_BUILD_NUMBER];
+$suffix = @{ $true = ""; $false = "$($branch.Substring(0, [math]::Min(10,$branch.Length)))-$revision"}[$branch -eq "main" -and $revision -ne "local"]
+$commitHash = $(git rev-parse --short HEAD)
+$buildSuffix = @{ $true = "$($suffix)-$($commitHash)"; $false = "$($branch)-$($commitHash)" }[$suffix -ne ""]
+
+Write-Output "build: Package version suffix is $suffix"
+Write-Output "build: Build version suffix is $buildSuffix"
+
+foreach ($src in Get-ChildItem src/*) {
+    Push-Location $src
+
+	Write-Output "build: Packaging project in $src"
+
+    & dotnet build -c Release --version-suffix=$buildSuffix
+    if($LASTEXITCODE -ne 0) { throw "Failed" }
+
+    if($suffix) {
+        & dotnet pack -c Release --include-source --no-build -o ../../artifacts --version-suffix=$suffix
+    } else {
+        & dotnet pack -c Release --include-source --no-build -o ../../artifacts
+    }
+    if($LASTEXITCODE -ne 0) { throw "Failed" }
+
+    Pop-Location
+}
+
+foreach ($test in Get-ChildItem test/*.Tests) {
+    Push-Location $test
+
+	Write-Output "build: Testing project in $test"
+
+    & dotnet test -c Release
+    if($LASTEXITCODE -ne 0) { throw "Failed" }
+
+    Pop-Location
+}
+
+foreach ($test in ls test/*.PerformanceTests) {
+    Push-Location $test
+
+	Write-Output "build: Building performance test project in $test"
+
+    & dotnet build -c Release
+    if($LASTEXITCODE -ne 0) { throw "Failed" }
+
+    Pop-Location
+}
+
+Pop-Location

.idea/.idea.serilog-sinks-opentelemetry/.idea/vcs.xml

@@ -0,0 +1,61 @@
+# Developer Guide
+
+## Design Choices
+
+### Direct Use of Proto Definitions
+
+The OpenTelemetry logging sink will be used in environments that may
+have severe limitations on dependency package versions. The
+OpenTelemetry .NET SDK has a large number of dependencies (~50) that
+would make its use difficult in these environments.
+
+Consequently, this sink imports the C# OpenTelemetry Proto bindings
+directly to minimize the dependencies. As the proto definitions
+evolve, this may require support for multiple versions of the sink.
+
+### Direct Mapping of Properties
+
+OpenTelemetry attributes allows full support for scalar values,
+arrays, and maps. Serilog does as well. Consequently, the sink does a
+one-to-one mapping between Serilog properties and OpenTelemetry
+attributes. There is no flattening, renaming, or other modifications
+done to the properies by default.
+
+The configured formatter (or default) renders the log message. This
+message is written to the OpenTelemetry LogRecord body.
+
+## OpenTelemetry Proto
+
+The OpenTelemetry data structures are defined in the language-neutral
+protobuf format. To generate the language-specific bindings for C#,
+you must have `make` and `docker` installed.
+
+With the necessary prerequisites available, you can then:
+
+- Clone the
+  [open-telemetry/opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto)
+  repository.
+
+- Checkout the appropriate tag for the version of the OpenTelemetry
+  Collector that you want to support.
+
+- Run `make gen-csharp` from the root of the cloned repository.
+
+- Copy the files in `gen/csharp` to the `src/Serilog.Sinks.OpenTelemetry/Sinks/OpenTelemetry/Proto` 
+  directory in this repository.
+
+- The files for metrics and traces are not necessary and can be
+  removed.
+
+- Reduce the access to top-level classes and enums in the binding
+  files from "public" to "internal" (implicit), to avoid these
+  becoming part of the sink's public API.
+
+Ensure that all unit tests pass before checking in the new code.
+
+**Current OpenTelemetry proto binding files have been generated from
+tag v0.19.0.**
+
+The OpenTelemetry proto version used in the OpenTelemetry Collector
+can be found in the [open-telemetry/opentelemetry-collector/Makefile](https://github.com/open-telemetry/opentelemetry-collector/blob/main/Makefile). Look for the `OPENTELEMETRY_PROTO_VERSION` variable
+definition.