Innovative Model Railroad Control System

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Trace ======
[[:english#rocrail|{{  :server.png}}]][[:english|{{  :rocrail-logo-35.png}}]]
[[english | Content ]] -> [[english#rocrail|Rocrail Server]] -> [[rocrailini-en | Configuration]] 
  * [[rocrailini-gen-en|General]] | **Trace** | [[rocrailini-service-en|Service]] | [[rocrailini-automode-en|Automatic]] | [[rocrailini-controller-en|Controller]] | [[:networking-en|R2Rnet]] | [[:rocrailini-rocweb-en|RocWeb]] | [[:finder:finder-en|Finder]] | [[:rocrailini-cmdmapping-en|Command Mapping]]
// \\ // \\

===== Rocrail Trace,  What is it good for =====
Traces are to make program activities visible to understand what is happening or trying to solve problems.\\
If everything is as it should be: Turn off all trace levels.\\
 \\

==== Rocrail trace tab. ====
| Switch off all trace levels for better performance. |\\

{{rocrailini-trace-en.png?700}}\\

===== User Trace level =====
==== Information ====
For watching all Rocrail server activities; Should be turned off if all runs well.\\

==== Automatic ====
Shows in detail what the automatic library is doing and is especially handy for tracing down problems occurring when running trains in this mode.\\ 

==== Permissions ====
List up why a locomotive or train has no permission to run in a block or to use a route.\\
> ** Note ** A handy trace to see why a loco doesn't go to the next block. 
==== Monitor ====
Standard switched OFF; to show activities of digital decoders and events.\\
Use with care because all messages are also send to Rocview which could get a __queue overflow__ if the monitoring is very massive.\\
In most cases: __Disable this option__ if all decoders are working as expected.\\

==== Calculation ====
Traces the MVTrack speed and **[[:loc-bbt-en|BBT]]** calculations.\\
Also the final results of the track plan Router will traced. \\
==== Find ====
Extra trace in case no destination is found.\\

==== Router ====
Traces from the Track plan Router.
\\
=== Language ====
Language in which to output translatable server trace lines. (currently only for "Permissions" level)\\
\\

=====Developer Trace level =====
==== Byte ====
^ :!: Do not use as normal user. :!: ^\\
This is __**for developers only**__ and dumps out at byte level what is send and received between Rocrail and the Command Station(s).\\

==== Memory ====
^ :!: Do not use as normal user. :!: ^\\
This is __**for developers only**__ and traces out in case more memory is allocated.\\

==== Number of trace files ====
The number of recycle trace files.\\
The default is 3.\\
Only one file is used if set to zero or one; **This file will grow unlimited!**\\

==== Trace file size ====
The trace file size in KB if the number is set greater then 1.\\
The default is 100KB.\\
For using the __**[[:tracefilter-en|Trace Filter]]**__ leave it at 100KB.\\

=====Trace file=====
The name of the trace file to be used.\\
Trace files will get a running number to get a history of 10 (see value in trace files field) for debugging and service. \\
If left empty no trace file will be written.\\

=====Path=====
Path to store the trace files; In the working directory if left empty.\\
**Note:** Starting from revision 2.1.1057 the use of environment variables in the Trace Path is allowed, for example: ''%HOME%/trace''\\

===== Trace line format =====
<code>
20081018.150939.425 g9999I main     render   1203 setting signal 8s11 to white
</code>
^ timestamp ^ app ^ code ^ level ^ thread ^ object ^ source line ^ message ^
| 20081018.150939.425 |  g  |  9999  |  I  |  main  |  render  |  1203  | setting signal 8s11 to white |\\

===Timestamp format===
<code>
YYYYMMDD.HHmmSS.sss
</code>
 \\
===== Level Code =====
^ Level  ^ Code  ^ Remark  ^
| TRCLEVEL_EXCEPTION |  **E**  |
| TRCLEVEL_INFO      |  **I**  |
| TRCLEVEL_WARNING   |  **W**  |
| TRCLEVEL_DEBUG     |  **D**  |
| TRCLEVEL_BYTE      |  **B**  |
| TRCLEVEL_METHOD    |  **T**  |
| TRCLEVEL_MEMORY    |  **M**  |
| TRCLEVEL_PARAM     |  **A**  |
| TRCLEVEL_PROTOCOL  |  **P**  |
| TRCLEVEL_ERROR     |  **R**  |
| TRCLEVEL_PARSE     |  **S**  |
| TRCLEVEL_WRAPPER   |  **Z**  |
| TRCLEVEL_USER1     |  **a**  | automatic mode |
| TRCLEVEL_USER2     |  **b**  | HTTP |
| TRCLEVEL_MONITOR   |  **c**  |
| TRCLEVEL_XMLH      |  **d**  |
| TRCLEVEL_STATUS    |  **s**  |
| TRCLEVEL_XMLSCRIPT |  **x**  |
| TRCLEVEL_CALC      |  **v**  |
| TRCLEVEL_ROUTER    |  **y**  |
| TRCLEVEL_DEVELOP   |  **q**  |
| TRCLEVEL_PERMISSION|  **p**  | block and route permissions |
 \\
=====Trace IDs=====
^ ID Range ^ Usage ^
| 2001...2099 | Model route selection |
| 4001...4199 | Loco automatic |
| 5001...5099 | Block permissions |
| 5101...5199 | Route permissions |
| 8001...8199 | Router |

See also: __**[[:tracefilter-en#id|Trace Filter]]**__\\

=====Messages documentation=====
__**[[http://rocrail.net/software/rocrail-snapshot/rocrail/messages.xml|messages.xml]]**__ \\
__**[[https://translations.launchpad.net/rocrailservermessages|Translations]]**__\\