Changes for page Reporting Issues
Last modified by michelk on 2021/09/09 20:55
Summary
-
Page properties (4 modified, 0 added, 0 removed)
Details
- Page properties
-
- Parent
-
... ... @@ -1,0 +1,1 @@ 1 +Home - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki.mich aely1 +XWiki.michelk - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +favourite|report|issue|support|ticket|bug - Content
-
... ... @@ -1,21 +1,28 @@ 1 - 1 +{{layout}} 2 +{{layout-section ac:type="two_right_sidebar"}} 3 +{{layout-cell}} 4 +This article outlines the procedure for reporting issues you experience with iSymphony, along with information that is required for our support staff to troubleshoot issues effectively. When reporting issues, providing as much information as possible can expedite issue resolution. 2 2 3 - **//Onthis page~://**6 += Creating Tickets = 4 4 8 +All bug reports and issues should be reported via our [[Ticket System>>url:http://www.getisymphony.com/support||shape="rect"]]. 5 5 10 += Description = 6 6 7 -{{toc/}} 12 +Make sure to include a detailed description of the bug/issue and what you were doing to cause it. Also include the time the bug occurred if possible. Be as detailed as possible. 13 +{{/layout-cell}} 8 8 9 -This article outlines the procedure for reporting issues you experience with iSymphony, along with information that is required for our support staff to troubleshot issues effectively. When reporting issues, providing as much information as possible can expedite issue resolution. 15 +{{layout-cell}} 16 +**//On this page~://** 10 10 11 -= Creating Tickets = 12 12 13 -All bug reports and issues should be reported via our [[Ticket System>>url:http://www.getisymphony.com/support||shape="rect"]]. 14 14 15 -= Description = 20 +{{toc maxLevel="2"/}} 21 +{{/layout-cell}} 22 +{{/layout-section}} 16 16 17 - Make sure toinclude a detailed descriptionof the bug/issueand whatou were doing to causeit. Also include the time the bugoccurred if possible. Be as detailed as possible.18 - 24 +{{layout-section ac:type="single"}} 25 +{{layout-cell}} 19 19 = Transferring Files = 20 20 21 21 In most cases, support representatives will require files from your server in order to troubleshoot issues. You can utilize SCP to download the files onto your personal machine. Once the files are on your personal machine, you can attach them in a new ticket or in a reply to an existing ticket. ... ... @@ -46,10 +46,10 @@ 46 46 47 47 = Support Packages = 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 ssupport package is easy, and can be done from the Administration Interface or the server command line.56 +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 a support package is easy, and can be done from the Administration Interface or the server command line. 50 50 51 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. 59 +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>>doc:||anchor="Manual Collection"]]section below. 53 53 {{/note}} 54 54 55 55 == Creating Support Packages from the Administration Interface == ... ... @@ -57,24 +57,24 @@ 57 57 iSymphony provides an easy to use interface that allows administrators to create, and download, support packages directly from the Administration interface. 58 58 59 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 67 +If you cannot access the Administration interface, due to issues with the application, see [[Creating Support Packages from the Command Line>>doc:||anchor="Creating Support Packages from the Command Line"]]below 61 61 {{/note}} 62 62 63 63 1. Log into the Administration Interface. See [[doc:Connecting to the Administration Interface]]. 64 64 1. ((( 65 -Select 72 +Select **Global Configuration** at the top right hand corner of the Administration Interface. 66 66 67 67 {{info}} 68 68 Only super Administrators have access to the Global Configuration section. See [[doc:Administrators]] for more information. 69 69 {{/info}} 70 70 ))) 71 -1. Under **Create Support Package**, select the information you wish to be included in inthe package. The default selection is usually sufficient.72 -1. Click 73 -1. Once the package has been created you can use the **Download** 78 +1. Under **Create Support Package**, select the information you wish to be included in the package. The default selection is usually sufficient. See [[Package Options>>doc:||anchor="Package Options"]] below for more detail on what each option includes in the package. 79 +1. Click **Create**. 80 +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 74 75 75 == Creating Support Packages from the Command Line == 76 76 77 -If you are unable to access the Administration Interface, you can create support packages from the server command line by executing the 84 +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 78 79 79 1. Log into the server via SSH or a terminal. 80 80 1. ((( ... ... @@ -85,7 +85,7 @@ 85 85 {{/code}} 86 86 87 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. 95 +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>>doc:||anchor="Package Options"]]section below. 89 89 {{/info}} 90 90 ))) 91 91 1. ((( ... ... @@ -95,11 +95,13 @@ 95 95 /opt/isymphony3/server/support 96 96 {{/code}} 97 97 98 -You will need to download the file from the server to your machine. See Transferring Files above. 105 +You will need to download the file from the server to your machine. See [[Transferring Files>>doc:||anchor="Transferring Files"]] above. 99 99 ))) 100 100 101 101 == Package Options == 102 102 110 +Details concerning what information is included with each package option can be found in the table below. 111 + 103 103 |=((( 104 104 Admin Option 105 105 )))|=((( ... ... @@ -150,11 +150,14 @@ 150 150 -e 151 151 )))|((( 152 152 * The process id of the running iSymphony server installation, if the server is running. 162 +* The **/opt/isymphony3/server/jvm.args** file. (JVM arguments) 153 153 * The contents of** /proc/cpuinfo. **(Processor information) 154 154 * The contents of **/proc/meminfo**. (Memory Information) 155 -* The results of running the command **free -m**. 156 -* The results of running the **netstat -lanp** command. 157 -* A snapshot of the **top** command. 165 +* The results of running the command **free -m**. (Memory Information) 166 +* The results of running the **netstat -lanp** command. (Open socket information) 167 +* A snapshot of the **top** command. (Current running process information) 168 +* The results of running the **uname -a** command. (OS and architecture information) 169 +* The results of running the **java -version** command. (Java JRE information) 158 158 ))) 159 159 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) 160 160 ((( ... ... @@ -163,7 +163,7 @@ 163 163 ((( 164 164 -c 165 165 )))|((( 166 - 178 +* All configuration files in **/opt/isymphony3/server/conf**. 167 167 ))) 168 168 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) 169 169 ((( ... ... @@ -172,7 +172,14 @@ 172 172 ((( 173 173 -p 174 174 )))|((( 175 - 187 +* The **manager.conf** or **manager_additional.conf** file. (Asterisk AMI connection information) 188 +* Results from running the command **asterisk -rx "core show version"**. (Asterisk version information) 189 +* Results from running the command **asterisk -rx "sip show peers"**. (Asterisk SIP peer information) 190 +* Results from running the command **asterisk -rx "pjsip show endpoints"**. (Asterisk PJSIP peer information) 191 +* Results from running the command **asterisk -rx "core show channels"**. (Asterisk active channel information) 192 +* Results from running the command **asterisk -rx "queue show"**. (Asterisk queue information) 193 +* Results from running the command **asterisk -rx "confbridge list"**. (Asterisk app_confbridge room information) 194 +* Results from running the command **asterisk -rx "meetme list"**. (Asterisk app_meetme room information) 176 176 ))) 177 177 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) 178 178 ((( ... ... @@ -181,7 +181,7 @@ 181 181 ((( 182 182 -d 183 183 )))|((( 184 - 203 +* iSymphony internal database files. (Call history, notification, and saved client session infomration) 185 185 ))) 186 186 187 187 ... ... @@ -192,7 +192,7 @@ 192 192 193 193 == Logs == 194 194 195 -Include all log files from 214 +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 198 tar -zcvf islogs.tar.gz /opt/isymphony3/server/log ... ... @@ -230,6 +230,15 @@ 230 230 source /opt/isymphony3/server/config-vars.sh && ${JAVA_HOME}/bin/java -version 231 231 {{/code}} 232 232 252 += Heap Dumps = 253 + 254 +In certain circumstances our support team may ask for a heap dump. This dump allows us to inspect the memory of your iSymphony application. Heap dumps can be created with the jmap utiltily. 255 + 256 +jmap's documentation can be found on the oracle web site: see: [[http:~~/~~/docs.oracle.com/javase/7/docs/technotes/tools/share/jmap.html>>url:http://docs.oracle.com/javase/7/docs/technotes/tools/share/jmap.html||shape="rect"]] 257 + 258 +If you are using OpenJDK (as bundle with e.g. FreePBX) you will need to install openjdk-debuginfo. For FreePBX (Centos based) the version of debug info can be downloaded here: 259 +[[http:~~/~~/debuginfo.centos.org/6/x86_64/>>url:http://debuginfo.centos.org/6/x86_64/||shape="rect"]] 260 + 233 233 = Extra Information For UI Issues = 234 234 235 235 If you encounter a bug/issue with display in the client or administrator (i.e. UI not drawing correctly, phone state not showing what it should, ect.) Try the following steps to attempt to correct it. Please included which step, if any, resolved the issue in your issue report. This will give us a general idea of where the issue exists in the Application. ... ... @@ -236,7 +236,7 @@ 236 236 237 237 1. First try a refresh of the page to see if that corrects the issue. 238 238 1. ((( 239 -If the refresh does not work try a restart of the client application by appending 267 +If the refresh does not work try a restart of the client application by appending **?restartApplication** to the end of the URL and hitting enter. 240 240 241 241 {{info}} 242 242 Remove the **?restartApplication** from the URL once you have used it or else subsequent page refreshing will restart the application. ... ... @@ -247,3 +247,6 @@ 247 247 = Extra Information For FreePBX Module Issues = 248 248 249 249 If you are using the iSymphony FreePBX Module and you are having issues with configuration syncing between the iSymphony FreePBX Module and the iSymphony Server you will want to add the module debug information to your ticket. See [[doc:FreePBX Module Administration]] for more information on how to acquire the module debug contents. 278 +{{/layout-cell}} 279 +{{/layout-section}} 280 +{{/layout}}