Elasticsearch를 Node.js에 통합하기

 

 

다음과 같은 순서로 작성되어 있습니다.

 

1. 개요

2. 준비

3. 쿼리 알아보기

4. nodejs와 통합 

5. chart로 표현하기

 

1. 개요

 

최근 회사에 Elasticsearch(이하 ES)로 통계 시스템을 구축했습니다. Mysql MyISAM 엔진으로 구축하던 것과 비교해보면 엄청나게 편리해졌네요.

 

Kibana로 쿼리하고 결과를 손쉽게 출력하여 담당자가 아닌 컨텐츠 개발자도 자신이 보고 싶은 결과를 바로 추가하여 볼 수 있을 정도니, 작은 개발사에는 이보다 더 좋은 솔루션이 있을까 싶네요.

 

그런데 ES에서 나온 다른 두 결과의 비교가 필요한 경우 불가능한 경우가 있어서 조금 아쉽더군요. 그래서 이를 직접 만들어 보기로 했습니다.

 

시간을 기준으로 데이터를 비교하는 경우는 timelion을 사용하면 되나, 시간 기준이 아니거나 두 결과의 상세 비교, 예를 들어 지난 주 매출과 이번 주 매출을 비교하여 등락을 정확히 표기하고 싶은 경우에는 CSV로 데이터를 export하여 엑셀 등에서 별도 그래프 작업이 필요했습니다.

 

그래서 ES에 쿼리를 날려 결과를 가져 온 후 회사 자체에서 사용하는 홈페이지에 있는 리포트 기능과 연동하면 좋겠다라는 생각을 하게 되었습니다. nodejs로 Elasticsearch에서 쿼리를 통해 결과를 얻어와 어딘가 저장하고, 이 결과를 기존의 결과와 비교하여 내가 원하는 그래프, 표로 출력하도록 하는 것이었죠.

 

만들면서 다른 것들은 큰 문제가 없었지만, elasticsearch에서 사용하는 쿼리 포멧에 대한 정보를 찾기가 어려워 조금 애를 먹었습니다. 이를 기록하여 메뉴얼로 만들어 두고, 공유하면 좋겠다는 생각이 들어 정리를 해봤습니다.

 

사용된 상세 솔루션, 기술 스택은 아래와 같습니다.

 

Elasticsearch( Saving raw data )

aws-cognito( Authentication )

aws-s3( Saving search results )

nginx/javascript/jquery/chart.js  ( Front-end interface )

Node.js/Express ( Rest API )

 

아래 글에서는 ELK를 이용한 시스템이 운영중인 것을 기준으로 Node.js로 Elasticsearch에 어떻게 쿼리를 하는지에 대해서 기술하였습니다

 

시스템은 아래와 같이 구축되었습니다.

 

 

 

 

(1) 리포트 사이트에서 정보를 요청한다. (필요하다면 cognito의 사용자 풀을 이용하여, 인증을 처리하고, 사용자별 권한을 나눌 수 있습니다.)

(2) 우선 S3에 저장된 요청 정보가 있는지 확인한다. (한번 읽어온 정보는 최대 100MB 공간을 마련해서 S3에서 다시 읽을 필요없도록 저장하고 있는다. 최대 용량 초과 시 참조하지 않는 결과부터 삭제). 원하는 결과가 있을 경우 바로 (5)번으로.

(3) S3에 저장된 결과가 없다면 ES에 직접 쿼리한다. 

(4) (3)에서 얻어온 결과를 S3에 저장하고, 메모리에도 저장해둔다.

(5) 검색된 결과를 돌려준다.

 

 

이 글에서는 (3)번에 대한 내용을 집중적으로 다루도록 하겠습니다. 다른 내용에 대해 필요한 분은 댓글로 남겨주세요.

 

브라우저에서 직접 쿼리를 실행할 수도 있겠지만, Caching, Security 등의 이슈가 있어 실제 쿼리를 담당하는 부분은 REST API 형태로 제작하였습니다.

 

 

2. 준비

 

