Skip to content

Commit

Permalink
Readme file changes
Browse files Browse the repository at this point in the history
  • Loading branch information
shagihan committed Mar 26, 2021
1 parent 7de9841 commit 8734216
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ This repo contains the tools, utilities and some usefull commands help to troubl

## Table of contents

- [Database response time mesuring tool](database-response-timing/README.md)
- [HTTP/HTTPS endpoint response time mesuring tool](http-response-timing/README.md)
- [Script to get thread dumps](scripts-and-commands/thread-dump/README.md)
- [Database response time mesuring tool](database-response-timing/)
- [HTTP/HTTPS endpoint response time mesuring tool](http-response-timing/)
- [Script to get thread dumps](scripts-and-commands/thread-dump/)
- [Usefull keytool and OpenSSL Commands](scripts-and-commands/keytool-openssl-commands/README.md)
- [Simple TCP proxy simulating delays in network](https://github.com/ruwanta/delaying-proxy)
- [Decrypt and re-encrypt entries in database with new algorhythm or key](https://github.com/shagihan/token-migrator)
14 changes: 7 additions & 7 deletions database-response-timing/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Database Response Timing Tool

###Introduction
### Introduction

Purpose of this DBClient is to isolate whether DB becoming a performance bottleneck in production deployment.
(It's not possible to enable JDBC spy logs in production systems, since it need some config file changes and server
Expand All @@ -17,15 +17,15 @@ Note:
You need to have idea on the issue that you are going to isolate and define the SQL query as relevant for that.
eg: Token generation, Registry, JDBC user store issues need to pick the query as relevant for each.

###How to build ?
### How to build ?

1. Checkout the source and execute following command from the project home folder (database-response-timing)

```mvn clean install```

2. Build zip (database-response-timing-1.0.0-bundle.zip) will available in project target directory, once build is success.

###How to execute the client ?
### How to execute the client ?
1. Copy *database-response-timing-1.0.0-bundle.zip* to intended location and unzip the file ```unzip ./database-response-timing-1.0.0-bundle.zip -d .```

2. Update the [application.yaml](#application.yaml) file with correct configs.
Expand Down Expand Up @@ -55,7 +55,7 @@ eg: Token generation, Registry, JDBC user store issues need to pick the query as
2021-03-16 11:10:44 [main] INFO o.w.d.d.DatabaseResponseTimingApplication - Started DatabaseResponseTimingApplication in 3.03 seconds (JVM running for 3.733)
```

###application.yaml
### application.yaml

This file contains all the configurations needed to be made in order to run the tool timing tool. Following is a sample configuration file, Which configured to connect mysql database.

Expand Down Expand Up @@ -93,19 +93,19 @@ logging:
org.wso2.diagnose.databaseresponsetiming: INFO
```

####Datasource
#### Datasource

Configurations related to the database connection, [Please refer](https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-application-properties.html#common-application-properties-data) for all database related configs.

And we can specify the Tomcat JDBC configurations under *tomcat* tag, Refer [Please refer](https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-application-properties.html#spring.datasource.tomcat) for all JDBC configs.

####testconfig
#### testconfig
- totalIterations - Number of total iterations' database connection runs.
- iterationsPerConnection - Number of total iterations' runs with a single db connection.
- sleepTime - Sleep after complete one iteration (Default 0)
- query - SQL Query to execute.

####logging
#### logging
Logging related configs, [Please refer](https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-application-properties.html#logging.charset.console) for more information.


2 changes: 1 addition & 1 deletion scripts-and-commands/thread-dump/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This shell script facilitate to get multiple thread dumps within a specified time period

###How to get ?
### How to get ?

Taking 4 thread dumps in one minute interval for java process with pid 1234.
```
Expand Down

0 comments on commit 8734216

Please sign in to comment.