Project

General

Profile

Idea #25262

Include links to detailed information in MessageFacility Messages

Added by Eric Flumerfelt about 2 months ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
-
Target version:
-
Start date:
11/30/2020
Due date:
% Done:

0%

Estimated time:
Experiment:
-
Duration:

Description

Some messages that artdaq produces are either not clear or can arise through several different conditions. We could create web-based documentation pages for these messages with common causes, additional debugging advice, etc, and then put a somewhat URL-shortened link into the message itself.

Some considerations:
We may want to avoid 3rd-party shorteners...Is "artdaq.fnal.gov/<hash>" short enough?
If a message's meaning or text changes, we should probably generate a new documentation page, so the link always refers to valid documentation for the user seeing the message.
We should do this work "on demand", for messages which have been noted to be particularly difficult to diagnose ("Back-pressure warning", "Bad Omen", etc). Corollary: Only Warning and Error messages would need this treatment.

Also available in: Atom PDF