동적 웹 페이지 작성 : jquery(https://jquery.com/)

결과물 출력 : chart.js(http://www.chartjs.org/)

AWS (인증 및 저장소) : https://aws.amazon.com/ko/sdk-for-node-js/ , https://aws.amazon.com/ko/sdk-for-browser/ (참고 사항으로 이 글에서는 다루지 않습니다.)

 

elasticsearch의 공식 nodejs client library는 아래 사이트들에서 확인이 가능합니다. 

github : https://github.com/elastic/elasticsearch-js

npm site: https://github.com/elastic/elasticsearch-js

공식 문서: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html

 

 

위 라이브러리를 사용하여 아래와 같이 elasticsearch에 연결할 수 있습니다. (npm site 예제 인용)

var elasticsearch = require('elasticsearch');

var client = new elasticsearch.Client({

  host: 'localhost:9200',

  log: 'trace'

});

ping 함수를 사용하여 연결 여부를 테스트 할 수 있습니다. (npm site 예제 인용)

client.ping({

  // ping usually has a 3000ms timeout

  requestTimeout: 1000

}, function (error) {

  if (error) {

    console.trace('elasticsearch cluster is down!');

  } else {

    console.log('All is well');

  }

});

(아래 내용은 elasticsearch 6.3을 기준으로 작성되어 있습니다.)

 

3. 쿼리 알아보기

 

이제 이 라이브러리를 이용해서 우리가 원하는 결과를 어떻게 쿼리할 수 있는지 알아보겠습니다.

 

주로 다룰 함수는 search입니다. 다른 기능들은 https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html 를 참고하세요.

 

search 함수에 대한 상세 내용은 아래 링크에서 확인할 수 있습니다.

https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-search 

 

쿼리를 요청하는 방법은 두 가지가 있습니다. parameter에 검색어를 넣어 요청하거나 Elasticsearch가 제공하는 Json 형태의 Query DSL(Domain Specific Language)를 사용하는 방법입니다. 여기서는 Lucene Query 방법을 간단히 확인 후 Query DSL을 이용하여 원하는 결과를 얻어오는 방법을 다뤄보겠습니다.

 

만약 raw data의 종류를 log_index라는 키를 이용해 구분한다고 가정하고, 1000번인 데이터만 검색하고 싶다고 가정해 보겠습니다.

 

nodejs에서는 search 함수를 다음과 같이 사용합니다. 

 

[Lucene query 문을 사용한 방법]

const response = await client.search({
  index: 'myindex',
  q: 'title:test'
});

 

visualize와 Timelion에서는 전반적으로 Kibana에서는 Lucene query를 사용합니다. 하지만, 상세한 필터 적용, 조건 처리를 위해서는 Query DSL이 더 유용합니다.

 

[Query DSL을 사용한 방법]

client.search({
	index: logstash-2018.10.01,
	body: {
		"query": {
			"match" : { "log_index" : "1000"}
		}
	}
});

이를 nodejs에 적용하기 전에 body의 내용을 Kibana 의 Dev Tool에서 확인할 수 있습니다.

POST logstash-2018.10.01/_search?size=0
{
  index: logstash-2018.10.01,
    body: {
      "query": {
	      "match" : { "log_index" : 1000}
    }
  }
});

 

size는 출력할 결과의 수이며 default는 10입니다. 0으로 지정하면 결과의 정보만 볼 수 있습니다. 아래와 같은 결과를 확인할 수 있습니다.

{ 
	"took": 253,           //    ms 단위로 결과를 수행한 시간 
    "timed_out": false,        
    "_shards": { 
    	"total": 1000,       //    조건에 맞는 검색된 총 개수 
    	"successful": 1000,
        "skipped": 0, 
        "failed": 0 
	}, 
    "hits": { 
    	"total": 100000000,    //    검색한 총 개수 
        "max_score": 0, 
        "hits": [] 
	} 
}

size를 원하는 만큼 지정하면 hits에 배열 형태로 포함되어 출력됩니다.

 

테스트 결과를 확인하는 방법을 알아보았으니, 이제 필요한 Query DSL에 대해서 좀 더 살펴보겠습니다.

 

아래 document에서 좀 더 상세한 내용을 확인할 수 있습니다.

 

https://www.elastic.co/guide/en/elasticsearch/reference/6.3/search-request-body.html

https://www.elastic.co/guide/en/elasticsearch/reference/6.3/query-dsl.html

 

이 중 몇 가지 샘플을 통해서 사용법을 알아보겠습니다.

 

예제) 특정 시간대의 데이터만 검색하기

 

