1REPORT_EVENT.CONF(5) LIBREPORT MANUAL REPORT_EVENT.CONF(5)
2
6 report_event.conf - configuration file for libreport.
7
9 This configuration file specifies which programs should be run when the
10 specified event occurs in problem directory lifetime.
11 It consists of directives and rules.
13 Directives start with a reserved word. Currently, there is only one
15 directive, "include".
16 include FILE
18 This directive causes files which match FILE to be read and parsed
19 as if they are inserted textually where this directive occurs. FILE
20 can use shell pattern metacharacters (*,?,etc) to specify multiple
21 files. Relative paths are interpreted relative to current file.
22 Rule starts with a line with non-space leading character. All
24 subsequent lines which start with space or tab form one rule. Note that
25 separating newline is retained.
26 Rules may be commented out with #. One # is sufficient to comment out
28 even a multi-line rule (no need to comment out every line).
29 Rules specify which programs to run on the problem directory. Each rule
31 may have conditions to be checked before the program is run.
32 Conditions have form VAR=VAL or VAL~=REGEX, where VAR is either word
34 "EVENT" or a name of problem directory element to be checked (for
35 example, "executable", "package", hostname" etc).
36 If all conditions match, the remaining part of the rule (the "program"
38 part) is run in the shell. All shell language constructs are valid. All
39 stdout and stderr output is captured and passed to ABRT and possibly to
40 ABRT’s frontends and shown to the user.
41 If the program terminates with nonzero exit code, the event processing
43 is considered unsuccessful and is stopped. Last captured output line,
44 if any, is considered to be the error message indicating the reason of
45 the failure, and may be used by abrt as such.
46 If the program terminates successfully, next rule is read and
48 processed. This process is repeated until the end of this file.
49 Event XML configuration
51 These configuration files provides event meta data.
52 Each file has XML formatting with the following DTD:
54 <!ELEMENT event (name+,description+,requires-items?,exclude-items-by-default?,exclude-items-always?,exclude-binary-items?,include-items-by-default?,minimal-rating?,gui-review-elements?,options?)>
56 <!ELEMENT name (#PCDATA)>
57 <!ATTLIST name xml:lang CDATA #IMPLIED>
58 <!ELEMENT description (#PCDATA)>
59 <!ATTLIST description xml:lang CDATA #IMPLIED>
60 <!ELEMENT requires-items (#PCDATA)>
61 <!ELEMENT exclude-items-by-default (#PCDATA)>
62 <!ELEMENT include-items-by-default (#PCDATA)>
63 <!ELEMENT exclude-items-always (#PCDATA)>
64 <!ELEMENT exclude-binary-items ("yes"|"no")>
65 <!ELEMENT minimal-rating ("0"|"1"|"2"|"3"|"4")>
66 <!ELEMENT gui-review-elements ("yes"|"no")>
67 <!ELEMENT support-restricted-access ("yes"|"no")>
68 <!ATTLIST support-restricted-access optionname CDATA #IMPLIED>
69 <!ELEMENT options (option*,advanced-options)>
70 <!ELEMENT advanced-options (option)*>
71 <!ELEMENT option (label+,description+,note-html+,allow-empty?,default-value?)>
72 <!ATTLIST option type (text|bool|password|number|hint-html) #REQUIRED
73 name CDATA #REQUIRED>
74 <!ELEMENT label (#PCDATA)>
75 <!ATTLIST label xml:lang CDATA #IMPLIED>
76 <!ELEMENT note-html (#PCDATA)>
77 <!ATTLIST note-html xml:lang CDATA #IMPLIED>
78 <!ELEMENT allow-empty ("yes"|"no")>
79 <!ELEMENT default-value (#PCDATA)>
80 <!ELEMENT requires-details ("yes"|"no")>
81 name
83 User visible name of event
84 description
86 User visible description
87 exclude-items-by-default
89 Comma separated names of excluded problem elements. User can
90 include any of these elements if he wishes it.
91 include-items-by-default
93 Comma separated names of included problem elements. User can
94 exclude any of these elements if he wishes it.
95 exclude-items-always
97 Comma separated names of included problem elements. User cannot
98 include any of these elements.
99 exclude-binary-items
101 If "yes" then all binary problem elements are excluded. User can
102 include them if he wishes it.
103 minimal-rating
105 Minimal backtrace rating required for executing the event.
106 Backtrace rating is a measure of backtrace usability and
107 understandability. With an increasing number of unresolved frames
108 the backtrace rating gets lower values.
109 gui-review-elements
111 If "yes", user must explicitly approve that all included problem
112 elements can be published. If "no", the event is executed
113 automatically. If not provided, "yes" is expected.
114 support-restricted-access
116 If "yes", the UI tools will offer the users to enter the new report
117 with restricted access. If "no", the UI tools will never offer the
118 users to enter the report with restricted access. "no" is the
119 default value. The element should have one argument named
120 optionname which defines name of an option holding configuration of
121 the restricted access feature. The option must of bool type.
122 advanced-options
124 List of options which are hidden in the default view.
125 label
127 Event option label
128 note-html
130 Event option HTML formatted description
131 allow-empty
133 Determines if user can leave the option empty
134 default-value
136 A value which is used by default
137 option:name
139 Name of exported environment variable name. libreport tools
140 communicate through Environment Variables.
141 requires-details
143 If "yes", the UI tools will offer the users to fill "comment",
144 "reproducer" and "reproducible" during a reporting. If "no", only
145 "comment" will be offered to fill.
146
148 EVENT=post-create analyzer=Python abrt-action-analyze-python
149 EVENT=post-create
151 getent passwd "`cat uid`" | cut -d: -f1 >username
152
154 abrtd(8)
155
157 Manual page written by Denys Vlasenko <dvlasenk@redhat.com[1]>.
158
160 1. dvlasenk@redhat.com
161 mailto:dvlasenk@redhat.com
162LIBREPORT 2.12.0 03/20/2020 REPORT_EVENT.CONF(5)