README_kr.md

어플리케이션 성능 모니터링

오픈소스 APM인 Scouter는 JVM(WAS, Standalone application)을 사용하는 어플리케이션 및 OS 자원에 대한 모니터링 모니터링 기능을 제공한다.

• APM : Application performance montoring / application performance management
• 모니터링 대상 (전용 agent)
  • Java Agent : Web application (on Tomcat, JBoss, Resin ...), Standalone java application
  • Host Agent : Linux, Windows, Unix
• 모니터링 대상 (Telegraf support)
  • Redis, nginX, apache httpd, haproxy, Kafka, MySQL, MongoDB, RabbitMQ, ElasticSearch, Kube, Mesos ...
• 모니터링 대상 (Zipkin-Scouter storage)
  • zipkin instrumentations (C#, Go, Python, Javascript, PHP...)를 XLog 차트를 통해 디스플레이합니다.
  • see the zipkin-scouter-storage documentation.
  • see the zipkin instrumentations.

사용자는 시스템에 서비스 요청을 보내고, 이를 통해 서비스는 시스템의 자원을 사용하게 된다. 시스템 성능을 잘 이해하고 관리하기 위해서는 사용자와 서비스, 자원간의 관계를 이해하고 접근하는 것이 중요하며 SCOUTER를 활용하여 보다 쉽게 이에 대한 접근이 가능하다.

• SCOUTER의 주요 모니터링 항목 :
  • 사용자 : Active User, Recent User, Today Visitor 등
  • 서비스 : Active Service, TPS, Response Time, Transaction Profile(class,sql,apicall) 등
  • 자원 : Cpu, Memory, Network and Heap usage, Connection pool 등.

소개 동영상(클릭)

Documents

• Document Home
• Quick Start(Scouter Demo 설치)
• Scouter 설치
• Live demo 접속
• XLog 로 분석하기
• 사용자 정의 알람 스크립팅 - Alert plugins guide
• Telegraf server feature
• Client 화면 설명

Download

• 최신 Release

모듈

스카우터는 4가지 주요 모듈로 구성된다 :

• Agent : 성능 데이터를 수집하여 수집 서버로 전송

  • Tomcat Agent (Java Agent) : JVM 과 Tomcat WAS 성능 수집
  • Host Agent (OS Agent) : Linux, Windows 및 OSX 성능
  • MariaDB Agent : [to be announced]

• Server (Collector) : Agent가 전송한 데이터를 저장하고 Client 요청시 Client에게 적절한 데이터를 전송

• Client (Viewer) : 수집된 데이터를 보기 위한 RCP 기반 Client 프로그램. (OSX Big Sur 미지원)

• Web API (Since @1.8.0) : 성능 카운터, XLog, 프로파일등의 정보를 HTTP 프로토콜을 통해 제공

  • Web API Guide

• Weaver (Since @2.17.0) : Java 애플리케이션의 코드 수준에서 Scouter XLog와 Profile을 직접 제어하는 기능 제공

3rd-party UIs

• scouter paper : scouter-paper homepage
  • showcase : scouter paper overview
    

Plugins

• Server plugin

  • Sample

    • scouter-plugin-server-null : 수집데이터를 단순히 출력해 주는 sample plugin

  • Alert

    • scouter-plugin-server-null : 수집데이터를 단순히 출력해 주는 sample plugin
    • scouter-plugin-server-email : Scouter에서 발생하는 alert를 email로 전송하는 plugin
    • scouter-plugin-server-telegram : Scouter에서 발생하는 alert를 telegram으로 전송하는 plugin
    • scouter-plugin-server-slack : Scouter에서 발생하는 alert를 slack으로 전송하는 plugin
    • scouter-plugin-server-line : Scouter에서 발생하는 alert를 line으로 전송하는 plugin
    • scouter-plugin-server-dingtalk : Scouter에서 발생하는 alert를 dingtalk으로 전송하는 plugin
    • scouter-plugin-server-teams : Scouter에서 발생하는 alert를 Microsoft Teams 로 전송하는 plugin

  • Counter

    • scouter-plugin-server-influxdb : Scouter의 성능 counter 데이터를 시계열 DB인 influxDB로 연동하는 plugin

• Agent plugin

  • TBD

3rd-party Agents

• Pulse type agent : scouter-pulse-library
  • aws-monitor : AWS의 Cloudwatch에서 EC2/RDS/ELB의 성능 카운터 정보를 수집

Facebook

• Scouter APM 사용자 모임 - Facebook 그룹

Scouter에 기여하기

• Pull request는 반드시 develop branch로 요청하여야 합니다.
• 상세한 내용은 개발자 가이드를 참조하시기 바랍니다.
  • Scouter 개발자 가이드
• 최초 Pull-Request시 다음 CLA(Contributor License Agreement)에 서명하여 제출하여야 합니다.

Q&A

• Google Groups

Blogging & Posts

• Scouter 소소한 시리즈 #1 - 설치
• Scouter 소소한 시리즈 #2 - 기본 항목 모니터링(1/2)
• Scouter 소소한 시리즈 #2.1 - 기본 항목 모니터링(2/2)
• Scouter 소소한 시리즈 #3 - Active service & XLog
• Scouter 소소한 시리즈 #4 - XLog 활용 - 상세 기능
• Scouter 소소한 시리즈 #5 - 사용자 정의 알림 활용
• 내 서비스에 Scouter APM을 적용해보기
• 배치 모니터링, Scouter로 편하고 효율적으로! by TMON
• 오픈소스 성능 모니터링 도구 Scouter 설정 by SUN
• Scouter, InfluxDB, Grafana 연동하기
• Scouter pulse를 이용하여 나만의 모니터링 Agent 만들기
• SCOUTER 써드파티 UI "PAPER" 빠르게 설치해보기

License

Licensed under the Apache License, Version 2.0