WebtoB 콘솔 툴

WebtoB는 엔진 프로세스 및 서버 프로세스들을 관리하기 위해서 다음과 같은 툴을 제공합니다.

  • Admin 툴

    콘솔 툴 설명

    wsadmin

    WebtoB 시스템 전체적인 관리를 위해서 사용되는 툴로서, 시스템 정보 조회 및 관리자 작업 수행을 지원합니다.

  • 기타 툴

    콘솔 툴 설명

    configMigrator

    WebtoB5 환경 파일을 WebtoB6에 맞게 마이그레이션합니다.

    configValidator

    WebtoB 환경 파일에 대한 스키마 검증을 수행합니다.

    mkpwd

    SSL 인증서 키 패스워드에 대해 암호를 저장하는 파일을 생성합니다.

wsadmin

wsadmin은 텍스트 기반의 관리 환경을 제공합니다. 항상 프롬프트(prompt) 상태로 대기하면서 입력되는 명령어를 해석하여 실행합니다.

  • 실행

    wsadmin 툴을 실행하려면 wsadmin 명령을 사용합니다.

    $ wsadmin

    wsadmin 툴이 정상적으로 실행되면 다음과 같은 메시지와 함께 프롬프트가 표시됩니다.

    $$1 [wsadmin]>>
  • 종료

    wsadmin 툴을 종료하려면 exit 명령을 사용합니다.

    $$3 [wsadmin]>> exit

 

다음은 wsadmin이 제공하는 명령어에 대한 설명입니다.

명령어 약자 설명

help

wsadmin 툴에서 사용할 수 있는 명령어에 대한 도움말을 출력합니다.

client-info

(cli)

WebtoB에 연결된 클라이언트 접속 정보를 출력합니다.

connect

특정 WebtoB Admin 서버에 접속합니다.

stat-info

(st)

목적지 및 서비스 상태에 대한 통계를 출력합니다.

config

(cfg)

환경 설정 내용을 출력합니다.

update-config

환경 설정 파일을 다시 로드하여 동적으로 반영합니다.

cache-list

(cachelist)

HTTP 응답 캐시에 저장된 응답들의 정보를 출력합니다.

cache-refresh

(cr)

HTTP 응답 캐시에 저장된 아이템을 제거합니다.

cert-refresh

(cr)

WebtoB의 인증서 정보를 갱신합니다.

svg-info

(si)

클라이언트의 요청을 처리하는 목적지의 정보를 출력합니다.

connection-info

(ci)

WebtoB의 클라이언트와 목적지의 연결 정보를 출력합니다.

shutdown

(down)

동작 중인 WebtoB를 종료합니다.

exit

wsadmin 툴을 종료합니다.

patch-info

릴리즈된 이후 패치된 정보를 조회합니다.

webtob-info

WebtoB 시스템의 정보에 대해서 출력합니다.

license-info

지정된 license 정보를 출력합니다.

system-info

현재 장비의 정보를 출력합니다.

각 명령어는 공통적으로 다음과 같은 옵션을 제공합니다.

옵션 설명

[-i <반복 주기>]

명령어의 반복 주기(초)를 지정합니다. (기본값: 1초)

[-r <반복 횟수>]

명령어의 반복 횟수를 지정합니다. (기본값: 0)
0으로 지정하면 무한 반복됩니다.

다음은 cli 명령어를 2초 주기로 2번 반복하여 출력하는 예시입니다.

wsadmin]>> cli -i 2 -r 2
Command will be executed repeatedly. Count=2. Interval=2(sec).
* Repeat count = 1
----------------------------------------------------------------------------------------------------------
| Client Info : HTH-0                                                                                    |
----------------------------------------------------------------------------------------------------------
| No | Status | Request Count | Response Count | Idle |    Local Address    |    Remote Address    | Ssl |
----------------------------------------------------------------------------------------------------------
| 12 | READY  |       1       |       1        |  22  | 192.168.15.120:8080 | 192.168.15.120:53844 | No  |
----------------------------------------------------------------------------------------------------------


* Repeat count = 2
----------------------------------------------------------------------------------------------------------
| Client Info : HTH-0                                                                                    |
----------------------------------------------------------------------------------------------------------
| No | Status | Request Count | Response Count | Idle |    Local Address    |    Remote Address    | Ssl |
----------------------------------------------------------------------------------------------------------
| 12 | READY  |       1       |       1        |  24  | 192.168.15.120:8080 | 192.168.15.120:53844 | No  |
----------------------------------------------------------------------------------------------------------


Repeat done.

