Skip to content

Commit

Permalink
added info for log
Browse files Browse the repository at this point in the history
  • Loading branch information
joreg committed Dec 20, 2023
1 parent b6ded75 commit fec151a
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 6 deletions.
4 changes: 2 additions & 2 deletions reference/hde/debugging-apphealth.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# App Health

**As of vvvv gamma 5.3-preview 413**
**As of vvvv gamma 5.3-preview 419**

Here you'll see an overview of issues coming from your running application. These can be exceptions (the pink nodes) or come from a `Warn [VL.Session]` node that you can even use yourself in patches to indicate a problem.

![](../../images/reference/hde/2023-12-20-21-14-47.png)

Exceptions are critical and should be taken seriously. Your application crashed.
Errors, Warnings, and Infos are messages from the library developer. The app didn't crash, but there is something fishy, which you should probably take another look at.
Errors, Warnings and Infos are messages from the library developer. The app didn't crash, but there is something fishy, which you should probably take another look at.

Note that same as the [Build Result](debugging-buildresult.md) view, also this view is ephemeral in that it always only shows the current state of affairs. If you're looking for a history of issues your app ever had, consult the [Log](debugging-log.md).
2 changes: 1 addition & 1 deletion reference/hde/debugging-buildresult.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Build Result

**As of vvvv gamma 5.3-preview 413**
**As of vvvv gamma 5.3-preview 419**

Here you'll see errors, warnings and infos that came up as a result of the build process. Whenever vvvv is building your patches (ie. whenever you make a change), this list is cleared and you'll get a fresh view of the latest issues.

Expand Down
23 changes: 20 additions & 3 deletions reference/hde/debugging-log.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,35 @@
# Log

**As of vvvv gamma 5.3-preview 413**
**As of vvvv gamma 5.3-preview 419**

The log is collecting all messages over time and shows you the whole history, until you clear it or the buffer runs over (Buffer length defaults to 5000 but can be configured via the Settings).

![](../../images/reference/hde/2023-12-20-21-15-29.png)

Here you'll find all messages sent by the system, but also by your app. To distinguish between those, see the "Source" column.
## Severity Threshold
Every log message has one of the following severities assigned:
- Critical
- Error
- Warning
- Information
- Debug
- Trace

Via the severity pulldown (defaulting to "Information") you can set a hard log-level threshold, meaning that any messages with a lower severity level than the chosen threshold will be ignored.

## Filtering Severities
All log-messages that pass the severity threshold will be visible in the list. To filter for certain severities you can toggle the severity buttons right next to the severity threshold pulldown. Pro-tip: Rightclick a severity to solo it!

## System vs. App messages
The log-messages you see in the list view can be coming either from the system (vvvv itself) or from your app. To distinguish between those, see the "Source" column.

## Logging from your patches
To create log messages from your patches use the Log [System.Logging] node.

## Log Providers
The interesting thing with logging is that you can also route logs to any [logging provider](https://learn.microsoft.com/en-us/dotnet/core/extensions/logging-providers) you prefer. In a real-life project you may want to log certain messages to a file and others to a cloud service. Anything is possible, see at "HowTo Configure logging providers" in the helpbrowser.

### Log UI in your own application
## Log UI in your own application

When exporting your application, by default you've now lost the ability to view your log messages, since the above Log window is part of vvvv itself and not your app.

Expand Down

0 comments on commit fec151a

Please sign in to comment.