Skip to content

Porting old Umbraco API Controller [Debugging > Logging] #6513

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 8 commits into from
Oct 8, 2024
Merged

Porting old Umbraco API Controller [Debugging > Logging] #6513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b8881ee
Update controller
erikjanwestendorp Oct 4, 2024
d300101
Delete obsolete message
erikjanwestendorp Oct 4, 2024
75bd098
Improve readability
erikjanwestendorp Oct 4, 2024
32e6cc7
Update v15
erikjanwestendorp Oct 4, 2024
25363c9
Update 14/umbraco-cms/fundamentals/code/debugging/logging.md
erikjanwestendorp Oct 8, 2024
f44576b
Update 15/umbraco-cms/fundamentals/code/debugging/logging.md
erikjanwestendorp Oct 8, 2024
0cea743
Update v10 & 13
erikjanwestendorp Oct 8, 2024
f8a4ffb
Small change to trigger checks
sofietoft Oct 8, 2024
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
10 changes: 5 additions & 5 deletions 10/umbraco-cms/fundamentals/code/debugging/logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ keywords: logging serilog messagetemplates logs v9 version9

In Umbraco we use the underlying logging framework of [Serilog](https://serilog.net/).

Out of the box we write a JSON log file that contains a more rich logfile, that allows tools to perform searches & correlation on log patterns a lot easier.
Out of the box, we write a JSON log file that contains a more detailed logfile. This allows tools to perform searches and correlations on log patterns more efficiently.

The default location of this file is written to `umbraco/Logs` and contains the Machine name, along with the date too:

Expand All @@ -20,7 +20,7 @@ Serilog is a logging framework that allows us to do structured logging or write
2021-08-10 09:33:23,677 [P25776/D1/T22] INFO Umbraco.Cms.Core.Services.Implement.ContentService - Document Home (id=1062) has been published.
```

Here is an example of the same log message represented as JSON, you can see here we have much more information that would allow us to search & filter logs based on these properties with an appropriate logging system.
Here is an example of the same log message represented as JSON. More information is available and allows you to search and filter logs based on these properties with an appropriate logging system.

```json
{
Expand All @@ -46,13 +46,13 @@ Here is an example of the same log message represented as JSON, you can see here
}
```

To learn more about structured logging and message templates you can read more about it over on the [https://messagetemplates.org](https://messagetemplates.org) website or alternatively watch this video from the Serilog creator - [https://www.youtube.com/watch?v=OhmNp8UPEEg](https://www.youtube.com/watch?v=OhmNp8UPEEg)
To learn more about structured logging and message templates you can read more about it over on the [https://messagetemplates.org](https://messagetemplates.org) website. Alternatively watch this video from the Serilog creator - [https://www.youtube.com/watch?v=OhmNp8UPEEg](https://www.youtube.com/watch?v=OhmNp8UPEEg)

## Writing to the log

Umbraco writes log messages, but you are also able to use the Umbraco logger to write the log file as needed, so you can get further insights and details about your implementation.
Umbraco writes log messages, but you are also able to use the Umbraco logger to write the log file as needed. This allows you to gain further insights and details about your implementation.

Here is an example of using the logger to write an Information message to the log which will contain one property of **Name** which will output the name variable that is passed into the method
Here is an example of using the logger to write an Information message to the log. It will contain one property, **Name**, which will output the name variable that is passed into the method.

```csharp
using Microsoft.AspNetCore.Mvc;
Expand Down
10 changes: 5 additions & 5 deletions 13/umbraco-cms/fundamentals/code/debugging/logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

In Umbraco we use the underlying logging framework of [Serilog](https://serilog.net/).

Out of the box we write a JSON log file that contains a more rich logfile, that allows tools to perform searches & correlation on log patterns a lot easier.
Out of the box, we write a JSON log file that contains a more detailed logfile. This allows tools to perform searches and correlations on log patterns more efficiently.

The default location of this file is written to `umbraco/Logs` and contains the Machine name, along with the date too:

Expand All @@ -22,7 +22,7 @@ Serilog is a logging framework that allows us to do structured logging or write
2021-08-10 09:33:23,677 [P25776/D1/T22] INFO Umbraco.Cms.Core.Services.Implement.ContentService - Document Home (id=1062) has been published.
```

Here is an example of the same log message represented as JSON, you can see here we have much more information that would allow us to search & filter logs based on these properties with an appropriate logging system.
Here is an example of the same log message represented as JSON. More information is available and allows you to search and filter logs based on these properties with an appropriate logging system.

```json
{
Expand All @@ -48,13 +48,13 @@ Here is an example of the same log message represented as JSON, you can see here
}
```

To learn more about structured logging and message templates you can read more about it over on the [https://messagetemplates.org](https://messagetemplates.org) website or alternatively watch this video from the Serilog creator - [https://www.youtube.com/watch?v=OhmNp8UPEEg](https://www.youtube.com/watch?v=OhmNp8UPEEg)
To learn more about structured logging and message templates you can read more about it over on the [https://messagetemplates.org](https://messagetemplates.org) website. Alternatively watch this video from the Serilog creator - [https://www.youtube.com/watch?v=OhmNp8UPEEg](https://www.youtube.com/watch?v=OhmNp8UPEEg)

## Writing to the log

Umbraco writes log messages, but you are also able to use the Umbraco logger to write the log file as needed, so you can get further insights and details about your implementation.
Umbraco writes log messages, but you are also able to use the Umbraco logger to write the log file as needed. This allows you to gain further insights and details about your implementation.

Here is an example of using the logger to write an Information message to the log which will contain one property of **Name** which will output the name variable that is passed into the method
Here is an example of using the logger to write an Information message to the log. It will contain one property, **Name**, which will output the name variable that is passed into the method.

```csharp
using Microsoft.AspNetCore.Mvc;
Expand Down
25 changes: 11 additions & 14 deletions 14/umbraco-cms/fundamentals/code/debugging/logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

In Umbraco we use the underlying logging framework of [Serilog](https://serilog.net/).

Out of the box we write a JSON log file that contains a more rich logfile, that allows tools to perform searches & correlation on log patterns a lot easier.
Out of the box, we write a JSON log file that contains a more detailed logfile. This allows tools to perform searches and correlations on log patterns more efficiently.

The default location of this file is written to `umbraco/Logs` and contains the Machine name, along with the date too:

* `umbraco/Logs/UmbracoTraceLog.DELLBOOK.20210809.json`

## Video overview
## Video Overview

{% embed url="<https://youtu.be/PDqIRVygAQ4>" %}
Watch this video to get an overview of how to view and manage logs and logfiles for your Umbraco CMS website.
Watch this video to get an overview of how to view and manage logs and log files for your Umbraco CMS website.
{% endembed %}

## Structured logging
Expand All @@ -22,7 +22,7 @@ Serilog is a logging framework that allows us to do structured logging or write
2021-08-10 09:33:23,677 [P25776/D1/T22] INFO Umbraco.Cms.Core.Services.Implement.ContentService - Document Home (id=1062) has been published.
```

Here is an example of the same log message represented as JSON, you can see here we have much more information that would allow us to search & filter logs based on these properties with an appropriate logging system.
Here is an example of the same log message represented as JSON. More information is available and allows you to search and filter logs based on these properties with an appropriate logging system.

```json
{
Expand All @@ -48,26 +48,23 @@ Here is an example of the same log message represented as JSON, you can see here
}
```

To learn more about structured logging and message templates you can read more about it over on the [https://messagetemplates.org](https://messagetemplates.org) website or alternatively watch this video from the Serilog creator - [https://www.youtube.com/watch?v=OhmNp8UPEEg](https://www.youtube.com/watch?v=OhmNp8UPEEg)
To learn more about structured logging and message templates you can read more about it over on the [https://messagetemplates.org](https://messagetemplates.org) website. Alternatively watch this video from the Serilog creator - [https://www.youtube.com/watch?v=OhmNp8UPEEg](https://www.youtube.com/watch?v=OhmNp8UPEEg)

## Writing to the log

Umbraco writes log messages, but you are also able to use the Umbraco logger to write the log file as needed, so you can get further insights and details about your implementation.
Umbraco writes log messages, but you are also able to use the Umbraco logger to write the log file as needed. This allows you to gain further insights and details about your implementation.

Here is an example of using the logger to write an Information message to the log which will contain one property of **Name** which will output the name variable that is passed into the method

{% hint style="warning" %}
The example below uses UmbracoApiController which is obsolete in Umbraco 14 and will be removed in Umbraco 15.
{% endhint %}
Here is an example of using the logger to write an Information message to the log. It will contain one property, **Name**, which will output the name variable that is passed into the method.

```csharp
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using Umbraco.Cms.Web.Common.Controllers;

namespace Umbraco.Cms.Web.UI.NetCore;

public class MyApiController : UmbracoApiController
[ApiController]
[Route("/umbraco/api/myapi")]
public class MyApiController : Controller
{
private readonly ILogger<MyApiController> _logger;

Expand All @@ -77,7 +74,7 @@ public class MyApiController : UmbracoApiController
}

/// /umbraco/api/MyApi/SayHello?name=John
[HttpGet]
[HttpGet("sayhello")]
public string SayHello(string name)
{
_logger.LogInformation("We are saying hello to {Name}", name);
Expand Down
17 changes: 9 additions & 8 deletions 15/umbraco-cms/fundamentals/code/debugging/logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

In Umbraco we use the underlying logging framework of [Serilog](https://serilog.net/).

Out of the box we write a JSON log file that contains a more rich logfile, that allows tools to perform searches & correlation on log patterns a lot easier.
Out of the box, we write a JSON log file that contains a more detailed logfile. This allows tools to perform searches and correlations on log patterns more efficiently.

The default location of this file is written to `umbraco/Logs` and contains the Machine name, along with the date too:

Expand All @@ -22,7 +22,7 @@ Serilog is a logging framework that allows us to do structured logging or write
2021-08-10 09:33:23,677 [P25776/D1/T22] INFO Umbraco.Cms.Core.Services.Implement.ContentService - Document Home (id=1062) has been published.
```

Here is an example of the same log message represented as JSON, you can see here we have much more information that would allow us to search & filter logs based on these properties with an appropriate logging system.
Here is an example of the same log message represented as JSON. More information is available and allows you to search and filter logs based on these properties with an appropriate logging system.

```json
{
Expand All @@ -48,13 +48,13 @@ Here is an example of the same log message represented as JSON, you can see here
}
```

To learn more about structured logging and message templates you can read more about it over on the [https://messagetemplates.org](https://messagetemplates.org) website or alternatively watch this video from the Serilog creator - [https://www.youtube.com/watch?v=OhmNp8UPEEg](https://www.youtube.com/watch?v=OhmNp8UPEEg)
To learn more about structured logging and message templates you can read more about it over on the [https://messagetemplates.org](https://messagetemplates.org) website. Alternatively watch this video from the Serilog creator - [https://www.youtube.com/watch?v=OhmNp8UPEEg](https://www.youtube.com/watch?v=OhmNp8UPEEg)

## Writing to the log

Umbraco writes log messages, but you are also able to use the Umbraco logger to write the log file as needed, so you can get further insights and details about your implementation.
Umbraco writes log messages, but you are also able to use the Umbraco logger to write the log file as needed. This allows you to gain further insights and details about your implementation.

Here is an example of using the logger to write an Information message to the log which will contain one property of **Name** which will output the name variable that is passed into the method
Here is an example of using the logger to write an Information message to the log. It will contain one property, **Name**, which will output the name variable that is passed into the method.

{% hint style="warning" %}
The example below uses UmbracoApiController which is obsolete in Umbraco 14 and will be removed in Umbraco 15.
Expand All @@ -63,11 +63,12 @@ The example below uses UmbracoApiController which is obsolete in Umbraco 14 and
```csharp
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using Umbraco.Cms.Web.Common.Controllers;

namespace Umbraco.Cms.Web.UI.NetCore;

public class MyApiController : UmbracoApiController
[ApiController]
[Route("/umbraco/api/myapi")]
public class MyApiController : Controller
{
private readonly ILogger<MyApiController> _logger;

Expand All @@ -77,7 +78,7 @@ public class MyApiController : UmbracoApiController
}

/// /umbraco/api/MyApi/SayHello?name=John
[HttpGet]
[HttpGet("sayhello")]
public string SayHello(string name)
{
_logger.LogInformation("We are saying hello to {Name}", name);
Expand Down
Loading