DotSee.ErrorRadar
17.0.8
dotnet add package DotSee.ErrorRadar --version 17.0.8
NuGet\Install-Package DotSee.ErrorRadar -Version 17.0.8
<PackageReference Include="DotSee.ErrorRadar" Version="17.0.8" />
<PackageVersion Include="DotSee.ErrorRadar" Version="17.0.8" />
<PackageReference Include="DotSee.ErrorRadar" />
paket add DotSee.ErrorRadar --version 17.0.8
#r "nuget: DotSee.ErrorRadar, 17.0.8"
#:package DotSee.ErrorRadar@17.0.8
#addin nuget:?package=DotSee.ErrorRadar&version=17.0.8
#tool nuget:?package=DotSee.ErrorRadar&version=17.0.8
DotSee Error Radar
Error Radar watches Umbraco's log pipeline and groups repeated Warning, Error and Critical entries, so recurring problems stand out. It also records application shutdowns.
Backoffice: Settings → Advanced → Error Radar has five views:
- Overview lists entries that repeated at least
OccurrenceNotificationThresholdtimes, each with its latest message as logged (placeholders filled in), and a drill-down with the full message, the message template the occurrences are grouped by, the latest occurrences and the stack trace. - Pages lists the pages that entries were logged for, the most affected first.
- Changes lists recorded changes, such as publishes and document type saves, with the number of new entries that appeared after each.
- Shutdowns lists the times the site stopped gracefully. Shutdowns are kept apart from changes, so they are never shown as possible triggers.
- About shows the installed version, whether NuGet.org has a newer one, and this read-me.
- Overview lists entries that repeated at least
Pages affected: each occurrence records the page it was logged for, when that can be told. This works for a front-end request routed to a page, for a backoffice request on a document, and for a log message with a
NodeId,ContentId,DocumentId,ContentKeyorDocumentKeyproperty. The Overview then shows "affects 1 page" or "affects 12 of 14 Article pages". One failing page usually means a content problem an editor can fix. Most pages of one document type failing usually means code, a template or the document type.Possible triggers: Error Radar records what changed in Umbraco and who changed it:
- publish, unpublish, move, recycle bin and delete
- document type, data type, template and partial view changes
- dictionary, language and domain changes
- startups and migrations
An entry's drill-down lists the changes made just before it started, or before it resumed after a quiet period of 6 hours. They are ranked by how strongly they connect:
- Strong: the same page.
- Medium: the same document type or template.
- Weak: only close in time.
A change listed here came before the entry. That does not mean it caused it.
AI analysis (optional, needs Umbraco.AI): when Umbraco.AI is installed and has an active connection with chat capability and a chat profile, every entry that reaches the threshold is analysed in the background. The AI gets the stack trace, the affected pages, the possible triggers and the Umbraco log file lines around the latest occurrences (the events of the same request), and its answer is shown in the entry's drill-down: the likely cause with a confidence, the evidence, how to verify it and possible fixes. Re-analyze runs it again on demand. Without Umbraco.AI, or without a configured connection, nothing changes. Error Radar does not depend on Umbraco.AI; it uses it when present (Umbraco.AI 17.1 or later).
Email: a notification email is sent each time an entry reaches the threshold. It is sent again only after cleanup drops the entry below the threshold and it reaches it once more. It names the site and links to its URL and to Error Radar in the backoffice, and it shows the latest message as logged, the message template and the stack trace. When the AI analysis runs automatically, the email waits for it and includes it, or the reason it failed. Analyses run one at a time and each can take up to
AiAnalysis:TimeoutSeconds, so the email can arrive a few minutes after the entry reached the threshold. If the site restarts while the email waits, the email goes out after the restart: with the analysis when that is queued again, otherwise without it. Optionally, the user who published a page is told when a new entry appears on it shortly afterwards. That email shows the same site, message and stack trace.Cleanup: an hourly job deletes records older than
DaysToStore.
Installation
dotnet add package DotSee.ErrorRadar
The database tables are created automatically on the first startup.
Configuration
All settings are optional. Add them to appsettings.json:
"DotSee": {
"ErrorRadar": {
"DaysToStore": 7,
"OccurrenceNotificationThreshold": 8,
"NotificationEmails": [ "ops@example.com" ],
"FromAddress": "errorradar@example.com",
"SiteName": "",
"TriggerWindowMinutes": 15,
"NotifyPublisherOfNewErrors": false,
"AiAnalysis": {
"Enabled": true,
"ProfileAlias": "",
"AutoAnalyze": true,
"MaxOccurrencesToInspect": 5,
"MaxLogCharacters": 24000,
"TimeoutSeconds": 180
}
}
}
| Setting | Default | Description |
|---|---|---|
DaysToStore |
7 |
How many days records are kept. |
OccurrenceNotificationThreshold |
8 |
Occurrences before an entry counts as repeated and an email is sent. |
NotificationEmails |
empty | Email recipients. Falls back to Umbraco:CMS:Global:Smtp:From. |
FromAddress |
empty | Email sender. Falls back to Umbraco:CMS:Global:Smtp:From. |
SiteName |
empty | The name the emails give the site, in the subject and the body. When empty: Umbraco:CMS:Hosting:SiteName, else the host name of the site's URL (for example www.example.com), else the application name. |
TriggerWindowMinutes |
15 |
How many minutes before an entry started a change can count as its possible trigger. |
NotifyPublisherOfNewErrors |
false |
Email the backoffice user who published a page when a new entry appears on it within TriggerWindowMinutes. |
AiAnalysis:Enabled |
true |
Set to false to turn the AI analysis off even when Umbraco.AI is available. |
AiAnalysis:ProfileAlias |
empty | Umbraco.AI chat profile to use. Empty uses the default chat profile, or else the first chat profile with an active connection. |
AiAnalysis:AutoAnalyze |
true |
Analyse entries automatically when they reach the threshold (and, at startup, repeated entries not analysed yet, at most 20). With false, only Analyze in the drill-down starts one. |
AiAnalysis:MaxOccurrencesToInspect |
5 |
How many of the latest occurrences are looked up in the Umbraco log files. |
AiAnalysis:MaxLogCharacters |
24000 |
Upper limit for the log file lines sent to the AI. |
AiAnalysis:TimeoutSeconds |
180 |
Longest time one analysis may take (at least 10). Raise it for slow (reasoning) models. The AI provider's own request timeout also applies: the OpenAI provider, for example, stops each attempt after 100 seconds. |
Emails need SMTP configured under Umbraco:CMS:Global:Smtp. Without it, Error Radar logs one warning and skips sending.
The site's URL in the emails is Umbraco's application URL: Umbraco:CMS:WebRouting:UmbracoApplicationUrl when it is set, otherwise the URL the site was requested on. Until the site has served a request, and without that setting, the emails show no URL. Set UmbracoApplicationUrl when the site answers on several host names or sits behind a proxy, so the emails always link to the public URL.
The emails contain the logged message and the stack trace, which can hold values from the request or the content. The publisher notice goes to backoffice editors, so it contains them too.
The AI analysis sends the logged message, the stack trace, page names, backoffice user names of possible triggers and log file lines to the AI provider of your Umbraco.AI connection. Each analysis is one chat request; it runs once when an entry reaches the threshold (again only if the entry drops below the threshold through cleanup and reaches it again) and on Re-analyze.
The About view asks NuGet.org (api.nuget.org) which versions of the package are listed. The site's server sends the request when someone opens the view, and reuses a successful answer for an hour. A site without internet access shows the installed version and says it could not check.
Uninstalling
NuGet and Umbraco don't run any code when a package is removed, so the database tables have to be removed by hand.
- Remove the package reference and delete the
DotSee:ErrorRadarsection fromappsettings.json:dotnet remove package DotSee.ErrorRadar - Rebuild and restart or redeploy the site, so the package no longer runs.
- Back up the database, then run
uninstall.sqlagainst it (SQLite or SQL Server 2016+):
DROP TABLE IF EXISTS dotseeLogEntryAnalyses;
DROP TABLE IF EXISTS dotseeLogEntryOccurrences;
DROP TABLE IF EXISTS dotseeLogEntries;
DROP TABLE IF EXISTS dotseeAppShutdowns;
DROP TABLE IF EXISTS dotseeActivityMarkers;
DELETE FROM umbracoKeyValue WHERE [key] = 'Umbraco.Core.Upgrader.State+DotSee.ErrorRadar';
Run it only after step 2. If the package is still installed, its migrations recreate the tables on the next startup. The last line removes Umbraco's record of the package's migrations, so a future reinstall creates the tables again.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- Umbraco.Cms.Api.Management (>= 17.0.0 && < 18.0.0)
- Umbraco.Cms.Web.Common (>= 17.0.0 && < 18.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.