restcomm / perfcorder Goto Github PK

View Code? Open in Web Editor NEW

6.0 26.0 9.0 5.47 MB

Java Performance Recording and Analysis Tool

Home Page: http://www.restcomm.com/

License: GNU Affero General Public License v3.0

Java 78.69% HTML 1.04% Shell 9.11% XSLT 11.04% Awk 0.12%

perfcorder's Introduction

Try Restcomm Cloud NOW for FREE! Zero download and install required.

All Restcomm docs and downloads are now available at Restcomm.com.

#PerfCorder

PerfCorder allows you to record and analyse data during performance testing using Sipp tool. It is specifically oriented to monitor a Java process that is processing the SIP signalling.

The tool is based on Bash scripts, that allows you to start and stop the recording whenever you like.

The recording will include performance information about the system (io, cpu, VM, net) and the java process (GC....).

Since the environment you are using to do the performance testing is as important as the performance data, several meta data is also saved (java opts,start/end timestamp..).

Analyse target will create stats and graphs about the recorded data to help you interpreting the performance test results.

Finally the tool will package all the collected and analysed data into a single zip file.

The tool encourages a default directory layout following Maven convention over configuration principles. This is the current dir layout:

target

--->data

    --->meta (decicated to save information about the performance test itself)

        ---><start/endTime>

        ---><copyOfsippScript>

        ---><jar files mounted by java process>

        ---><JVM options used to start the java process>

    --->conf (save files that change java process behavior)

    --->periodic (save perf data every N seconds)

        --->sys

            --->iostat/vmstat/netstat

        --->java
            ---> GCCollection

            ---> jstat

            ---> CPU/Mem/GC CPU
        --->sip

            ---> sipp_stat.csv

            ---> sipp_rtt.csv

perfcorder's People

Contributors

Stargazers

Watchers

Forkers

jaimecasero gitter-badger nagyistge kleopatra999 abdulazizali77 fossabot yulianoifa-mobius isabella232

perfcorder's Issues

Introduce CapturePID mode

In this mode instead of an existing PID, an expression/command to find a PID will be passed. PerfCorder will try to find a PID using this command for a period of time. If found, regular collection will be started.

Default time to settle down is not overridden in pc_stop_collect.sh

When the parameter -s is informed followed by a specific value like -s 360, the default value 180 is not overridden by 360. This may be caused by a missing option s: inside the getopts configuration: https://github.com/RestComm/PerfCorder/blob/master/src/main/resources/pc_stop_collect.sh#L91

Let analysis take a parameter to strip sample at the beginning/end using a percentage

Using a percentage of total samples will be better, facilitating different test durations, hence different number of samples collected (even different files with different polling semantics)

Add wireshark capturing option

It wuold be great to have an option to enable netwrok capture option to the compressed file. It should be optional, so a performance test is not greatly impacted.

Save environment variables into results

allow targets definition to be externalized

possibly pass an xml file with targets definition. If not passed, used default one.

Create diff script to compare two different collection data

show results in HTML

add start/stop hooks

user may want to extend the tool with external scripts. Those scripts will be called during perfcorder lifecycle....

potentially provide beforeStart/AfterStart beforeStop/AfterStop

create wrapping script to collect all data from a test

Mark stats start/end boundaries in graphs

So we know viasually which part of the graphs are taken into account for stats

allow Perfcorder to be used from different directory than current

Possibly introduce a PERFCORDER_HOME env variable...

Allow to suggests per measurement y-axis scale

Now depending on actual samples defined the y-axis scale is fixed to accomodate the values. This behavior makes harder to compare same graph from different collections, where sample values differ a lot...

Take Sip response time from stat file rather than rtt

add jmeter csv file analysis

Add percentiles 5,25,50,75,95 to the stats file

add first line describing columns to all Java tools

Remove configurable warmpUp/end set

Allow configurable number of samples to truncate at the beginnig and end. Potentially delivering both stats with and without these samples....

