15
Soapower Documentation Release 1.2.0 Yvonnick Esnault October 02, 2014
Soapower DocumentationRelease 1.2.0
Yvonnick Esnault
October 02, 2014
Contents
1 Overview 3
2 Screenshots 52.1 Live Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62.2 Search Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62.3 Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62.4 Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62.5 Environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62.6 Edit an environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62.7 Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62.8 Edit a service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3 Quickstart 73.1 Check Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73.2 Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4 Usage 94.1 Send a request on a service already configured . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94.2 Send a request on a service not configured . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94.3 Jenkins Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5 Development 11
i
ii
Soapower Documentation, Release 1.2.0
Contents:
Contents 1
Soapower Documentation, Release 1.2.0
2 Contents
CHAPTER 1
Overview
What’s Soapower ?
Soapower provides a GUI for
• viewing webservices requests (live and search page),
• download the data from the request and response,
• getting response time,
• viewing 90percentiles response times, etc ...
• Soapower allows monitoring several applications across multiple environments.
It is also possible to set a threshold response time on soapaction, the alerts are rising if the receiver does not send theresponse back in time.
Administration interface is available for
• Configure environments and webservices (local / remote target / timeout)
• Set the thresholds for response time for each serviceaction
• Import / export service configurations & settings
• Set the purges data Content Data requests & Answers, All Data / environment
• Monitoring CPU / Heap Memory / logs file
3
Soapower Documentation, Release 1.2.0
4 Chapter 1. Overview
5
Soapower Documentation, Release 1.2.0
CHAPTER 2
Screenshots
2.1 Live Page
2.2 Search Page
2.3 Analysis
2.4 Monitoring
2.5 Environments
2.6 Edit an environment
2.7 Services
2.8 Edit a service
6 Chapter 2. Screenshots
CHAPTER 3
Quickstart
You have to use docker to run Soapower.
docker run -i -d -p 49010:9010 --privileged -t -v /data/soapower/mongodb:/data/db-v /data/soapower/backups:/opt/soapower/backups yesnault/docker-soapower:215
3.1 Check Installation
• Go to http://localhost:49010
3.2 Tips
• You can forward port of mongoDB -p 49011:29017
• There is a backup of configuration in directory /data/soapower/backups. The backup is made by a job in thecrontab (at 23h30)
• If you forward the ssh port -p 49012:22, you can connect to your container with :
ssh admin@localhost -p 49012 sudo su #to become root in the container
7
Soapower Documentation, Release 1.2.0
8 Chapter 3. Quickstart
CHAPTER 4
Usage
4.1 Send a request on a service already configured
• Register manually environment, then service
• Call http://<server>:<port>/soap/<environment>/<localTarget> for a SOAP service orhttp://<server>:<port>/rest/<environment>/<localTarget> for a REST service.
4.2 Send a request on a service not configured
Auto register SOAP service by calling http://<server>:<port>/autosoap/<group>/<environment>/<remoteTarget>Auto register REST service by calling http://<server>:<port>/autorest/<group>/<environment>/<remoteTarget>
Example : http://localhost:9010/autosoap/myNewGroup/myNewEnvironment/http://localhost:8080/myWebservices
4.3 Jenkins Integration
If a ServiceAction’s response time is > threshold, a failed test is generate and visible on Jenkins.
• Create a job, with a shell execution:
rm *.xml ; wget http://<server>:<port>/statsAsJunit/yesterday/yesterday/ -Oresult.xml
• Add a publish test Junit to view all ServiceAction’s result time.
• Url parameters : http://<server>:<port>/statsAsJunit/<minDate>/<maxDate>/ with min-Date / maxDate like : 2012-12-10T00:00, yesterday, today
• You can add extra parameters to the URL, three parameters can be set : treshold, environment and service.
Example : http://localhost:9010/statsAsJunit/group/yesterday/today?service=myService&environment=dev&treshold=10000This url create a Junit test that check if all actions result time of the ServiceAction ‘myService’ for the environment‘dev’ are lower than 10 000 ms. You can also test all services of an environment (without setting the serviceparameter) or test a specific service on all the environments (without setting the environment parameter).
9
Soapower Documentation, Release 1.2.0
10 Chapter 4. Usage
CHAPTER 5
Development
Go to https://github.com/soapower/soapower
11