wsadmin 실행과 함께 각 명령어를 큰 따옴표(")로 묶어서 입력하면 프롬프트 대기 없이 각 명령어에 대한 결과를 순서대로 출력합니다.

다음은 cli 명령어와 st 명령어에 대한 결과를 콘솔에 바로 출력해주는 예시입니다.

$ wsadmin "cli" "st"
	 Environment variables for WebtoB:
		WEBTOB_HOME_PATH = /home/tmax/webtob6/

Welcome to WebtoB Demo system.
Enterprise edition License in used.
Schema file path: /home/tmax/webtob6/schema/webtob-config-enterprise.schema.json

 Start config validation 
1. Opened schema file
2. Opened config file
3. Config parsing finished
4. Pre-validation process finished
5. Validation using json-schema finished
6. Post-validation process finished
Config file "/home/tmax/webtob6/config/webtob-config.json" is validated with schema file "/home/tmax/webtob6/schema/webtob-config-enterprise.schema.json"
Success to load config files : webtob-config.json
 Validation success 
	 Current WebtoB Configuration:
		Number of client handlers (HTH) = 1
		Number of worker threads per handler (HTH) = 1
		Number of connection pool size per handler (HTH) = 100

Today is 2025-05-28
License expires on 2099-12-31 (27245 days remaining)
Connection established successfully with localhost:9090.
----------------------------------------------------------------------------------------------
| Client Info : HTH-0                                                                        |
----------------------------------------------------------------------------------------------
| No | Status | Request Count | Response Count | Idle | Local Address | Remote Address | Ssl |
----------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------


Prints all information. Use options to print specific items ( -jeus, -rproxy, -htmls )
---------------------------------------------------------------------------------------------------------------------------------------------
| HTH-0 : JEUS statistic                                                                                                                    |
---------------------------------------------------------------------------------------------------------------------------------------------
|            Server            | Server Group | Connections | Average Processed Time | Request Count | Response Count | Sticky Routed Count |
---------------------------------------------------------------------------------------------------------------------------------------------
| ZG9tYWluMS9hZG1pblNlcnZlcg== |   MyGroup1   |     10      |        0.000000        |       0       |       0        |          0          |
---------------------------------------------------------------------------------------------------------------------------------------------

-----------------------------------------------------------------------------------------------------------------------------------
| HTH-0 : Reverse Proxy statistic                                                                                                 |
-----------------------------------------------------------------------------------------------------------------------------------
|       Server       | Server Group | Connections | Average Processed Time | Request Count | Response Count | Sticky Routed Count |
-----------------------------------------------------------------------------------------------------------------------------------
| tmaxsoft:80 |   rproxyg1   |      0      |        0.000000        |       0       |       0        |          0          |
-----------------------------------------------------------------------------------------------------------------------------------

----------------------------------------------------------------------------------
| HTH-0 : HTMLS statistic                                                        |
----------------------------------------------------------------------------------
| Server | Queue Count | Average Processed Time | Request Count | Response Count |
----------------------------------------------------------------------------------
| HTMLS  |      0      |        0.000000        |       0       |       0        |
----------------------------------------------------------------------------------

help

wsadmin 툴에서 사용할 수 있는 명령어에 대한 도움말을 출력합니다.

  • 사용법

    >  help [명령어]
    옵션 설명

    [명령어]

    사용법을 출력할 명령어를 지정합니다.

  • 사용 예시

    옵션 미사용
    [wsadmin]>> help
    ----------------------------------------------------------------------------------------------
    | Help                                                                                       |
    ----------------------------------------------------------------------------------------------
    |  Command Name   |   Command Alias   |                  Command Descriptor                  |
    ----------------------------------------------------------------------------------------------
    | client-info     | cliinfo, cli      | show client info                                     |
    | connect         |                   | connect to the WebtoB admin server                   |
    | stat-info       | stat, st          | show statistics info                                 |
    |                 |                   | JEUS, Reverse proxy server, HTMLS statistic          |
    | restat          |                   | clear target statistics info                         |
    | config          | cfg               | show config info                                     |
    | update-config   |                   | update config info                                   |
    | cache-list      | cachelist         | show cache info                                      |
    | cache-refresh   | cr, cacherefresh  | removes responses stored in the HTTP response cache  |
    | svg-info        | svginfo, sgi, si  | show server group info                               |
    | connection-info | coninfo, coni, ci | show connection info                                 |
    | shutdown        | down              | shutdown WebtoB                                      |
    ----------------------------------------------------------------------------------------------
    | You can use the help command for each individual command.                                  |
    ----------------------------------------------------------------------------------------------
    옵션 사용
    [wsadmin]>> help st
    ---------------------------------------------------------------------------------------------------------------------------------------
    | Help : stat-info( stat, st )                                                                                                        |
    ---------------------------------------------------------------------------------------------------------------------------------------
    | OptionName | IsRequired | HasArgs |                                           Description                                           |
    ---------------------------------------------------------------------------------------------------------------------------------------
    | hth_number |     No     |   Yes   | target hth number                                                                               |
    | jeus       |     No     |   Yes   | JEUS statistic info                                                                             |
    | rproxy     |     No     |   Yes   | Reverse proxy statistic info                                                                    |
    | htmls      |     No     |   No    | HTMLS statistic info                                                                      |
    | ---        |    ---     |   ---   | ---                                                                                             |
    | i          |     No     |   Yes   | Default: 1 (second) if a repeat is needed. Interval specifies the time delay between repeats.   |
    | r          |     No     |   Yes   | Default: 0 (unlimited) if a repeat is needed. To limit the repeats, set a value greater than 0. |
    ---------------------------------------------------------------------------------------------------------------------------------------
    | Show statistics info.                                                                                                               |
    | JEUS, Reverser Proxy, HTMLS statistic.                                                                                 |
    ---------------------------------------------------------------------------------------------------------------------------------------

client-info (cli, cliinfo)

현재 접속된 클라이언트(주로 웹 브라우저)의 환경 정보를 조회합니다. 현재 상태(status), 접속 IP 주소, 처리 건수(count)와 같은 정보를 확인할 수 있습니다.

  • 사용법

    > cli [-vhost <VHOST 이름>][-hth <HTH 번호>]
    옵션 설명

    [-vhost <VHOST 이름>]

    연결된 클라이언트 정보를 출력할 VHOST 이름을 지정합니다.

    [-hth <HTH 번호>]

    연결된 클라이언트 정보를 출력할 HTH 번호를 지정합니다.

  • 사용 예시

    cli를 옵션 없이 사용하면 다음 같은 결과를 출력합니다. 하나의 항목이 1개의 클라이언트를 의미합니다.

    [wsadmin]>> cli
    ----------------------------------------------------------------------------------------------------------
    | Client Info : HTH-0                                                                                    |
    ----------------------------------------------------------------------------------------------------------
    | No | Status | Request Count | Response Count | Idle |    Local Address    |    Remote Address    | Ssl |
    ----------------------------------------------------------------------------------------------------------
    | 5  | READY  |       0       |       0        |  4   | 192.168.15.120:8080 | 192.168.15.120:38572 | No  |
    ----------------------------------------------------------------------------------------------------------

    다음은 출력 항목에 대한 설명입니다.

    출력 항목 설명

    No

    WebtoB 내부적으로 관리하는 커넥션 번호

    Status

    목적지의 클라이언트 상태

    • READY: 클라이언트로부터 요청을 받는 중

    • RUNNING: 클라이언트의 요청이 목적지에서 처리 중

    Request Count

    해당 클라이언트가 전송한 요청 수

    Response Count

    해당 클라이언트가 응답받은 수

    Idle

    해당 클라이언트가 어떠한 데이터도 주고받지 않고 있는 상태로 지속된 시간

    Local Address,
    Remote Address

    서버와 클라이언트의 IP 주소와 포트 번호

    Ssl

    해당 클라이언트가 SSL로 연결되어 있는지 여부

connect

wsadmin에서 WebtoB Admin 서버로 접속할 때 사용하는 명령어입니다.

  • 사용법

    > connect [-ip <Admin 서버 IP>][-port <Admin 서버 포트>]
    옵션 설명

    [-ip <Admin 서버 IP>]

    접속할 WebtoB Admin 서버의 IP 주소를 지정합니다.

    [-port <Admin 서버 포트>]

    접속할 WebtoB Admin 서버의 포트 번호를 지정합니다.

  • 사용 예시

    [wsadmin]>> connect -ip localhost -port 9090
    Connection established successfully with localhost:9090.

patch-info (patchinfo)

릴리즈된 이후 추가 패치를 적용한 경우 패치된 정보를 조회합니다.

  • 사용법

    > patch-info [-version <버전 정보>]
    옵션 설명

    [-version <버전 정보>]

    조회하고자 하는 패치 버전을 입력합니다. 버전명 전체를 적어도 되고 버전에 해당하는 숫자만 입력해도 됩니다. 버전을 생략하면 릴리즈 이후의 전체 변경사항을 가져옵니다.

  • 사용 예시

    [wsadmin]>> patch-info -version 6.0_B18
    ----------------------------------------------------------------------
    | Patch info                                                         |
    ----------------------------------------------------------------------
    |                                                                    |
    | WebtoB 6 Linux B19 epoll 2025.04.07                                |
    |                                                                    |
    |                                                                    |
    | * 6_B18 (2025.03.31)                                               |
    |      - PatchInfo Command 추가                                       |
    |      - 버그 수정                                                     |
    |                                                                    |
    |                                                                    |
    ----------------------------------------------------------------------

webtob-info (webtobinfo, wi)

현재 동작 중인 WebtoB 전반적인 정보에 대해서 출력합니다.

  • 사용법

    해당 커맨드는 별도의 옵션이 필요하지 않습니다.

  • 사용 예시

    [wsadmin]>> webtob-info
    -------------------------------------------------------------------------------------------------------
    | WebtoB Version: WebtoB 6 Linux B19 epoll 2025.04.07                                                 |
    -------------------------------------------------------------------------------------------------------
    |       License Type       | Expiration Date | HTH Count | Worker Thread Count | Connection Pool Size |
    -------------------------------------------------------------------------------------------------------
    | Cloud Enterprise edition |   0000/00/00    |     1     |          8          |          2           |
    -------------------------------------------------------------------------------------------------------

license-info (licenseinfo, li)

특정 라이센스에 대한 정보를 출력합니다. 이 커맨드는 WebtoB가 기동이 되어 있지 않아도 됩니다.

  • 사용법

    > license-info [-file <파일경로/파일이름>]
    옵션 설명

    [-file <파일경로/파일이름>]

    라이센스가 위치한 경로 및 파일이름을 지정합니다. '/'로 시작하지 않으면 wsadmin을 실행한 현재 경로를 기준으로 찾습니다. '/'로 끝나면 license.dat를 붙입니다.

  • 사용 예시

    [wsadmin]>> license-info -file ../license/
    -------------------------------------------------------------------------------------
    | License info (file: license.dat)                                                  |
    -------------------------------------------------------------------------------------
    |  Sequence Number  | Issue Date | Type  |  Edition   | Expiration Date |  Policy   |
    -------------------------------------------------------------------------------------
    | AAA-0000-000-0000 | 0000/00/00 | Cloud | Enterprise |   0000/00/00    | Unlimited |
    -------------------------------------------------------------------------------------

system-info (systeminfo)

현재 장비의 Host Name을 포함한 전반적인 정보를 확인합니다. 이 커맨드는 WebtoB가 기동이 되어 있지 않아도 됩니다.

  • 사용법

    해당 커맨드는 별도의 옵션이 필요하지 않습니다.

  • 사용 예시

    [wsadmin]>> systeminfo
    --------------------------------------------------------
    | System info                                          |
    --------------------------------------------------------
    | Host Name | Host ID  | Number of CPUs |  Open Files  |
    --------------------------------------------------------
    |  webtob0  | 000A0000 |       12       | 1024/1048576 |
    --------------------------------------------------------
    
    ------------------------------------------------------------------------------------------------------------------
    | Kernel and Hardware Details                                                                                    |
    ------------------------------------------------------------------------------------------------------------------
    | Kernel Name |  Kernel Release  | Machine Hardware Name | Processor Type | Hardware Platform | Operating System |
    ------------------------------------------------------------------------------------------------------------------
    |    Linux    | 6.8.0-52-generic |        x86_64         |     x86_64     |      x86_64       |    GNU/Linux     |
    ------------------------------------------------------------------------------------------------------------------
    | Kernal Version : #53~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Wed Jan 15 19:18:46 UTC 2                              |
    ------------------------------------------------------------------------------------------------------------------

stat-info (st, stat)

실질적인 시스템 동작 상태를 나타내며, 동작 중인 목적지에 대한 정보를 제공합니다.

목적지의 현재 상태, 처리 중인 서비스 이름, 처리한 서비스 개수, 서비스 상태, 서비스 큐에 대기 중인 요청 수 등의 동적인 정보를 확인할 수 있습니다.

  • 사용법

    > st [-hth <HTH 번호>][-jeus <JEUS 목적지 이름>][-rproxy <역방향 프록시 목적지 이름>][-htmls]
    옵션 설명

    [-hth <HTH 번호>]

    목적지 통계 정보를 출력할 HTH 번호를 지정합니다.

    [-jeus <JEUS 목적지 이름>]

    통계 정보를 출력할 JEUS 목적지 이름을 지정합니다.

    [-rproxy <역방향 프록시 목적지 이름>]

    통계 정보를 출력할 역방향 프록시 목적지 이름을 지정합니다.

    [-htmls]

    통계 정보를 출력할지 여부를 설정합니다.

  • 사용 예시

    [wsadmin]>> st
    Prints all information. Use options to print specific items ( -jeus, -rproxy, -htmls )
    -------------------------------------------------------------------------------------------------------------------------------------------------
    | HTH-0 : JEUS statistic                                                                                                                        |
    -------------------------------------------------------------------------------------------------------------------------------------------------
    |              Server              | Server Group | Connections | Average Processed Time | Request Count | Response Count | Sticky Routed Count |
    -------------------------------------------------------------------------------------------------------------------------------------------------
    | amV1c19kb21haW4vYWRtaW5TZXJ2ZXI= |   MyGroup1   |     10      |        0.000000        |       0       |       0        |          0          |
    -------------------------------------------------------------------------------------------------------------------------------------------------
    
    ------------------------------------------------------------------------------------------------------------------------------------
    | HTH-0 : Reverse Proxy statistic                                                                                                  |
    ------------------------------------------------------------------------------------------------------------------------------------
    |       Server        | Server Group | Connections | Average Processed Time | Request Count | Response Count | Sticky Routed Count |
    ------------------------------------------------------------------------------------------------------------------------------------
    | 192.168.15.120:8088 |   rproxyg1   |      0      |        0.000000        |       0       |       0        |          0          |
    ------------------------------------------------------------------------------------------------------------------------------------
    
    ----------------------------------------------------------------------------------
    | HTH-0 : HTMLS statistic                                                        |
    ----------------------------------------------------------------------------------
    | Server | Queue Count | Average Processed Time | Request Count | Response Count |
    ----------------------------------------------------------------------------------
    | HTMLS  |      0      |        0.002725        |      10       |       10       |
    ----------------------------------------------------------------------------------

    다음은 출력 항목에 대한 설명입니다.

    • JEUS 목적지 통계에 대한 출력 항목

      출력 항목 설명

      Server

      내부적으로 관리하는 JEUS 목적지 이름입니다.

      Server Group

      JEUS 목적지의 그룹 이름입니다.

      Connections

      해당 JEUS 목적지와 맺은 연결 수입니다.

      Average Processed Time

      평균 처리 시간입니다. (단위: 초)

      Request Count

      해당 목적지로 보내진 요청 수입니다.

      Response Count

      해당 목적지가 처리한 요청 수입니다.

      Sticky Routed Count

      클라이언트로부터 Sticky ID를 받아서 해당 목적지에 보내진 요청 수입니다.

    • 역방향 프록시 목적지 통계에 대한 출력 항목

      출력 항목 설명

      Server

      역방향 프록시 목적지 주소입니다.

      Server Group

      역방향 프록시 목적지 이름입니다.

      Connections

      해당 역방향 프록시 목적지와 맺은 연결 수입니다.

      Average Processed Time

      평균 처리 시간입니다. (단위: 초)

      Request Count

      해당 목적지로 보내진 요청 수입니다.

      Response Count

      해당 목적지가 처리한 요청 수입니다.

      Sticky Routed Count

      클라이언트로부터 Sticky ID를 받아서 해당 목적지에 보내진 요청 수입니다.

    • HTMLS 목적지 통계에 대한 출력 항목

      출력 항목 설명

      Server

      HTMLS 목적지 이름입니다.

      Queue Count

      HTMLS에 대기 중인 요청 수입니다.

      Average Processed Time

      평균 처리 시간입니다. (단위: 초)

      Request Count

      HTMLS로 보내진 요청 수입니다.

      Response Count

      HTMLS가 처리한 요청 수입니다.

restat

목적지의 통계 정보를 초기화하는 경우에 사용합니다.

  • 사용법

    > restat [-hth <HTH 번호>][-jeus <JEUS 목적지 이름>][-rproxy <역방향 프록시 목적지 이름>][-htmls]
    옵션 설명

    [-hth <HTH 번호>]

    목적지 통계 정보를 초기화할 HTH 번호를 지정합니다.

    [-jeus <JEUS 목적지 이름>]

    통계 정보를 초기화할 JEUS 목적지 이름을 지정합니다.

    [-rproxy <역방향 프록시 목적지 이름>]

    통계 정보를 초기화할 역방향 프록시 목적지 이름을 지정합니다.

    [-htmls]

    HTMLS 목적지의 통계 정보를 초기화할지 여부를 설정합니다.

  • 사용 예시

    옵션 없이 사용 시 모든 통계 정보를 초기화 합니다.

[wsadmin]>> restat
Prints all information. Use options to print specific items ( -jeus, -rproxy, -htmls )
-----------------------------------------------------
| HTH-0                                             |
-----------------------------------------------------
| List of JEUS with cleared statistical information |
-----------------------------------------------------
|                     MyGroup2                      |
|                     MyGroup1                      |
-----------------------------------------------------

-------------------------------------------------------------
| HTH-0                                                     |
-------------------------------------------------------------
| List of Reverse Proxy with cleared statistical information|
-------------------------------------------------------------
|                         rproxyg1                          |
-------------------------------------------------------------

-----------------------------------------------------
| HTH-0                                             |
-----------------------------------------------------
| List of HTMLS with cleared statistical information|
-----------------------------------------------------
|                      [HTMLS]                      |
-----------------------------------------------------

config (cfg)

현재 동작 중인 시스템의 환경 정보를 조회합니다. 환경 설정 파일에 정의된 노드, 서버, 목적지, 서비스별로 기본값을 포함한 모든 환경 정보를 확인할 수 있습니다.

  • 사용법

    > config [-path <JSON 경로>]
    옵션 설명

    [-path <JSON 경로>]

    확인할 환경 설정 파일의 JSON 경로를 지정합니다. 이때 경로는 항상 /로 시작해야 합니다.
    경로를 생략하거나 /로 설정하면 현재 설정된 모든 환경 정보를 가져옵니다.

  • 사용 예시

    다음은 NODE 절 환경 설정을 출력한 예시입니다. NODE 절의 설정 항목에 대한 자세한 설명은 NODE 절 설정 항목을 참고합니다.

    [wsadmin]>> cfg -path /node
    ----------------------------------------------
    | Target Config /node                        |
    ----------------------------------------------
    |                   Values                   |
    ----------------------------------------------
    | {                                          |
    |   "cache_entry": 128,                      |
    |   "cache_key": "HOST_URI",                 |
    |   "cache_max_file_size": 8192,             |
    |   "connection_pool_size": 8192,            |
    |   "graceful_shutdown_timeout": 30,         |
    |   "hth_count": 1,                          |
    |   "hth_schedule": "RR",                    |
    |   "limit_request_body_size": 0,            |
    |   "limit_request_header_field_count": 100, |
    |   "limit_request_header_field_size": 8190, |
    |   "limit_request_line_size": 8190,         |
    |   "listen_backlog": 4096,                  |
    |   "max_cache_memory_size": 100,            |
    |   "name": "ksh",                           |
    |   "system_filters": [],                    |
    |   "worker_threads": 1                      |
    | }                                          |
    ----------------------------------------------

update-config

설정 파일을 다시 읽어 설정을 동적으로 반영합니다. 단, 스키마 파일에서 '|dynamic|' 키로 지정된 설정만 반영됩니다.

  • 사용법

    해당 커맨드는 별도의 옵션이 필요하지 않습니다.

cache-list (cachelist)

현재 WebtoB의 HTTP 응답 캐시에 저장된 응답에 대한 정보를 출력합니다.

  • 사용법

    > cachelist [-hth <HTH 번호>]
    옵션 설명

    [-hth <HTH 번호>]

    캐시 정보를 조회할 HTH를 지정합니다. 지정하지 않으면 모든 HTH가 조회됩니다.

  • 사용 예시

    다음은 요청 "/test.txt"에 대한 응답이 캐시에 저장된 예시입니다. 요청 경로 외의 부분은 서버 내부 디버그 용도로만 사용됩니다.

    [wsadmin]>> cachelist
    -------------------------------------------------------------------
    | HTH-0: Cache List Info                                          |
    -------------------------------------------------------------------
    |          Cache key           |    Expired time     | Cache size |
    -------------------------------------------------------------------
    | 192.168.15.120:8080/test.txt | 2024-10-29 12:34:53 |         286|
    -------------------------------------------------------------------
    | Cache count : 1                                                 |
    | Memory usages : 286                                             |
    -------------------------------------------------------------------

cache-refresh (cr)

현재 WebtoB의 HTTP 응답 캐시에 저장된 응답을 제거합니다.

  • 사용법

    > cacherefresh { [-url <URL>] | [-ext <확장자>] }
    옵션 설명

    [-url <URL>]

    제거할 캐시의 URL을 지정합니다.

    [-ext <확장자>]

    제거할 캐시의 확장자를 지정합니다.

  • 사용 예시

    옵션 없이 사용 시 저장된 모든 캐시 정보를 제거 합니다.

    [wsadmin]>> cr
    [HTH-0] Number of removed cache items: 10

cert-refresh (cr)

WebtoB의 인증서 정보를 갱신합니다.

  • 사용법

    해당 커맨드는 별도의 옵션이 필요하지 않습니다.

svg-info (si, sgi, svginfo)

클라이언트의 요청을 처리하는 목적지의 정보를 출력합니다.

  • 사용법

    > si [-htmls][-jeus <JEUS 목적지 이름>][-rproxy <역방향 프록시 목적지 이름>]
    옵션 설명

    [-htmls]

    HTMLS 목적지 정보를 출력할지 여부를 설정합니다.

    [-jeus <JEUS 목적지 이름>]

    정보를 출력할 JEUS 목적지 이름을 지정합니다.

    [-rproxy <역방향 프록시 목적지 이름>]

    정보를 출력할 역방향 프록시 목적지 이름을 지정합니다.

  • 사용 예시

    [wsadmin]>> si
    -------------------------------------------------------------------
    | HTH-0 : HTMLS Destination Info                                  |
    -------------------------------------------------------------------
    | svgname | status | aqcnt | count | cqcnt | qpcnt | reqs | rscnt |
    -------------------------------------------------------------------
    |  HTMLS  |  RDY   |   0   |   0   |   0   |   0   |  0   |   0   |
    -------------------------------------------------------------------
    
    --------------------------------------------------------------------
    | HTH-0 : JEUS Destination Info                                    |
    --------------------------------------------------------------------
    | svgname  | status | aqcnt | count | cqcnt | qpcnt | reqs | rscnt |
    --------------------------------------------------------------------
    | MyGroup2 |  NRDY  |   0   |   0   |   0   |   0   |  0   |   0   |
    | MyGroup1 |  RDY   |   0   |   0   |   0   |   0   |  0   |   0   |
    --------------------------------------------------------------------
    
    --------------------------------------------------------------------
    | HTH-0 : Reverse Proxy Destination Info                           |
    --------------------------------------------------------------------
    | svgname  | status | aqcnt | count | cqcnt | qpcnt | reqs | rscnt |
    --------------------------------------------------------------------
    | rproxyg1 |  RDY   |   0   |   0   |   0   |   0   |  0   |   0   |
    --------------------------------------------------------------------

    다음은 출력 항목에 대한 설명입니다.

    출력 항목 설명

    svgname

    목적지 이름입니다.

    status

    목적지 내부의 클라이언트 상태입니다.

    • RDY: 목적지가 요청을 처리할 수 있으며, WebtoB와 연결된 목적지가 존재하는 상태입니다.

    • NRDY: 요청을 처리할 수 없으며, WebtoB와 연결된 목적지가 존재하지 않는 상태입니다.

    • BLK: 목적지가 관리자 명령에 따라 일시 정지된 상태이며, 이로 인해 목적지는 요청을 처리할 수 없습니다.

    aqcnt

    현재까지 큐에 대기했던 요청 수(cqcnt의 cumulative 값)입니다.

    count

    요청 처리 수입니다.

    cqcnt

    현재 큐에서 대기 중인 요청 수입니다.

    qpcnt

    큐에 대기 중이던 요청이 timeout 또는 qp 명령 등으로 인해 큐에서 제거된 요청 수입니다.

    reqs

    해당 목적지에 보내진 요청 수입니다.

    rscnt

    해당 목적지의 비정상 종료로 인한 재시작 횟수입니다.

connection-info (ci, coni, coninfo)

WebtoB의 클라이언트와 목적지의 연결 정보를 출력합니다.

  • 사용법

    > ci [-jeus <JEUS 목적지 이름>][-rproxy <역방향 프록시 목적지 이름>]
    옵션 설명

    [-jeus <JEUS 목적지 이름>]

    정보를 출력할 JEUS 목적지 이름을 지정합니다.

    [-rproxy <역방향 프록시 목적지 이름>]

    정보를 출력할 역방향 프록시 목적지 이름을 지정합니다.

  • 사용 예시

    [wsadmin]>> ci
    ---------------------------------------------------------------------------------------------------------------------------------------------------
    | HTH-0 : Connection info                                                                                                                         |
    ---------------------------------------------------------------------------------------------------------------------------------------------------
    | No | Server |    Local Address    |    Remote Address    | Remote Type | Ssl | Status | Request Count | Response Count | Idle Time | Mapping No |
    ---------------------------------------------------------------------------------------------------------------------------------------------------
    | 0  | WJP-0  | 192.168.15.120:9999 | 192.168.15.120:40158 |     JSV     | No  | READY  |       1       |       1        |    23     |     -1     |
    | 1  | WJP-0  | 192.168.15.120:9999 | 192.168.15.120:40170 |     JSV     | No  | READY  |       1       |       1        |    13     |     -1     |
    | 2  | WJP-0  | 192.168.15.120:9999 | 192.168.15.120:40186 |     JSV     | No  | READY  |       1       |       1        |    42     |     -1     |
    | 3  | WJP-0  | 192.168.15.120:9999 | 192.168.15.120:40202 |     JSV     | No  | READY  |       1       |       1        |    31     |     -1     |
    | 4  | WJP-0  | 192.168.15.120:9999 | 192.168.15.120:40214 |     JSV     | No  | READY  |       1       |       1        |    26     |     -1     |
    | 5  | WJP-0  | 192.168.15.120:9999 | 192.168.15.120:40220 |     JSV     | No  | READY  |       1       |       1        |    12     |     -1     |
    | 6  | WJP-0  | 192.168.15.120:9999 | 192.168.15.120:40224 |     JSV     | No  | READY  |       0       |       0        |    27     |     -1     |
    | 7  | WJP-0  | 192.168.15.120:9999 | 192.168.15.120:40230 |     JSV     | No  | READY  |       0       |       0        |    27     |     -1     |
    | 8  | WJP-0  | 192.168.15.120:9999 | 192.168.15.120:40234 |     JSV     | No  | READY  |       0       |       0        |    27     |     -1     |
    | 9  | WJP-0  | 192.168.15.120:9999 | 192.168.15.120:40240 |     JSV     | No  | READY  |       0       |       0        |    27     |     -1     |
    | 21 | http1  | 192.168.15.120:8080 | 192.168.15.120:47098 |   CLIENT    | No  | READY  |       3       |       3        |    12     |     -1     |
    ---------------------------------------------------------------------------------------------------------------------------------------------------

    다음은 출력 항목에 대한 설명입니다.

    출력 항목 설명

    No

    WebtoB 내부적으로 관리하는 커넥션 번호입니다.

    Server

    WebtoB 내부적으로 관리하는 서버 이름입니다.

    Local Address,
    Remote Address

    서버와 클라이언트의 IP 주소와 포트 번호입니다.

    Remote Type

    해당 연결의 타입입니다.

    • CLIENT: 클라이언트와의 연결

    • CLIENT_WEBSOCKET: 클라이언트와의 웹소켓 연결

    • RPROXY: 내부 역방향 프록시 목적지와의 연결

    • RPROXY_PERSISTENT: 내부 역방향 프록시 목적지와의 Keep-Alive 연결

    • RPROXY_WEBSOCKET: 내부 역방향 프록시 목적지와의 웹소켓 연결

    • JSV: 내부 JEUS 목적지와의 연결

    Ssl

    해당 연결이 SSL로 연결되어 있는지 여부입니다.

    Status

    연결 상태입니다.

    • READY: 클라이언트로부터 요청을 받을 수 있는 상태입니다.

    • RUNNING: 클라이언트의 요청을 처리 중

    Request Count

    해당 연결로 보내진 요청 수입니다.

    Response Count

    해당 연결이 처리한 요청 수입니다.

    Idle Time

    해당 연결에서 데이터를 주고받지 않은 상태로 지속된 시간입니다.

    Mapping No

    해당 연결과 관련된 연결 번호입니다.
    클라이언트 연결인 경우 요청을 처리 중인 목적지 연결 번호를 표시하며, 목적지 연결인 경우 요청을 보낸 클라이언트 연결 번호를 표시합니다. 만약 연관된 연결이 없으면 -1로 표시됩니다.

shutdown (down)

동작 중인 WebtoB를 종료합니다.

  • 사용법

    > shutdown [-t <강제종료 시간>]
    옵션 설명

    [-t <강제종료 시간>]

    종료 명령 후에 해당 시간 동안 WebtoB 가 종료가 되지 않으면, 강제 종료합니다.

exit

wsadmin 툴을 종료합니다.

  • 사용법

    [wsadmin]>> exit

configMigrator

configMigrator는 WebtoB5 환경 파일을 WebtoB6에 맞게 마이그레이션합니다.

내부적으로는 WebtoB5 환경 파일을 중간 파일인 wsconfig 파일로 컴파일 한 후, 컴파일된 결과를 기반으로 마이그레이션합니다.

configMigrator와 관련된 모든 파일은 다른 경로를 명시하지 않을 경우 config 디렉토리를 기반으로 합니다. wsconfig파일도 config 디렉토리에 생성됩니다.

  • 사용법

    $ configMigrator [-h|--help] [-v|--version] [-i|--input_config_name <WebtoB5 설정 파일 이름>] [-o|--output_config_name <WebtoB6 설정 파일 이름>] [-f|--format <WebtoB6 설정 파일 확장자>]
    옵션 설명

    [-h|--help]

    configMigrator에서 사용 가능한 옵션에 대한 설명을 조회합니다. 다른 옵션은 무시됩니다.

    [-v|--version]

    WebtoB6의 버전을 조회합니다. -h 이외의 다른 옵션은 무시됩니다.

    [-i|--input_config_name <WebtoB5 설정 파일 이름>]

    WebtoB5 설정 파일을 지정합니다. WebtoB6의 config 디렉토리를 기반으로 한 상대경로를 지정할 수도 있고, 절대경로를 지정할 수도 있습니다. (기본값: http.m)

    [-o|--output_config_name <WebtoB6 설정 파일 이름>]

    WebtoB6 설정 파일을 지정합니다. WebtoB6의 config 디렉토리를 기반으로 한 상대경로를 지정할 수도 있고, 절대경로를 지정할 수도 있습니다. (기본값: webtob-config-generated)

    [-f|--format <WebtoB6 설정 파일 확장자>]

    WebtoB6 설정 파일의 확장자를 지정합니다. -o 옵션에서 확장자까지 명시한 경우 생략할 수 있습니다. 다음의 세 가지 확장자를 지원합니다: json, yml, yaml (기본값: json)

  • 사용 예시

    옵션 미사용 (config 디렉토리에 http.m 파일이 있을 경우)
    $ configMigrator
              Environment variables for WebtoB6:
                    WEBTOB_HOME = /home/tmax/webtob6/
    
    Current configuration:
            Number of client handler(HTH) = 1
            Supported maximum user per node = 16357
            Supported maximum user per handler = 16357
    
    Successfully created the configuration file (/home/tmax/webtob6/config/wsconfig) for node webtob1.
    The host name of the running machine is tmax.
    legacy config file: /home/tmax/webtob6/config/http.m
    modern config file: /home/tmax/webtob6/config/webtob-config-generated.json
    
    
    migration complete: /home/tmax/webtob6/config/webtob-config-generated.json
    input_config_name과 output_config_name을 경로와 함께 지정
    $ configMigrator -i ~/webtob5/config/http.m -o ~/webtob6/config/webtob-config-migrated.yaml
             Environment variables for WebtoB6:
                    WEBTOB_HOME = /home/tmax/webtob6/
    
    Current configuration:
            Number of client handler(HTH) = 1
            Supported maximum user per node = 16337
            Supported maximum user per handler = 16337
    
    Successfully created the configuration file (/home/tmax/webtob6/config/wsconfig) for node webtob1.
    The host name of the running machine is tmax.
    legacy config file: /home/tmax/webtob5/config/http.m
    modern config file: /home/tmax/webtob6/config/webtob-config-migrated.yaml
    
    
    migration complete: /home/tmax/webtob6/config/webtob-config-migrated.yaml

configValidator

configValidator는 WebtoB 설정 파일에 대한 스키마 검증을 수행합니다.

WebtoB를 기동하기 전에 미리 configValidator 툴을 통해 설정 파일에 대한 검증 결과를 확인할 수 있습니다.

WebtoB의 설정 파일은 기본적으로 webtob-config.json이며, 환경 변수 WEBTOB_CONFIG_FILE_NAME을 통해 설정 파일을 변경할 수 있습니다.

  • 사용법

    $ configValidator
  • 사용 예시

    정상적인 WebtoB 설정 파일 검증
    $ configValidator
    Config file path: ../config/webtob-config.json
    Schema file path: ../config/webtob-config.schema.json
    WEBTOB_HOME = ../
    ******* Start config validation *******
    1. Opened schema file
    2. Opened config file
    3. Config parsing finished
    4. Pre-validation process finished
    5. Validation using json-schema finished
    6. Post-validation process finished
    Config file "../config/webtob-config.json" is validated with schema file "../schema/webtob-config.schema.json"
    Success to load config files : webtob-config.json
    ******* Validation success *******
    비정상적인 WebtoB 설정 파일 검증
    $ configValidator
    Config file path: ../config/webtob-config.json
    Schema file path: ../config/webtob-config.schema.json
    WEBTOB_HOME = ../
    ******* Start config validation *******
    1. Opened schema file
    2. Opened config file
    3. Config parsing finished
    4. Pre-validation process finished
    [Exception on json-schema validation][Config validation failed]At /node/hth_count of -1 - instance is below minimum of 1

mkpwd

mkpwd는 SSL 절의 certificate_key_password를 지원하기 위한 툴입니다.

SSL 절에 암호화된 개인키를 설정하면 WebtoB를 기동할 때마다 암호문 입력을 요구합니다. 매번 암호문을 입력하는 번거로움을 줄이기 위해 certificate_key_password를 설정할 수 있습니다. mkpwd는 certificate_key_password에 적용할 수 있도록 passphrase 암호를 저장하는 passphrase 파일을 생성합니다.

certificate_key_password 사용법은 SSL 절 설정 항목을 참고합니다.

  • 사용법

    $ mkpwd <파일 경로> <SSL 이름>
    옵션 설명

    <파일 경로>

    certificate_key_password에 사용되는 파일 이름으로 mkpwd 실행의 결과를 해당 파일에 (추가)저장합니다.

    <SSL 이름>

    SSL 절에 설정한 이름입니다.

  • 사용 예시

    옵션 미사용
    $ mkpwd
    << Usage >>
    $ mkpwd file_path ssl_name
    	 file_path: output file for ssl certificate key password
    	 ssl_name: name of SSL section
    file_path과 ssl_name을 지정
    $ mkpwd ssl.ppd ssl1
    Make password for SSL certificate key password
    Enter password: (암호문 입력)
    Successfully Added password for [ssl1] to a file [ssl.ppd].
    
    $ls -al ssl.ppd
    -rw-rw-r--  1 webtob webtob 14 Nov 6 12:34 ssl.ppd
  • 파일 내용 확인

    $ cat ssl.ppd
    ssl1 dGVzdA==