query:{
	"bool": {
		"must" : [
			{"match" : {"log_index" : 1000}}
		],
		"must_not": [
			{"match" : {"item_type" : 100}},
			{"query_string": {"fields":["name"],"query" : "tester OR manager"}}
		],
        "filter": {
            "range" : {
                "@timestamp" : {
                    "gte" : "2018-09-01",
                    "lte" : "2018-09-30"
                }
            },
        }
    }
}

"9월 한달 간 로그 종류가 1000번 이고, 아이템 종류가 100번이 아니고, name 필드에 tester나 manager가 포함되지 않은 데이터를 검색"하는 예제입니다.

 

위 쿼리에서 볼드체로 처리된 키워드들을 살펴보겠습니다. 

 

bool : 다른 쿼리들에 공통적으로 일치하는 document를 검색합니다. Lucene의 BooleanQuery와 같은 역할을 합니다.

must, must_not : 일치하거나 배치되는 조건을 설정합니다.

match : 정확히 일치하는 조건을 설정합니다. 이와 유사한 키워드는 한 단어를 검색할 때 사용하는 term이 있는데, 이는 주어진 조건의 단어가 포함된 것 전체를 검색하게 됩니다.

query_string : query_string의 query는 조건 검색을 지원합니다. (링크)

filter : must와 비슷하지만, score^[각주:1]를 고려하지 않습니다.

range : 검색 범위를 저장할 수 있습니다.

 

 

예제) 기간 별 count 확인하기

 

query:{
	"bool" : {
		"must" : [
			{"match" : {"log_index" : 2000}}
		],
		"filter": {
			"range" : {
				"@timestamp" : {
					"gte" : "2018-09-01",
					"lte" : "2018-09-30"
				}
			},
		}
	},
	"aggs" : {
		"days" : {
			"date_histogram":{
				"field" : "@timestamp",
				"interval" : "day
			},
			"aggs" : {
				"type_count":{
					"cardinality" : {
						"field": "login"
					}
				}
			}
		}
	}
}

 

"9월 한 달간 일별 login한 횟수를 집계"하는 예제입니다. Aggregations에 대해서는 이 곳에서 상세한 정보를 확인할 수 있습니다. 

 

aggs : 집계에 대한 쿼리를 정의합니다. "days"는 집계 정보에 대한 사용자 지정 이름으로, 원하는 이름을 지정할 수 있습니다.

date_histogram : 시간을 기록한 @timestamp를 기준으로 일별 지표를 집계합니다. 집계된 정보는 "aggregations"하위에 buckets에 날짜별로 doc_count에 기록되어 결과를 얻을 수 있습니다.

cardinality : 공식 문서에 'approximate count' 라는 부연 설명이 있는데, 정확한 결과를 얻기에는 리소스가 많이 필요해 HyperLogLog++ algorithm에 기반하여 결과를 도출한다고 되어 있습니다. 보다 상세한 내용은 이 곳 을 참고 바랍니다.

 

 

4. nodejs에 통합

 

Elasticsearch로부터 원하는 결과를 얻었다면 이제 이 결과를 분석해서 웹 사이트에 표로 출력을 해보겠습니다. 

 

위에서 보았던 elasticsearch 공식 nodejs client library를 초기화하는 코드입니다.

 

var elasticsearch = require('elasticsearch');
var client = new elasticsearch.Client({
  host: 'localhost:9200',
  log: 'trace'
});

ping 함수를 사용하거나 테스트 쿼리를 날려 잘 접속되는지 확인해 보세요. 

 

이제 위에서 언급했던 "특정 시간대의 데이터만 검색하기" 결과를 받아 그래프를 그려보겠습니다. 

 

아래 코드는 Elasticsearch에 쿼리하여 원하는 데이터를 검색하고 결과를 가공하는 REST API에서 호출될 예제 함수들입니다. 

