Skip to content

Commit

Permalink
Update links to GitHub repo and other minor updates
Browse files Browse the repository at this point in the history
  • Loading branch information
augustoproiete committed May 16, 2020
1 parent 9f8ff74 commit 275f746
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
See: https://github.com/caioproiete/exceldna-diagnostics-serilog/releases
See: https://github.com/augustoproiete/exceldna-diagnostics-serilog/releases
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ If you like or are using this project please give it a star. Thanks!

## Background

Excel-DNA writes [diagnostic log messages](https://github.com/Excel-DNA/ExcelDna/wiki/Diagnostic-Logging) which can be very useful for troubleshooting issues with an add-in that is not working or behaving as expected. By default, messages are written to the [`LogDisplay`](https://github.com/caioproiete/serilog-sinks-exceldnalogdisplay) window, which can only be seen by the end-user of the add-in.
Excel-DNA writes [diagnostic log messages](https://github.com/Excel-DNA/ExcelDna/wiki/Diagnostic-Logging) which can be very useful for troubleshooting issues with an add-in that is not working or behaving as expected. By default, messages are written to the [`LogDisplay`](https://github.com/augustoproiete/serilog-sinks-exceldnalogdisplay) window, which can only be seen by the end-user of the add-in.

![Excel-DNA Diagnostics LogDisplay screenshot](assets/default-logdisplay-logs.png)

However, it's possible to configure Excel-DNA to write to _other_ `Trace` listeners which can then forward these diagnostic messages to any logging pipeline such as [Serilog](https://serilog.net), for example, in order to consume / analyse these logs outside of the user's machine.

[`ExcelDna.Diagnostics.Serilog`](https://github.com/caioproiete/exceldna-diagnostics-serilog) implements a `TraceListener` that converts `Trace` log events to Serilog log events and integrates with a Serilog logging pipeline, effectivelly forwarding any diagnostic messages written by Excel-DNA to a Serilog logger.
[`ExcelDna.Diagnostics.Serilog`](https://github.com/augustoproiete/exceldna-diagnostics-serilog) implements a `TraceListener` that converts `Trace` log events to Serilog log events and integrates with a Serilog logging pipeline, effectivelly forwarding any diagnostic messages written by Excel-DNA to a Serilog logger.


## Getting started
Expand Down Expand Up @@ -93,7 +93,7 @@ public class AddIn : IExcelAddIn

## Example of an Excel-DNA add-in using `ExcelDna.Diagnostics.Serilog`

In the [sample](sample/) folder, you can find an example of an Excel-DNA add-in that captures any diagnostic messages written by Excel-DNA and forwards them to a Serilog logging pipeline configured to write log events to a file on disk and also to Excel-DNA's built-in [`LogDisplay`](https://github.com/caioproiete/serilog-sinks-exceldnalogdisplay).
In the [sample](sample/) folder, you can find an example of an Excel-DNA add-in that captures any diagnostic messages written by Excel-DNA and forwards them to a Serilog logging pipeline configured to write log events to a file on disk and also to Excel-DNA's built-in [`LogDisplay`](https://github.com/augustoproiete/serilog-sinks-exceldnalogdisplay).

![Excel-DNA Serilog logs in file Notepad screenshot](assets/serilog-logs-file-notepad.png)

Expand Down Expand Up @@ -148,4 +148,4 @@ In order for the Excel-DNA Diagnostics Serilog to work from an add-in that is pa

---

_Copyright © 2019-2020 Caio Proiete & Contributors - Provided under the [Apache License, Version 2.0](http://apache.org/licenses/LICENSE-2.0.html)._
_Copyright © 2019-2020 C. Augusto Proiete & Contributors - Provided under the [Apache License, Version 2.0](http://apache.org/licenses/LICENSE-2.0.html)._
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@
<DisableImplicitFrameworkReferences Condition=" '$(TargetFramework)' == 'net461' ">true</DisableImplicitFrameworkReferences>
<DisableImplicitFrameworkReferences Condition=" '$(TargetFramework)' == 'net472' ">true</DisableImplicitFrameworkReferences>

<Authors>Caio Proiete and Contributors</Authors>
<Authors>C. Augusto Proiete and Contributors</Authors>
<AssemblyName>ExcelDna.Diagnostics.Serilog</AssemblyName>
<RootNamespace>ExcelDna</RootNamespace>

<PackageId>ExcelDna.Diagnostics.Serilog</PackageId>
<PackageTags>exceldna;diagnostic;serilog;logging;excel-dna</PackageTags>
<PackageIconUrl>https://raw.githubusercontent.com/caioproiete/exceldna-diagnostics-serilog/master/assets/exceldna-diagnostics-serilog-nuget.png</PackageIconUrl>
<PackageProjectUrl>https://github.com/caioproiete/exceldna-diagnostics-serilog</PackageProjectUrl>
<PackageIconUrl>https://raw.githubusercontent.com/augustoproiete/exceldna-diagnostics-serilog/master/assets/exceldna-diagnostics-serilog-nuget.png</PackageIconUrl>
<PackageProjectUrl>https://github.com/augustoproiete/exceldna-diagnostics-serilog</PackageProjectUrl>
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
<RepositoryUrl>https://github.com/caioproiete/exceldna-diagnostics-serilog</RepositoryUrl>
<RepositoryUrl>https://github.com/augustoproiete/exceldna-diagnostics-serilog</RepositoryUrl>
<RepositoryType>git</RepositoryType>
<IncludeSymbols>true</IncludeSymbols>
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
Expand Down

0 comments on commit 275f746

Please sign in to comment.