Alfresco Support Tools for the Admin Console (Alfresco 4.2.x)
FreeMarker JavaScript Java HTML
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
resources/JMXloger
src
tomcat
.gitattributes
.gitignore
Thread Sampler Standalone.htm
license.md
pom.xml
readme.md

readme.md

Alfresco Support Tools

This add-on has been designed to work only in Alfresco Enterprise 4.2.x or above using JDK7 and Tomcat7. This provides the Alfresco Admin a set of tools to help troubleshoot performance issues (also tested on Alfresco Enterprise 5.0.x versions has not found any incompatibilities). It does not work on Alfresco Community Edition due the lack of JMX connectivity. From the client side has been tested to work with current versions of Firefox, IE and Chrome only.

Download

It's possible to download all source / binary releases from the Alfresco Artifact repository here.

Also the latest snapshop build can be downloaded from [http://github.com/Alfresco/alfresco-support-tools/releases] (http://github.com/Alfresco/alfresco-support-tools/releases)

Usage with Maven

If you are using Maven you can retrieve the AMP by:

  1. Adding https://artifacts.alfresco.com/nexus/content/groups/public/ repository to your pom.xml
  2. Check what's the latest version available by searching the repository
  3. Adding the following dependency to your POM: (latest version: 1.11 at the time of this writing)
```xml
org.alfresco.support support-tools 1.11 amp ``` *NOTE*: You can also directly install the AMP in your WAR using the Maven Alfresco SDK, see [details here](https://artifacts.alfresco.com/nexus/content/groups/public/alfresco-lifecycle-aggregator/latest/plugins/alfresco-maven-plugin/advanced-usage.html).

Installation

There are two options to install the tools using the AMP: the standard and the hot deploy.

1. Standard

  • Place the support-tools-*.amp file into your Alfresco amps folder
  • Run the script: bin/apply_amps.[sh|bat] with the -force switch.

Alternatively it is possible to:

  • Execute the following command (amending the paths to your case):

    	java -jar ./bin/alfresco-mmt.jar install ./amps/ ./tomcat/webapps/alfresco.war -force -verbose
    
  • Clean out the currently deployed web application by removing :

    • the folder "tomcat/webapps/alfresco/" and all its content
    • all the files and subfolders in tomcat/work/*
    • all the files and subfolders in tomcat/temp/*

2. Hot-Deploy

This method lets you use the tool without rebooting your application server. * Execute the following command (amending the paths to your case):

		java -jar ./bin/alfresco-mmt.jar install ./amps/support-tools.amp ./tomcat/webapps/alfresco -force -verbose -nobackup

	Be aware it is mandatory to point the installation to the alfresco webapp folder, differently from the war used at point 1, and to use the **-nobackup** switch. 

* Reload webscripts by going to:

		http:[host]:[port]/alfresco/service/index

* click on _"Refresh Web Scripts"_

Important Note: There are 2 scripts that would not work with the Hot-Deploy: The Tail-Log tool won't cache log entries until the next restart and the JMX settings needs a custom class to inspect the current persisted values on the DB. The rest of the webscripts will work ok.

Usage

Go to the URL

http:[host]:[port]/alfresco/s/enterprise/admin/

New scripts will appear under the Support Tools section.

This wiki page explains how to use each one of the tools:

Acknowledgments:

Special thanks to:

  • Mike Farman for his support on this project and parts of the code.
  • Marco Mancuso for his help on the development and adapting it to Maven standards.
  • Jamie Allison for his code review, "polish" and improvements.
  • Will Abson for his useful advice.
  • The Smoothie Charts creators: http:smoothiecharts.org/ the library from which was quite useful and fun to use
  • Rich McKnight for his JMX persisted values contribution to find on an easier mode what is overriden from the db.
  • Craig Tan for his code fixing.

Version history

1.0 Initial Working version, some UI adjustments needed
1.1 Code Reviewed and commited to GitHub
1.2 UI improvements by Jamie Allison, added ajax to some webscripts for automation ("Active Sessions")
Changed the general aspect of the "Scheduled Jobs" section, New tabs abd buttons on "Threaddumps"
Automated dist generation with Ant.
1.3. Added filesaver.js to fix the "save all" problem with IE8
1.3.1. Error in build xml caused to distribute jmxlogger library on 2 different locations, fixed
1.4. Added 2 new tools:
* Hotthreads: to detect which thread is consuming more CPU time.
* JMX Settings: to find which beans have values overriden from the DB and revert them.
1.4.1 Bugfix for HotThreads, missing hotthread ids caused an error.
1.4.2 Bugfix for Activesessions, missing properties my cause display error on freemarker.

1.5. Change on the folder Structure and added pom.xml to be Maven compliant.

1.6. New Utility: ThreadSampler, an integrated thread analyser tool that allows to generate and save thread execution reports.

1.7 New Utility: ThreadPofiler, integrated thread tool performance monitor.

1.8 Bugfixing and code improvements.

1.9 Bugfixing and compatiblility testing for Alfresco 5.1

1.10 Bugfixing and Enhancements on Active Sessions and Thread Sampler

1.11 Code reviewed and Tail tool adapted to support SAML logging

License

Copyright (c) 2013, Alfresco Software Ltd. October 2013

Author: Antonio Soler, antonio.soler@alfresco.com

Alfresco is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Alfresco is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. See http:www.gnu.org/licenses/.

THIS SOFTWARE IT IS NOT DIRECTLY SUPPORTED OR MAINTAINED BY ALFRESCO LTD. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.