.
.
app.route('/test/query').post(function(req, res, next){
req.accepts('application/json'); testQuery(req.body.sday, req.body.eday).then((result) => { res.json('{"result":"'+JSON.stringify(result)+'"}'); // 결과를 클라이언트에 돌려줍니다.  }).catch((err) => { res.json('{"err":"'+ err + '"}'); }); })
.
.
function testQuery(startDate, endDate){
	return new Promise(resolve => {
		var listRawData = {};
		var count =0;
		.
		.
		(미리 caching했던 결과물이 있다면 search전체 읽어 결과를 바로 돌려줍니다. )
		.
		.
		client.search({
			index : 'logstash-2018.10.01',
			scroll: '2s',
			body : {
				query:{
					"bool": {
						"must" : [
							{"match" : {"log_index" : 1000}}
						],
						"must_not": [
							{"match" : {"item_type" : 100}},
							{"query_string": {"fields":["name"],"query" : "tester OR manager"}}
						],
						"filter": {
							"range" : {
								"@timestamp" : {
									"gte" : startDate,
									"lte" : endDate
								}
							}
						}
					}
				}
			}
		}, function getMoreUntilDone(err, res){
 			// listRawData 에 res.hits.hits의 내용을 적절히 쌓아둡니다.
			count += res.hits.hits.length; // listRawData 에는 중복된 데이터가 발생할 수 있으니 카운트를 별도로 처리
			if(count != res.hits.total){
				client.scroll({    //    아직 total count에 도달하지 않았다면 다음 데이터를 받아옵니다.
					scrollId: res._scroll_id,
					scroll:'2s'
				}, getMoreUntilDone);
			}else{
				var result=[];
                //    listRawData 의 결과를 가공하여 result에 넣어두세요.
                //    이 예제에서는 day와 value, value2 형태로 데이터를 가공하여 저장했다고 가정합니다.
                //    가공된 결과를 s3, 별도의 저장소 혹은 cache에 저장하여 활용할 수 있습니다.
				resolve(result); // 가공된 데이터를 돌려줍니다.
			}
		});
	});
}

 

5. Chart로 출력하기

 

이제 클라이언트측에서 받은 결과를 chart로 출력하는 과정을 살펴보겠습니다.

 

function drawResult(mainDiv){ // 그래프를 그릴 div를 전달받습니다.
    $.post("http://localhost/test/query", {'sday':'2018-09-01', 'eday':'2018-09-30'}, function(res){
        res = JSON.parse( res );
        var labels = []; // 그래프에 표기할 label을 넣습니다. 이 예제에서는 날짜 데이터가 들어갑니다.
        var values =[]; // 그래프에 표기할 값을 넣습니다.
        var values2 =[];

        res.result.forEach(function(data){
            labels.push( data.day );
            values.push( Number( data.value));
            values2.push( Number( data.value2));
        });

        var div = document.createElement('div'); // 추후 삭제를 위해 sub div 하나를 추가합니다.
        div.classList.add('chart-container');
        var chart = document.createElement('canvas');
        div.appendChild(chart);
        mainDiv.appendChild(div);

        //    이하는 chart.js를 이용해 그래프를 설정하는 샘플입니다.
        var ctx = chart.getContext('2d');
        var lineChart = new Chart(ctx, {
            type: 'line',
            data : {
                labels : labels,
                datasets : [{
                    label : "Sample Graph",
                    borderColor: 'rgb(255,99,132)',
                    data : values
                },{
                    label : "Sample Graph 2",
                    borderColor: 'rgb(99,255,132)',
                    data : values2
                }]
            },
            options: {
                responsive : true
            }
        });
    });
}

출력된 샘플 결과는 아래와 같습니다.

 

 

 

 

지금까지 Elasticsearch를 nodejs에 통합하여 결과를 우리가 원하는 곳에 출력하는 전반적인 과정을 살펴 보았습니다.

 

다음에 요청이 있거나 다른 기회가 있다면, 각 단계의 상세 과정을 다시 정리할 수 있는 기회가 있으면 좋겠습니다.

 

짧지 않은 글, 읽어 주셔서 감사합니다.