<div id="readability-page-1" class="page"><div itemprop="articleBody"> <img src="https://raw.githubusercontent.com/grafana/k6/master/assets/k6-logo-with-grafana.svg" alt=""> <a href="https://k6.io/" target="_blank" rel="noopener noreferrer">k6 (opens new window)</a>는 Grafana Lab에서 만든 load testing 툴로 API endpoint에 대한 성능 테스트를 쉽게 할수 있도록 도와준다. 특히, 기존에 Grafana를 쓰고 있었다면 연결하여 시각화도 잘 보여주니 유용하게 사용 할 수 있을 것이다. 성능 테스트가 아니더라도 CI에서 지속적으로 API가 예상대로 잘 동작하고 있는지 테스트하는 용도로 사용 가능하다. 문서가 워낙 잘 되어있고, 자바스크립트에 대한 이해도가 어느정도 있다면 쉽게 시작할 수 있다. 문서에서는 다음과 같은 상황에서 사용할 수 있다고 설명하고 있다. <ul><li>Load testing : <a href="https://k6.io/docs/test-types/stress-testing/#spike-testing" target="_blank" rel="noopener noreferrer">spike (opens new window)</a>, <a href="https://k6.io/docs/test-types/stress-testing/" target="_blank" rel="noopener noreferrer">stress (opens new window)</a>, <a href="https://k6.io/docs/test-types/soak-testing/" target="_blank" rel="noopener noreferrer">soak (opens new window)</a> 테스트 등 다양한 load test를 최소한의 리소스로</li> <li>Performance and synthetic monitoring: 지속적으로 prod 환경 성능 및 유효성 확인</li> <li>Chaos and reliability testing : k6에서는 다양한 설계에 대해 extension들을 제공하고 있다. (<a href="https://k6.io/docs/extensions/getting-started/explore/" target="_blank" rel="noopener noreferrer">k6 extensions (opens new window)</a>)</li></ul> 간단한 HTTP API뿐만 아니라 websocket, web crawling 등 다양한 케이스에서도 사용하고 있으며, 기존에 <a href="https://k6.io/blog/load-testing-with-postman-collections/" target="_blank" rel="noopener noreferrer">postman (opens new window)</a>이나 <a href="https://k6.io/blog/load-testing-your-api-with-swagger-openapi-and-k6/" target="_blank" rel="noopener noreferrer">swagger (opens new window)</a>를 이용하고 있었다면 이를 k6용 script로 변환해주는 툴도 제공하고 있다. 직접 설치하여 사용하는 <a href="https://k6.io/open-source" target="_blank" rel="noopener noreferrer">"k6 Open Source" (opens new window)</a> 와 클라우드 SaaS로 제공하는 <a href="https://k6.io/cloud/" target="_blank" rel="noopener noreferrer">"k6 Cloud" (opens new window)</a>가 있다. 이 글에서는 "k6 Open Source" 로컬 사용을 기준이다. <h2 id="설치"><a href="#설치">#</a> 설치</h2> Mac을 기준 <code>brew</code>로 바로 설치 가능하며, <a href="https://k6.io/docs/getting-started/installation/" target="_blank" rel="noopener noreferrer">이외의 다른 OS에서도 쉽게 설치 (opens new window)</a>할 수 있는 방법을 제공하고 있다. <h2 id="테스트-코드"><a href="#테스트-코드">#</a> 테스트 코드</h2> (k6는 맘껏 테스트 해볼수 있는 API <a href="https://test.k6.io/" target="_blank" rel="noopener noreferrer">test.k6.io (opens new window)</a>를 제공하고 있다.) <h2 id="테스트-결과값"><a href="#테스트-결과값">#</a> 테스트 결과값</h2> <ul><li>테스트 세부 내용 : 테스트 내용 및 부하 옵션 (<a href="#%ED%85%8C%EC%8A%A4%ED%8A%B8-Options">options</a> 을 이용해 부하 상세 설정을 해줄 수 있다) </li> <li>진행 바(Progress bar) : 테스트 상태 및 각 작업 걸린 시간 </li> <li>테스트 결과 내용 : 테스트 완료 후 결과</li> <li><a href="https://k6.io/docs/getting-started/results-output/" target="_blank" rel="noopener noreferrer">result output 공식 문서 (opens new window)</a></li> <li>결과값을 datadog, grafana 등을 통해 시각화 할 수 있다. <a href="https://k6.io/docs/results-visualization/" target="_blank" rel="noopener noreferrer">result visualiazation 공식 문서 (opens new window)</a></li></ul> <h2 id="options-테스트-부하-설정"><a href="#options-테스트-부하-설정">#</a> <code>options</code> : 테스트 부하 설정</h2> <ul><li>vu(virtual user) : 병렬로 <code>while(true)</code>를 얼마나 돌릴것인지</li> <li>duration : 이 테스트를 얼마나 돌릴 것인지</li> <li><a href="#thresholds">thresholds</a>: 테스트 성공/실패 기준 메트릭 <ul><li>ex. 95% of requests have a response time below 200ms.</li></ul></li> <li><a href="https://k6.io/docs/using-k6/k6-options/reference/" target="_blank" rel="noopener noreferrer">k6 options 공식 문서 (opens new window)</a></li></ul> 예를 들어, "10 VUs로 30초동안 돌린다!" 를 하기 위해서는 "CLI", "코드로 설정" 두가지 방법이 있다. <h3 id="cli"><a href="#cli">#</a> CLI</h3> <h3 id="코드로-options-설정하기"><a href="#코드로-options-설정하기">#</a> 코드로 <code>options</code> 설정하기</h3> <ul><li>options가 적용되는 순서는 다음과 같다. CLI flag가 가장 마지막에 덮어씌워지니 여러 곳에 option을 설정한 경우 유의 해야 한다.</li></ul> <img src="https://k6.io/docs/static/cd2ffc633dd58c67e276922851216ab9/0e253/order-of-precedence.png" alt=""> (ref: <a href="https://k6.io/docs/using-k6/k6-options/how-to#order-of-precedence" target="_blank" rel="noopener noreferrer">https://k6.io/docs/using-k6/k6-options/how-to#order-of-precedence (opens new window)</a>) <h3 id="thresholds"><a href="#thresholds">#</a> <code>thresholds</code></h3> 결과 메트릭들의 성공/실패 척도 정의. 부하 테스트의 목표치 혹은 SLO(service level objective)를 정의하는데 자주 사용된다. <ul><li><a href="https://k6.io/docs/using-k6/thresholds" target="_blank" rel="noopener noreferrer">threshold 공식 문서 (opens new window)</a></li></ul> <h2 id="lifecycle"><a href="#lifecycle">#</a> Lifecycle</h2> <ul><li><a href="https://github.com/grafana/k6/blob/master/samples/experimental/redis.js" target="_blank" rel="noopener noreferrer">Redis 연동 테스트 with setup/teardown 예제 (opens new window)</a></li> <li><a href="https://k6.io/docs/using-k6/test-life-cycle/" target="_blank" rel="noopener noreferrer">Test life cycle 공식 문서 (opens new window)</a></li></ul> <h2 id="check-테스트-통과-조건"><a href="#check-테스트-통과-조건">#</a> <code>check()</code> : 테스트 통과 조건</h2> <code>200 OK</code> 상황 이외에도 체크되어야 하는 경우들이 있을 것이다. 이 경우 <code>check</code> 내부에서 시나리오를 알맞게 변경해볼 수 있다. <h3 id="response-code-body"><a href="#response-code-body">#</a> response code, body</h3> <ul><li><a href="https://k6.io/docs/using-k6/checks/" target="_blank" rel="noopener noreferrer">check 공식 문서 (opens new window)</a></li></ul> <h3 id="redirect-체크-테스트"><a href="#redirect-체크-테스트">#</a> Redirect 체크 테스트</h3> <ul><li><a href="https://github.com/grafana/k6/blob/master/samples/redirects.js" target="_blank" rel="noopener noreferrer">https://github.com/grafana/k6/blob/master/samples/redirects.js (opens new window)</a></li></ul> <h2 id="batch-여러-요청-한꺼번에-처리하기"><a href="#batch-여러-요청-한꺼번에-처리하기">#</a> <code>batch()</code> : 여러 요청 한꺼번에 처리하기</h2> 병렬로 여러 요청을 테스트하고 싶을 때, <code>array</code> 혹은 <code>object</code> 로 넘겨 한번에 테스트 할수 있다. <ul><li><a href="https://k6.io/docs/javascript-api/k6-http/batch/" target="_blank" rel="noopener noreferrer">batch 공식 문서 (opens new window)</a></li></ul> <h2 id="group-테스트-그룹핑"><a href="#group-테스트-그룹핑">#</a> <code>group()</code> : 테스트 그룹핑</h2> 많은 테스트 케이스들을 한번에 돌려야 할때, 단계적으로 테스트 결과를 그룹화하여 볼 수 있어 테스트 시나리오를 이해하는데 유용하다. <ul><li><a href="https://k6.io/docs/using-k6/tags-and-groups/#groups" target="_blank" rel="noopener noreferrer">group 공식 문서 (opens new window)</a></li></ul> <h2 id="k6chaijs-이용하여-bdd-적용하기"><a href="#k6chaijs-이용하여-bdd-적용하기">#</a> k6chaijs 이용하여 BDD 적용하기</h2> 테스트를 BDD 패턴으로 나타낼 수도 있다. (<a href="https://johngrib.github.io/wiki/junit5-nested/#describe---context---it-%ED%8C%A8%ED%84%B4" target="_blank" rel="noopener noreferrer">Describe-context-it 패턴 (opens new window)</a>에서 자세히 잘 설명이 되어있다.) <ul><li>위에서 살펴본 <code>group()</code> 과 거의 동일하다. 공식문서 역시 " It's a more powerful alternative to the k6-native check() and group()." 설명하고 있다. 기존 <code>Chai</code> 나 <code>Jest</code>, <code>Jasmine</code> 을 써왔던 사람에게는 사용법이 좀 더 친숙할 것이다.</li> <li>integration test에서 조건에 따른, 테스트 케이스를 체크할 경우에 알맞다. <ul><li>예) 응답이 <code>200 OK</code> 인 경우에만! JSON body 체크를 한다.</li></ul></li> <li>Chain of assertions : <code>check()</code>와 다르게, <code>expect()</code>는 실패하게 되면 <code>describe()</code>안에 있는 모든 케이스에 대해서 멈추게 된다. 즉, 앞에 실패하게 되면 뒷 부분 테스트가 필요없는 테스트 시나리오의 경우에 사용하기에 좋다.</li> <li><a href="https://k6.io/docs/javascript-api/jslib/k6chaijs/" target="_blank" rel="noopener noreferrer">k6chaijs 공식 문서 (opens new window)</a></li></ul> <h2 id="참고하기-좋은-문서들"><a href="#참고하기-좋은-문서들">#</a> 참고하기 좋은 문서들</h2> k6는 정말 참고 할 만한 문서가 많다. 처음부터 모두 이해하지 않더라도, 필요 시나리오에 따라 일단 찾아가며 복붙 하다 보면 자연스럽게 익힐 수 있을 것 같다. <ul><li>k6 examples : <a href="https://k6.io/docs/examples" target="_blank" rel="noopener noreferrer">https://k6.io/docs/examples (opens new window)</a></li> <li>awesome k6 : <a href="https://github.com/grafana/awesome-k6" target="_blank" rel="noopener noreferrer">https://github.com/grafana/awesome-k6 (opens new window)</a></li> <li>k6 learn : <a href="https://github.com/grafana/k6-learn" target="_blank" rel="noopener noreferrer">https://github.com/grafana/k6-learn (opens new window)</a></li></ul></div></div>

Daily Log

k6는 Grafana Lab에서 만든 load testing 툴로 API endpoint에 대한 성능 테스트를 쉽게 할수 있도록 도와준다. 특히, 기존에 Graf ...

k6 부하 테스트 툴

댓글