File: inviso_lfm_tpfreader.3

package info (click to toggle)
erlang-manpages 1%3A12.b.3-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,188 kB
  • ctags: 2
  • sloc: makefile: 68; perl: 30; sh: 15
file content (79 lines) | stat: -rw-r--r-- 3,241 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
.TH inviso_lfm_tpfreader 3 "inviso  0.6" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
inviso_lfm_tpfreader \- Inviso Standard Reader Process to Standard Logfile Merger
.SH DESCRIPTION
.LP
Implements the standard reader process to the standard logfile merger \fIinviso_lfm\fR\&.
.LP
The reader process reads logfiles belonging to the same set (normally one node) in chronological order and delivers logged trace messages one by one to the output process\&. Before any trace messages are delivered, the \fIinviso_lfm_tpreader\fR implementation reads the entire trace information file (if in use) and builds a database over pid-to-alias associations\&.
.LP
The \fIinviso_lfm_tpreader\fR implementation is capable of considering that an alias may have been used for several processes during different times\&. An alias may also be in use for several pids at the same time, on purpose\&. If a process has generated a trace message, all associations between that pid and aliases will be presented as the list \fIPidMappings\fR in the message sent to the output process\&.

.SH EXPORTS
.LP
.B
handle_logfile_sort_wrapset(LogFiles) -> FileList2
.br
.RS
.TP
Types
LogFiles = [{trace_log, FileList}]
.br
FileList = FileList2 = [FileName]
.br
FileName = string()
.br
.RE
.RS
.LP
Only one \fI{trace_log, FileList}\fR tuple is expected in \fILogFiles\fR, all other tuples are ignored\&. \fIFileList\fR must:
.RS 2
.TP 2
*
contain one single file name, or
.TP 2
*
a list of wraplog files, following the naming convention \fI<Prefix><Nr><Suffix>\fR\&.
.RE
.LP
Sorts the files in \fIFileList\fR in chronological order beginning with the oldest\&. Sorting is only relevant if \fIFileList\fR is a list of wraplogs\&. The sorting is done on finding the modulo-counter in the filename and not on filesystem timestamps\&.
.LP
This function is exported for convenience should an own reader process be implemented\&.
.RE
.SH THE TRACE INFORMATION FILE PROTOCOL
.LP
The format of a trace information file is dictated by the meta tracer process\&. The \fIinviso_lfm_tpfreader\fR implementation of a reader process understands the following trace information entries\&. Note that the \fIinviso_rt_meta\fR trace information file is on binary format prefixing every entry with a 4 byte length indicator\&.
.RS 2
.TP 4
.B
\fI{Pid, Alias, alias, NowStamp}\fR:
\fIPid = pid()\fR 
.br
\fIAlias = term()\fR 
.br
\fINowStamp = term()\fR, but in current implementation as returned from \fIerlang:now/0\fR
.RS 4
.LP

.LP
This message indicates that from now on shall \fIPid\fR be associated with \fIAlias\fR\&.
.RE
.TP 4
.B
\fI{MaybePid, Alias, unalias, NowStamp}\fR:
\fIMaybePid = pid() | undefined\fR 
.br
\fIAlias = term()\fR 
.br
\fINowStamp = term()\fR, see above
.RS 4
.LP

.LP
This message indicates that, if \fIMaybePid\fR is a pid, this pid shall no longer be associated with \fIAlias\fR\&. If it is \fIundefined\fR, all associations with \fIAlias\fR from now shall be considered invalid\&.
.LP

.LP
Also note that there are many situations where \fIunalias\fR entries will be missing\&. For instance if a process terminates without making explicit function calls removing its associations first\&. This is seldom a problem unless the pid is reused\&.
.RE
.RE