Skip to content

Commit d55bbea

Browse files
authored
Merge pull request scouter-project#615 from scouter-project/master
doc merge master to develop
2 parents 561091e + 2e663e9 commit d55bbea

File tree

10 files changed

+37
-33
lines changed

10 files changed

+37
-33
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
![scouter](./scouter.document/img/main/scouter-logo-w200.png)
66

7-
[![Englsh](https://img.shields.io/badge/language-English-orange.svg)](README.md) [![Korean](https://img.shields.io/badge/language-Korean-blue.svg)](README_kr.md)
7+
[![English](https://img.shields.io/badge/language-English-orange.svg)](README.md) [![Korean](https://img.shields.io/badge/language-Korean-blue.svg)](README_kr.md)
88

99
## Application Performance Monitoring for Open Source S/Ws.
1010
SCOUTER is an open source APM like new relic and appdynamics.

scouter.document/main/Configuration.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -642,11 +642,11 @@
642642
public int xlog_error_sql_time_max_ms = 30000;
643643
@ConfigDesc("Leave an error message at XLog when UserTransaction's begin/end unpaired")
644644
public boolean xlog_error_check_user_transaction_enabled = true;
645-
@ConfigDesc("mark as error on xlog flag if SqlException is occured.")
645+
@ConfigDesc("mark as error on xlog flag if SqlException is occurred.")
646646
public boolean xlog_error_on_sqlexception_enabled = true;
647-
@ConfigDesc("mark as error on xlog flag if Api call errors are occured.")
647+
@ConfigDesc("mark as error on xlog flag if Api call errors are occurred.")
648648
public boolean xlog_error_on_apicall_exception_enabled = true;
649-
@ConfigDesc("mark as error on xlog flag if redis error is occured.")
649+
@ConfigDesc("mark as error on xlog flag if redis error is occurred.")
650650
public boolean xlog_error_on_redis_exception_enabled = true;
651651

652652
//XLog hard sampling options
@@ -765,7 +765,7 @@
765765
public String hook_get_connection_patterns = "";
766766

767767

768-
@ConfigDesc("IntialContext Class Set")
768+
@ConfigDesc("InitialContext Class Set")
769769
@ConfigValueType(ValueType.COMMA_SEPARATED_VALUE)
770770
public String hook_context_classes = "javax/naming/InitialContext";
771771

@@ -777,7 +777,7 @@
777777
@ConfigValueType(ValueType.COMMA_SEPARATED_VALUE)
778778
public String hook_method_ignore_prefixes = "get,set";
779779

780-
@ConfigDesc("Class set without Method hookingt")
780+
@ConfigDesc("Class set without Method hooking")
781781
@ConfigValueType(ValueType.COMMA_SEPARATED_VALUE)
782782
public String hook_method_ignore_classes = "";
783783

@@ -812,7 +812,7 @@
812812
@ConfigValueType(ValueType.COMMA_SEPARATED_VALUE)
813813
public String hook_jsp_patterns = "";
814814

815-
@ConfigDesc("Method set for preparestatement hooking")
815+
@ConfigDesc("Method set for preparedstatement hooking")
816816
@ConfigValueType(ValueType.COMMA_SEPARATED_VALUE)
817817
public String hook_jdbc_pstmt_classes = "";
818818

@@ -866,7 +866,7 @@
866866
@ConfigDesc("Deprecated. use hook_async_callrunnable_enabled")
867867
public boolean hook_async_callrunnable_enable = true;
868868

869-
@ConfigDesc("Hook callable and runnable for tracing async processing.\n It hook only 'hook_async_callrunnable_scan_prefixes' option contains pacakage or classes")
869+
@ConfigDesc("Hook callable and runnable for tracing async processing.\n It hook only 'hook_async_callrunnable_scan_prefixes' option contains package or classes")
870870
public boolean hook_async_callrunnable_enabled = true;
871871

872872
@ConfigDesc("scanning range prefixes for hooking callable, runnable implementations and lambda expressions.\n usually your application package.\n 2 or more packages can be separated by commas.")
@@ -880,13 +880,13 @@
880880
@ConfigDesc("PRE-released option before stable release!\nhook threadpool executor for tracing async processing.")
881881
public boolean hook_async_thread_pool_executor_enabled = false;
882882

883-
@ConfigDesc("Experimental! test it on staging environment of your system before enable this option.\n enable lambda expressioned class hook for detecting asyncronous processing. \nOnly classes under the package configured by 'hook_async_callrunnable_scan_package_prefixes' is hooked.")
883+
@ConfigDesc("Experimental! test it on staging environment of your system before enable this option.\n enable lambda expressioned class hook for detecting asynchronous processing. \nOnly classes under the package configured by 'hook_async_callrunnable_scan_package_prefixes' is hooked.")
884884
public boolean hook_lambda_instrumentation_strategy_enabled = false;
885885

886886
@ConfigDesc("")
887887
public String hook_add_fields = "";
888888
@ConfigDesc("")
889-
public boolean _hook_serivce_enabled = true;
889+
public boolean _hook_service_enabled = true;
890890
@ConfigDesc("")
891891
public boolean _hook_dbsql_enabled = true;
892892
@ConfigDesc("")
@@ -950,7 +950,7 @@
950950
@ConfigDesc("SFA thread dump Interval(ms)")
951951
public int sfa_dump_interval_ms = 10000;
952952

953-
//PSTS(Preiodical Stacktrace Step)
953+
//PSTS(Periodical Stacktrace Step)
954954
@ConfigDesc("Activating periodical stacktrace step (write fixed interval thread dump on a profile)")
955955
public boolean _psts_enabled = false;
956956
@ConfigDesc("PSTS(periodical stacktrace step) thread dump Interval(ms) - hard min limit 2000")
@@ -965,7 +965,7 @@
965965

966966
* example
967967
```properties
968-
net_colector_ip = 127.0.0.1
968+
net_collector_ip = 127.0.0.1
969969
cpu_alert_enabled = false
970970
```
971971

@@ -1016,7 +1016,7 @@
10161016
@ConfigDesc("")
10171017
public boolean log_udp_object = false;
10181018
@ConfigDesc("Retaining log according to date")
1019-
public boolean log_rotation_enalbed = true;
1019+
public boolean log_rotation_enabled = true;
10201020
@ConfigDesc("Log directory")
10211021
public String log_dir = "./logs";
10221022
@ConfigDesc("Keeping period of log")

scouter.document/main/Plugin-Guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ refer to the link for details.
5252
refer to **[Scripting plugin Server API](Server-Plugin-Scripting.md)**.
5353

5454
### 2. Built-in (type) Plugin
55-
Builing scripting plugin is very simple and can be dynamically loaded on runtime environment.
55+
Building scripting plugin is very simple and can be dynamically loaded on runtime environment.
5656
On the other hand if you need the function permanently, it's too easy to fragile.
5757
So scouter provides another plugin type which allow you can attach pre-built compiled plugin and it's called as **Built-in Plugin**.
5858

scouter.document/main/Quick-Start.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ Client(Viewer) | Client program to check the collected performance informatio
3535

3636
#### (1) **Download** integrated demonstration environment and a client program
3737
- Download integrated demonstration environment
38-
- [Download demo-env1.tar.gz](https://github.com/scouter-project/scouter-demo/releases/download/v1.8.4.1/demo-env1.tar.gz) (It includes collector server, host agent, java agent, tomcat for demo system and start scripts...)
39-
- Windows Case : [Download demo-env1.zip](https://github.com/scouter-project/scouter-demo/releases/download/v1.8.4.1/demo-env1.zip)
38+
- [Download demo-env1.tar.gz](https://github.com/scouter-project/scouter-demo/releases/download/v2.6.2/demo-env1.tar.gz) (It includes collector server, host agent, java agent, tomcat for demo system and start scripts...)
39+
- Windows Case : [Download demo-env1.zip](https://github.com/scouter-project/scouter-demo/releases/download/v2.6.2/demo-env1.zip)
4040

4141
- Download a client program
4242
- download a client for your environment.
43-
- [scouter.client.product-win32.win32.x86_64.zip](https://github.com/scouter-project/scouter/releases/download/v1.8.4.1/scouter.client.product-win32.win32.x86_64.zip)
44-
- [scouter.client.product-win32.win32.x86.zip](https://github.com/scouter-project/scouter/releases/download/v1.8.4.1/scouter.client.product-win32.win32.x86.zip)
45-
- [scouter.client.product-macosx.cocoa.x86_64.tar.gz](https://github.com/scouter-project/scouter/releases/download/v1.8.4.1/scouter.client.product-macosx.cocoa.x86_64.tar.gz)
46-
- [scouter.client.product-linux.gtk.x86_64.tar.gz](https://github.com/scouter-project/scouter/releases/download/v1.8.4.1/scouter.client.product-linux.gtk.x86_64.tar.gz)
43+
- [scouter.client.product-win32.win32.x86_64.zip](https://github.com/scouter-project/scouter/releases/download/v2.6.2/scouter.client.product-win32.win32.x86_64.zip)
44+
- [scouter.client.product-win32.win32.x86.zip](https://github.com/scouter-project/scouter/releases/download/v2.6.2/scouter.client.product-win32.win32.x86.zip)
45+
- [scouter.client.product-macosx.cocoa.x86_64.tar.gz](https://github.com/scouter-project/scouter/releases/download/v2.6.2/scouter.client.product-macosx.cocoa.x86_64.tar.gz)
46+
- [scouter.client.product-linux.gtk.x86_64.tar.gz](https://github.com/scouter-project/scouter/releases/download/v2.6.2/scouter.client.product-linux.gtk.x86_64.tar.gz)
4747

4848
#### (2) Decompress the downloaded file.
4949
decompress file and all installation is done.

scouter.document/main/Quick-Start_kr.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ Client(Viewer) | 수집된 성능 정보를 확인하기 위한 Client 프로
3636

3737
#### (1) 통합 데모 환경 및 클라이언트 프로그램 다운로드
3838
- 통합 데모 환경 다운로드
39-
- [demo-env1.tar.gz 다운로드](https://github.com/scouter-project/scouter-demo/releases/download/v1.8.4.1/demo-env1.tar.gz) (Collector Server, Host Agent, Java Agent, Tomcat, 샘플 시스템, 설정, 기동 스크립트가 포함됨)
40-
- Windows의 경우 [demo-env1.zip 다운로드](https://github.com/scouter-project/scouter-demo/releases/download/v1.8.4.1/demo-env1.zip)
39+
- [demo-env1.tar.gz 다운로드](https://github.com/scouter-project/scouter-demo/releases/download/v2.6.2/demo-env1.tar.gz) (Collector Server, Host Agent, Java Agent, Tomcat, 샘플 시스템, 설정, 기동 스크립트가 포함됨)
40+
- Windows의 경우 [demo-env1.zip 다운로드](https://github.com/scouter-project/scouter-demo/releases/download/v2.6.2/demo-env1.zip)
4141

4242
- Client 다운로드
4343
- 자신의 환경에 맞는 파일을 다운로드 받는다.
44-
- [scouter.client.product-win32.win32.x86_64.zip](https://github.com/scouter-project/scouter/releases/download/v1.8.4.11/scouter.client.product-win32.win32.x86_64.zip)
45-
- [scouter.client.product-win32.win32.x86.zip](https://github.com/scouter-project/scouter/releases/download/v1.8.4.11/scouter.client.product-win32.win32.x86.zip)
46-
- [scouter.client.product-macosx.cocoa.x86_64.tar.gz](https://github.com/scouter-project/scouter/releases/download/v1.8.4.11/scouter.client.product-macosx.cocoa.x86_64.tar.gz)
47-
- [scouter.client.product-linux.gtk.x86_64.tar.gz](https://github.com/scouter-project/scouter/releases/download/v1.8.4.11/scouter.client.product-linux.gtk.x86_64.tar.gz)
44+
- [scouter.client.product-win32.win32.x86_64.zip](https://github.com/scouter-project/scouter/releases/download/v2.6.2/scouter.client.product-win32.win32.x86_64.zip)
45+
- [scouter.client.product-win32.win32.x86.zip](https://github.com/scouter-project/scouter/releases/download/v2.6.2/scouter.client.product-win32.win32.x86.zip)
46+
- [scouter.client.product-macosx.cocoa.x86_64.tar.gz](https://github.com/scouter-project/scouter/releases/download/v2.6.2/scouter.client.product-macosx.cocoa.x86_64.tar.gz)
47+
- [scouter.client.product-linux.gtk.x86_64.tar.gz](https://github.com/scouter-project/scouter/releases/download/v2.6.2/scouter.client.product-linux.gtk.x86_64.tar.gz)
4848

4949
#### (2) 압축 파일 해제
5050
압축 파일을 해제 함으로써 기본적인 설치가 완료 된다.

scouter.document/main/Setup-FAQ.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ If you want to another configuration file, uses -Dscouter.config=<file path> opt
4141
### How to communicate between Server and Client
4242
Scouter Client uses TCP 6100 port to request monitoring data, same as Agent does.
4343
```
44-
Clinet ——-> Server
44+
Client ——-> Server
4545
TCP 6100
4646
```
4747
TCP 6100 port are used by both Agent and Client. User should specify Server's endpoint information when Client program run at first.

scouter.document/main/Setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
### 1.2. Collector Server Installation
1616
1. download the latest version of scouter-yyyyMMdd.tar.gz.
1717
- [Release Page](https://github.com/scouter-project/scouter/releases)
18-
2. Extract the file.(You can see the dircetory ./scouter/server)
18+
2. Extract the file.(You can see the directory ./scouter/server)
1919
3. execute start script.
2020
```bash
2121
cd ./scouter/server
@@ -35,7 +35,7 @@ cd ./scouter/server
3535
3636
### 1.3. Network ports used by Collector server
3737
* UDP Receive Port : 6100 (This port is used for gathering performance metrics.)
38-
* TCP Service Port : 6100 (This port is used for commuication with scouter client and agents.)
38+
* TCP Service Port : 6100 (This port is used for communication with scouter client and agents.)
3939
4040
### 1.4. Configuration
4141

scouter.document/main/Telegraf-Server.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ You can monitor the performance information of various products through Telegraf
99
- [Telegraf Input plugins](https://github.com/influxdata/telegraf/tree/master/plugins/inputs)
1010

1111

12-
## Apply Telegraf server funtion
12+
## Apply Telegraf server function
1313

1414
### 1. Enabling the telegraf Server option on the Scouter
1515
First, enable the http server option of the Collector server on the Scouter Client screen.
@@ -20,7 +20,7 @@ If you want to change the http port, set it to `net_http_port=xxx`. The default
2020
If you change any of the above options, you must restart the Collector.
2121

2222
Next, activate the Telegraf setting.
23-
- Menu : **Colellector > Configures > Telegraf > Telegraf Configure**
23+
- Menu : **Collector > Configures > Telegraf > Telegraf Configure**
2424
- In the General tree, check `Enabled` to enable the Telegraf Server function.
2525

2626
If you need to check the requested data, check `Debug Enabled 'to log all the requested data.

scouter.document/tech/Web-API-Guide.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@
88
- `net_http_server_enabled` : set `true`
99
- `net_http_api_enabled` : set `true`
1010
- `net_http_port` : default value `6180`
11-
- `net_http_api_allow_ips` : default value `localhost,127.0.0.1,0:0:0:0:0:0:0:1,::1`;
11+
- `net_http_api_allow_ips` : default value `localhost,127.0.0.1,0:0:0:0:0:0:0:1,::1`
12+
- `net_collector_ip_port_id_pws` : default value 127.0.0.1:6100:admin:admin
13+
- format : {host}:{port}:{id}:{pw},{host}:{port}:{id}:{pw}
1214

1315
### StandAlone Mode Run
1416
- Web api needs much more memory and cpu usage than scouter collector server because of servlet processing, JSON parsing and another workings.

scouter.document/tech/Web-API-Guide_kr.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@
88
- `net_http_server_enabled` : set `true`
99
- `net_http_api_enabled` : set `true`
1010
- `net_http_port` : default value `6180`
11-
- `net_http_api_allow_ips` : default value `localhost,127.0.0.1,0:0:0:0:0:0:0:1,::1`;
11+
- `net_http_api_allow_ips` : default value `localhost,127.0.0.1,0:0:0:0:0:0:0:1,::1`
12+
- `net_collector_ip_port_id_pws` : default value 127.0.0.1:6100:admin:admin
13+
- format : {host}:{port}:{id}:{pw},{host}:{port}:{id}:{pw}
1214

1315
### StandAlone Mode로 실행
1416
- Web API는 Servlet을 통해 서비스 되면 HTTP 프로토콜이나 JSON 파싱 등 부가적인 작업이 필요하기 때문에 기본 수집서버에 비해 자원 사용량이 높다.

0 commit comments

Comments
 (0)