Changes for page Reporting Issues

Last modified by michelk on 2021/09/09 20:55

From version 20.1
edited by michaely
on 2021/09/09 18:01
Change comment: Import
To version 23.1
edited by michaely
on 2021/09/09 18:01
Change comment: Import

Summary

Details

Page properties
Content
... ... @@ -44,154 +44,8 @@
44 44  
45 45  Once executed, the command will prompt you for the root user password.
46 46  
47 -= Support Packages =
47 += Logs =
48 48  
49 -iSymphony now allows administrators to create support packages which contain useful information about the system. These packages are used by our support team to expedite the troubleshooting process. Creating s support package is easy, and can be done from the Administration Interface or the server command line.
50 -
51 -{{note}}
52 -The ability to create support packages is only available in iSymphony 3.3+. If you are using a version of iSymphony prior to 3.3, see the Manual Collection section below.
53 -{{/note}}
54 -
55 -== Creating Support Packages from the Administration Interface ==
56 -
57 -iSymphony provides an easy to use interface that allows administrators to create, and download, support packages directly from the Administration interface.
58 -
59 -{{note}}
60 -If you cannot access the Administration interface, due to issues with the application, see Creating Support Packages from the Command Line below
61 -{{/note}}
62 -
63 -1. Log into the Administration Interface. See [[doc:Connecting to the Administration Interface]].
64 -1. (((
65 -Select **Global Configuration** at the top right hand corner of the Administration Interface.
66 -
67 -{{info}}
68 -Only super Administrators have access to the Global Configuration section. See [[doc:Administrators]] for more information.
69 -{{/info}}
70 -)))
71 -1. Under **Create Support Package**, select the information you wish to be included in in the package. The default selection is usually sufficient.
72 -1. Click **Create**.
73 -1. Once the package has been created you can use the **Download** button to download the package to your system and attach it to a support ticket.
74 -
75 -== Creating Support Packages from the Command Line ==
76 -
77 -If you are unable to access the Administration Interface, you can create support packages from the server command line by executing the **support.sh** script. You can specify several parameters to tell the script which pieces of information to include in the package.
78 -
79 -1. Log into the server via SSH or a terminal.
80 -1. (((
81 -Run the following command:
82 -
83 -{{code language="bash"}}
84 -/opt/isymphony3/server/support.sh
85 -{{/code}}
86 -
87 -{{info}}
88 -The above command will package all information. If you wish to specify the information that is included in the package you can use the flags specified in the Package Options section below.
89 -{{/info}}
90 -)))
91 -1. (((
92 -Once the script has generated the package it can be found in the following directory on the server:
93 -
94 -{{code}}
95 -/opt/isymphony3/server/support
96 -{{/code}}
97 -
98 -You will need to download the file from the server to your machine. See Transferring Files above.
99 -)))
100 -
101 -== Package Options ==
102 -
103 -|=(((
104 -Admin Option
105 -)))|=(((
106 -Script Flag
107 -)))|=(((
108 -Includes
109 -)))
110 -|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
111 -(((
112 -Application Logs
113 -)))|(% style="text-align: center;" %)(% style="text-align: center;" %)
114 -(((
115 --l
116 -)))|(((
117 -* All files in the **/opt/isymphony3/server/log** directory. Excludes any archived (tar.gz) logs.
118 -)))
119 -|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
120 -(((
121 -Archived Logs
122 -)))|(% style="text-align: center;" %)(% style="text-align: center;" %)
123 -(((
124 --a
125 -)))|(((
126 -* All archived log files (tar.gz) in the **/opt/isymphony3/server/log** directory.
127 -)))
128 -|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
129 -(((
130 -Thread Dump
131 -)))|(% style="text-align: center;" %)(% style="text-align: center;" %)
132 -(((
133 --t
134 -)))|(((
135 -* Generates a dump of all active threads in the JVM instance and writes it to the **/opt/isymphony3/server/log/iSymphonyServer.out.log** file.
136 -
137 -{{note}}
138 -A thread dump will not be generated if the iSymphony server process is not running.
139 -{{/note}}
140 -
141 -{{note}}
142 -Application logs must be included in order to include the thread dump in the package.
143 -{{/note}}
144 -)))
145 -|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
146 -(((
147 -Environment Information
148 -)))|(% style="text-align: center;" %)(% style="text-align: center;" %)
149 -(((
150 --e
151 -)))|(((
152 -* The process id of the running iSymphony server installation, if the server is running.
153 -* The contents of** /proc/cpuinfo.**
154 -* The contents of **/proc/meminfo**.
155 -* The results of running the command **free -m**.
156 -* The results of running the ~{~{
157 -* A snapshot of the **top** command.
158 -)))
159 -|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
160 -(((
161 -Configuration Files
162 -)))|(% style="text-align: center;" %)(% style="text-align: center;" %)
163 -(((
164 --c
165 -)))|(((
166 -
167 -)))
168 -|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
169 -(((
170 -PBX Configuration
171 -)))|(% style="text-align: center;" %)(% style="text-align: center;" %)
172 -(((
173 --p
174 -)))|(((
175 -
176 -)))
177 -|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
178 -(((
179 -Database Files
180 -)))|(% style="text-align: center;" %)(% style="text-align: center;" %)
181 -(((
182 --d
183 -)))|(((
184 -
185 -)))
186 -
187 -
188 -
189 -= Manual Collection =
190 -
191 -If you are using a version of iSymphony prior to 3.3, you can use the following instructions to collect system information to report to the iSymphony support team.
192 -
193 -== Logs ==
194 -
195 195  Include all log files from **/opt/isymphony3/server/log** in the ticket. You can make a archive of the logs via the following command.
196 196  
197 197  {{code language="bash"}}
... ... @@ -198,11 +198,11 @@
198 198  tar -zcvf islogs.tar.gz /opt/isymphony3/server/log
199 199  {{/code}}
200 200  
201 -== Environment Information ==
55 += Environment Information =
202 202  
203 203  In many cases it is useful for our support team to know details of the hardware, OS, and JRE used to run iSymphony.
204 204  
205 -=== Operating System Details ===
59 +== Operating System Details ==
206 206  
207 207  You can acquire basic OS information by running the following command on your server's command line:
208 208  
... ... @@ -210,7 +210,7 @@
210 210  uname -a
211 211  {{/code}}
212 212  
213 -=== Hardware Details ===
67 +== Hardware Details ==
214 214  
215 215  The following commands can be used to acquire details about the hardware installed on the server:
216 216  
... ... @@ -222,7 +222,7 @@
222 222  free -m
223 223  {{/code}}
224 224  
225 -=== JRE Version ===
79 +== JRE Version ==
226 226  
227 227  The following command can be used to acquire the version of the JRE iSymphony is utilizing:
228 228