Specify collection interval on graph

This should be a caption on graph to indicate the x-axis scale. This will allow to identify possible deviation on comparing graphs from different collections..

Allow perfcorder to be run several times

Current impl uses killall,instead of kill with proper PID. This may prevent having several perfcorder instances with same user...

Show HTML by category/protocol

http://stackoverflow.com/questions/16606883/xpath-expression-to-find-values-that-start-with

Turn collect script into bash, Ant is providing more issues

Ant is providing issue on how:
-spawn java process and redirectons
-spawn bash procdess and redirections

overall this is decreasing debuggabilty of the tool

Implement auto meas including HTML generation

currently the HTML generated meas are hardcoded in template...

Fix html graphs timescale

The graphs doesnt show the samples in graphs properly, with respec to Meas collection interval. Since the default interval is 4 seconds, graphs appear as if the run was too short....

Add memory heap dump option to the stop action

An option would be usefull to tkae a heap dump when stopping the data collection

save sipp stats and response time files when stopping

Reflect proper time on HTML generated graphs

Create measurement for object histogram,so we can assert on remaining objets

This could be accomplished by creating more meas from histogram file, using key as the object name, and count as the number of instances. Then regular test assertion based on current XSLT template would be possible

ForceGC option is invoked after killing monitoredApps so no clue on data

maybe it would make more sense to call before actually killing the monitoring tools so the mem after full gc may be recorded by monitored tools

allow external files to be added to the perfcorder collection

Configuration must allow to define local/remote files to be included in the zip file during stop. Assuming an external entity has collected those files.

Support for scp copy transfer should be allowed

This is to support files coming from other areas not related to the monitored java process, but related to the overall performance test

add number of live objects measurement

jcmd $RESTCOMM_PID GC.class_histogram | grep org.mobicents.servlet.restcomm >> $JMAP_DIR/restcomm_mem
let package name be an input argument

Add force gc option while stopping collection

Some measurements maybe affected by GC. This should happen after collection stop, to prevent the GC to go the data (potentially skipped by trimming range)

create jenkins plugins so integration is seamless

Allow SMPP measurements from client app

related to RestComm/smscgateway#99

Add GC pause measurements/stats/graphs

Add documention for test stylesheet, and how to add new test goals

Create war deployment allowing local collection...

Explaing setup process with more details

the CLI and java App duality makes the setup process confusing. Detail how different jar files are meant to be used...

Allow meas to be grouped by categories on reports

Redirect collection problems to a single loc for easy debugging on setup

Sometimes internal tools fail silently making diagnosis tricky

Allow csv columns to be configured using name

Some CSV files are not fixed in terms of columns (sipp stats depends on response time configuration), so the column index may mistmatch the intented values. Assuming the first row contains column names, it would be useful to check the column index by name, and then use that index.

Add support to JMeter summary file

Allow different processes to be monitored

Sometimes we need to monitor several process, during the test, current version just allow one PID....

ideally support the same measurement by adding a sequenced suffix _

Allow use of PERFCORDER_HOME env var

Optionally support a HOME var to allow execution from any directory,instead of perfcorder dir as current dir. If var exists will be used, if not revert to current behavior...

Create web version to have a cloud deployment

Publish REST API allowing:
-Push collected ZIP files.
-Request analysis of collected files.
-Test analysis files against Perf Goals (input xsl, output Juni XML report XML)
-Request diff of different collected files

make scripts independent of jar version

Add server logs saving option

An option to save server logs files, and include them in compressed file would be handy.

create analyze script to create graphs and stats

Requird stast for all collected adta:min,max,avg,dev,median

Allow measurements supported by aux timestamp column

Allow perfcorder to be instructed on how much time to wait before actually stopping collection

A common requirements is to let the loaded process to settle resource consumption after stopping the load traffic. Perfcorder could accept a parameter to allow this waiting time to happen built-in as pc_stop_collect script, so the resource consupmtion during settle down phase could be collected as well