Configuring CloudHub alert endpoints

개요

CloudHub Portal 알람 엔드포인트는 CloudHub Portal 사용자 인터페이스를 사용하여 알람을 전송하는 Kapacitor 기반의 이벤트 핸들러를 만들 수 있습니다. CloudHub Portal을 사용하여 Application뿐만 아니라 특정 URL에도 알람 메시지를 보낼 수 있습니다.

이 가이드는 CloudHub Portal 알람 엔드포인트 구성을 위한 단계별 지침을 제공합니다.

CloudHub Portal에서 지원하는 Kapacitor 이벤트 핸들러

CloudHub Portal은 InfluxData의 데이터 처리 플랫폼과 Kapacitor를 통합하여 이벤트 핸들러에 알람 메시지를 전송합니다. CloudHub Portal는 다음 이벤트 핸들러를 지원합니다.

• Exec

• HTTP/Post

• Kafka

• Log

• Slack

• SMTP/Email

• Telegram

• TCP

CloudHub Portal에서 Kapacitor 이벤트 핸들러를 구성하려면 Kapacitor를 설치하고 이를 CloudHub Portal에 연결합니다. Kapacitor 구성 페이지에는 이벤트 핸들러 구성 옵션이 포함됩니다.

알람 엔드포인트 구성

CloudHub Portal의 Configure Kapacitor 페이지에서는 알람 엔드포인트 구성이 나타납니다. 구성에 액세스하려면 연결된 Kapacitor 인스턴스가 있어야 합니다. 자세한 내용은 Kapacitor 설치 지침 및 CloudHub Portal에 Kapacitor 인스턴스 연결방법을 참조하세요.

알람 엔드포인트 구성 섹션의 구성 옵션이 모두 포함되지 않는 점을 유의하세요. 일부 이벤트 핸들러는 사용자가 알람 규칙에 의해 이벤트 핸들러 구성을 사용자 정의할 수 있도록 합니다. 예를 들어 CloudHub Portal에서 Slack Integration을 통해 사용자는 알람 엔드포인트 구성 섹션에서 Default Channel과 개별 알람 규칙 설정으로 다른 Channel을 지정할 수 있습니다.

Exec

exec 이벤트 핸들러는 외부 프로그램을 실행합니다. 이벤트 데이터는 STDIN을 통해 프로세스에 전달됩니다.

id: handler-id
topic: topic-name
kind: exec
options:
  prog: /path/to/executable
  args: 'executable arguments'

|alert()
  // ...
  .exec('/path/to/executable', 'executable arguments')

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_idle" < 10)
    .exec('/usr/bin/python', 'sound-the-alarm.py')

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_idle" < 10)
    .message('Hey, check your CPU')
    .topic('cpu')

kapacitor define cpu_alert -tick cpu_alert.tick
kapacitor enable cpu_alert

id: exec-cpu-alert
topic: cpu
kind: exec
options:
  prog: '/usr/bin/python'
  args: 'sound-the-alarm.py'

kapacitor define-topic-handler exec_cpu_handler.yaml

외부 프로그램으로 사용할 python script 작성

$ vim alarm.py

--- vim ---
import os.path
from datetime import datetime

file = '/Users/choedaebeom/alarm-log.txt'

if os.path.isfile(file):
 fs = open('/Users/choedaebeom/alarm-log.txt','a')
else:
 fs = open('/Users/choedaebeom/alarm-log.txt','w')

now = datetime.now()
fs.write(str(now)+'\n')
fs.close()

:wq

exec 이벤트 핸들러 사용하기

1. 왼쪽 내비게이션에서 Alert → Alert Setting 탭을 클릭하여 페이지를 이동합니다.

   

2. 오른쪽 위의 + Build Alert Rule 버튼을 클릭합니다.

   

3. 알람 규칙의 이름을 “exec idle cpu usage alert“ 으로 지정하고, Alert Type은 임계치 설정을 위해 Threshold로 지정합니다.

   

4. Time Series는 telegraf.autogen → cpu → usage_idle로 설정합니다. Condition은 현재 알람 규칙의 실행 조건을 결정하는 단계입니다. usage_idle이 100% 미만 일 때 이벤트 핸들러가 실행됩니다. (100%는 테스트를 위한 값입니다. 실제 적용 시 상황에 알맞게 사용해야 합니다.)

   

5. Condition의 조건에 만족했을 때 실행할 이벤트 핸들러입니다. 이 예제에서는 exec을 선택합니다.

   

6. exec 입력창에 외부 프로그램을 실행시킬 프로그램의 경로와 외부 프로그램의 경로를 지정합니다. 구분자는 공백입니다.

   // 외부프로그램 실행시킬 프로그램 + 공백 + 외부프로그램
   /path/to/executable /executable/arguments
   
   // example
   /usr/local/bin/python3.7 /Users/choedaebeom/alarm.py

   
   Message 입력창에 아래 문구의 입력합니다. exec 이벤트 핸들러는 외부 프로그램(경보음, 경고등) 등을 실행시키기 위함입니다. 따라서 exec 이벤트 핸들러는 Message를 전송하지 않지만, 알람 규칙 내에 혼용되는 이벤트 핸들러들을 위해 입력합니다.

   '{{ .Time }}: CPU idle usage 100%'

   

7. 오른쪽 위의 Save Rule 버튼을 클릭하여 알람 규칙을 저장합니다.

   

8. exec 이벤트 핸들러가 외부 프로그램을 잘 실행시키는지 확인합니다.

   

HTTP/Post

post 이벤트 핸들러는 JSON 인코딩된 알람 데이터를 HTTP 엔드포인트에 전송합니다.

[[httppost]]
  endpoint = "example"
  url = "http://example.com/path"
  headers = { Example = "your-key" }
  basic-auth = { username = "my-user", password = "my-pass" }
  alert-template = "{{.Message}}:{{range .Data.Series}}{{.Tags}},{{range .Values}}{{.}}{{end}}{{end}}"
  alert-template-file = "/path/to/template/file"
  row-template = "{{.Name}} host={{index .Tags \"host\"}}{{range .Values}} {{index . "time"}} {{index . "value"}}{{end}}"
  row-template-file = "/path/to/template/file"

KAPACITOR_HTTPPOST_0_ENDPOINT = "example"
KAPACITOR_HTTPPOST_0_URL = "http://example.com/path"
KAPACITOR_HTTPPOST_0_HEADERS_Example1 = "header1"
KAPACITOR_HTTPPOST_0_HEADERS_Example2 = "header2"

[[httppost]]
  endpoint = "endpoint1"
  url = "http://example-1.com/path"
  # ...

[[httppost]]
  endpoint = "endpoint2"
  url = "http://example-2.com/path"
  # ...

KAPACITOR_HTTPPOST_0_ENDPOINT = "example0"
KAPACITOR_HTTPPOST_0_URL = "http://example-0.com/path"
KAPACITOR_HTTPPOST_0_HEADERS_Example1 = "header1"
KAPACITOR_HTTPPOST_0_HEADERS_Example2 = "header2"

KAPACITOR_HTTPPOST_1_ENDPOINT = "example1"
KAPACITOR_HTTPPOST_1_URL = "http://example-1.com/path"
KAPACITOR_HTTPPOST_1_HEADERS_Example1 = "header1"
KAPACITOR_HTTPPOST_1_HEADERS_Example2 = "header2"

id: handler-id
topic: topic-name
kind: post
options:
  # Using the 'example' endpoint configured in the kapacitor.conf
  endpoint: example

id: handler-id
topic: topic-name
kind: post
options:
  # Defining post options "inline"
  url: http://example.com/path
  headers:
    'Example1': 'example1'
    'Example2': 'example2'
  capture-response: true
  timeout: 10s
  skipSSLVerification: true

|alert()
  // ...  
  // Using the 'example' endpoint configured in the kapacitor.conf
  .post()
    .endpoint('example')

|alert()
  // ...
  // Defining post options "inline"
  .post('https://example.com/path')
    .header('Example1', 'example1')
    .header('Example2', 'example2')
    .captureResponse()
    .timeout(10s)
    .skipSSLVerification()

[[httppost]]
  endpoint = "api-alert"
  url = "http://mydomain.com/api/alerts"
  headers = { From = "alerts@mydomain.com" }
  alert-template = "{{.Message}}:{{range .Data.Series}}{{.Tags}},{{range .Values}}{{.}}{{end}}{{end}}"

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_idle" < 10)
    .message('Hey, check your CPU')
    .post()
      .endpoint('api-alerts')

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_idle" < 10)
    .message('Hey, check your CPU')
    .post('https://example.com/path')
      .header('Example1', 'example1')
      .header('Example2', 'example2')
      .captureResponse()
      .timeout(10s)
      .skipSSLVerification()

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_idle" < 10)
    .message('Hey, check your CPU')
    .topic('cpu')

kapacitor define cpu_alert -tick cpu_alert.tick
kapacitor enable cpu_alert

id: post-cpu-alert
topic: cpu
kind: post
options:
  url: 'http://example.com/path'
  headers:
    'From': 'alert@mydomain.com'

kapacitor define-topic-handler post_cpu_handler.yaml

[[httppost]]
  endpoint = "example"
  url = "http://example.com/path"
  alert-template = "{{.Message}}:{{range .Data.Series}}{{.Tags}},{{range .Values}}{{.}}{{end}}{{end}}"

[[httppost]]
  endpoint = "example"
  url = "http://example.com/path"
  alert-template-file = "/etc/templates/alert.html"

{{.Message}}:{{range .Data.Series}}{{.Tags}},{{range .Values}}{{.}}{{end}}{{end}}

[[httppost]]
  endpoint = "example"
  url = "http://example.com/path"
  row-template = '{{.Name}} host={{index .Tags "host"}}{{range .Values}} {{index . "time"}} {{index . "value"}}{{end}}'

[[httppost]]
  endpoint = "example"
  url = "http://example.com/path"
  row-template-file = "/etc/templates/row.html"

{{.Name}} host={{index .Tags \"host\"}}{{range .Values}} {{index . "time"}} {{index . "value"}}{{end}}

테스트 서버 만들기 Node.js

1. http-server 디렉터리 생성 후 진입합니다.

   $ mkdir http-server && cd http-server

   

2. 초기 package.json을 설정합니다.

   $ yarn init
   yarn init v1.16.0
   question name (http-server): 
   question version (1.0.0): 
   question description: 
   question entry point (index.js): 
   question repository url: 
   question author: 
   question license (MIT): 
   question private: 
   success Saved package.json

   

3. expresss 라이브러리와 body-parser 라이브러리를 의존성 추가하고, package.json을 확인합니다.
   1. 의존성 추가

   $ yarn add express body-parser
   ...
   Done

   

   
   2. 의존성 확인

   $ cat package.json 
   {
     "name": "http-server",
     "version": "1.0.0",
     "main": "index.js",
     "license": "MIT",
     "dependencies": {
       "body-parser": "^1.19.0",
       "express": "^4.17.1"
     }
   }

   

4. http-server.js 파일 생성 후 작성

   $ vi http-server.js
   
   --- vi ---
   const express = require('express')
   const bodyParser = require('body-parser')
   const app = express()
   
   app.use(bodyParser.json())
   
   app.post('/postAlert', (req, res) => {
     console.log(req.body)
   })
   
   app.listen(3333, () => {
     console.log('server start! http://localhost:3333')
   })
   
                                                                                                                                    
   :wq

   1. vi로 파일 생성하기

   

   2. 생성된 파일의 코드 작성하기

   

CloudHub에서 HTTP/Post 이벤트 핸들러 알람 규칙 설정하기

1. 왼쪽 내비게이션에서 Alert → Alert Setting 탭을 클릭하여 페이지를 이동합니다.

   

    

2. 오른쪽 위의 + Build Alert Rule 버튼을 클릭합니다.

   

    

3. 알람 규칙의 이름을 “http/post idle cpu usage alert“으로 지정하고, Alert Type은 임계치 설정을 위해 Threshold로 지정합니다.

   

    

4. Time Series는 telegraf.autogen → cpu → usage_idle로 설정합니다. Condition은 현재 알람 규칙의 실행 조건을 결정하는 단계입니다. usage_idle이 100% 미만 일 때 이벤트 핸들러가 실행됩니다. (100%는 테스트를 위한 값입니다. 실제 적용 시 상황에 알맞게 사용해야 합니다.)

   

    

5. Condition의 조건에 만족했을 때 실행할 이벤트 핸들러입니다. 이 예제에서는 post를 선택합니다.

   

    

6. Post 이벤트 핸들러의 HTTP endpoint for POST request 입력란에 http://127.0.0.1:3333을 입력하고, Message의 입력란에 '{{ .Time }}: CPU idle usage 100%'를 입력합니다.

   

    

7. 오른쪽 위의 Save Rule 버튼을 클릭하여 알람 규칙을 저장합니다.

   

작성한 서버를 실행하고 들어오는 값 확인하기.

1. CLI로 돌아와 테스트용 server를 실행하면 해당 포트로 알람 정보를 수신받는 것을 알 수 있습니다.

   $ node http-server.js 
   
   server start! http://localhost:3333
   { id: 'http idle cpu usage alert',
     message: '\'2020-04-01 08:17:06 +0000 UTC: CPU idle usage 100%\'',
     details: '{"Name":"cpu","TaskName":"cloudhub-v1-b89c9ad8-a7e5-4c15-b215-8671633564d6","Group":"nil","Tags":{"cpu":"cpu-total","host":"choedaebeom-ui-MacBook-Pro.local"},"ServerInfo":{"Hostname":"localhost","ClusterID":"af16b4ea-7523-40fd-acc2-3ae2d33a8fe4","ServerID":"a6f2b0a0-28d6-4825-a1e0-3b1b20b5b189"},"ID":"http idle cpu usage alert","Fields":{"value":93.2391902024494},"Level":"CRITICAL","Time":"2020-04-01T08:17:06Z","Duration":7749000000000,"Message":"'2020-04-01 08:17:06 +0000 UTC: CPU idle usage 100%'"}\n',
     time: '2020-04-01T08:17:06Z',
     duration: 7749000000000,
     level: 'CRITICAL',
     data: { series: [ [Object] ] },
     previousLevel: 'CRITICAL',
     recoverable: true }

   

Kafka

Kafka 알람 엔드포인트를 설정하는 방법입니다.

1. Configure Kapacitor Connection 페이지에서 Kafka 탭을 클릭합니다.

2. 다음을 입력하세요.

   • ID: Kafka 클러스터에 대한 유일한 식별자입니다. 기본은 localhost입니다.

   • Brokers: host:port 형식을 사용하는 Kafka broker 주소 목록입니다.

   • Timeout: 불완전한 배치를 비우기 하기 전에 대기할 최대 시간입니다. 기본값은 10초입니다.

   • Batch Size: Kafka에 보내기 전에 일괄 처리된 메시지 수입니다. 기본값은 100입니다.

   • Batch Timeout: 일괄 처리 시간의 제한 기간입니다. 기본값은 1초입니다.

   • Use SSL: SSL 통신을 사용하려면 이 항목을 선택합니다.

   • SSL CA: SSL CA(인증 기관, certificate authority) 파일의 경로입니다.

   • SSL Cert: SSL 호스트 인증서의 경로입니다.

   • SSL Key: SSL 인증서 개인 키(private key) 파일의 경로입니다.

   • Insecure Skip Verify: SSL을 사용하지만, 체인 및 호스트 확인을 건너뛰려면 선택합니다. 자체 서명된 인증서를 사용하는지 여부를 묻습니다.

3. Save Changes를 클릭하여 구성 설정을 저장합니다.

4. Send Test Alert을 클릭하여 구성을 확인합니다.

Log

Log 이벤트 핸들러는 라인당 하나의 알람 이벤트로 지정된 로그 파일에 기록합니다. 지정된 로그 파일이 없는 경우, 해당 파일이 생성되고 작성됩니다.

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_idle" < 10)
    .message('{{ .Time }}: CPU usage over 90%')
    .log('/tmp/alerts.log')

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_idle" < 10)
    .message('{{ .Time }}: CPU usage over 90%')
    .topic('cpu')

kapacitor define cpu_alert -tick cpu_alert.tick
kapacitor enable cpu_alert

id: log-cpu-alert
topic: cpu
kind: log
options:
  path: '/tmp/alerts.log'

kapacitor define-topic-handler log_cpu_handler.yaml

log 이벤트 핸들러 사용하기

1. 왼쪽 내비게이션에서 Alert → Alert Setting 탭을 클릭하여 페이지를 이동합니다.

   

2. 오른쪽 위의 + Build Alert Rule 버튼을 클릭합니다.

   

3. 알람 규칙의 이름을 “log idle cpu usage alert“으로 지정하고, Alert type은 Threshold(임계치)로 설정합니다.

   

4. Time Series는 telegraf.autogen → cpu → usage_idle로 설정합니다. Condition은 현재 알람 규칙의 실행 조건을 결정하는 단계입니다. usage_idle이 100% 미만 일 때 이벤트 핸들러가 실행됩니다. (100%는 테스트를 위한 값입니다. 실제 적용 시 상황에 알맞게 사용해야 합니다.)

   

5. log 이벤트 핸들러의 입력창에 some.log 파일을 입력합니다. 테스트를 위해 /tmp/alert-log.log를 입력합니다. 또한, 로그 파일에 기록될 Message도 입력합니다.

   

6. 오른쪽 위의 Save Rule 버튼을 클릭하여 알람 규칙을 저장합니다.

   

7. CLI 환경에서 아래의 명령어를 입력해주세요.

   $ sudo cat /tmp/alert-log.log 
   //혹은
   $ sudo cat /tmp/alert-log.log | jq

8. alert-log.log 파일 확인하기

   

Slack

Slack은 팀에게 인기 있는 메시지 앱입니다. Cloudhub Portal은 기존 Slack Channel, DM(Direct Message)으로 알람을 보내도록 구성할 수 있습니다. 아래 섹션에서는 각 구성 옵션을 설명합니다.

Nickname this Configuration

두 개 이상의 Slack 알람 엔드포인트를 구성해야 할 경우 Slack 엔드포인트에 대한 고유한 이름을 추가해야 합니다. 이 필드를 사용하려면 하나 이상의 Slack 엔드포인트가 구성되어야 합니다.

Slack WebHook URL

Slack WebHook URL을 사용하면 CloudHub Portal에서 Slack으로 메시지를 전송할 수 있습니다. 다음 단계는 Slack WebHook URL을 만드는 방법을 설명합니다.

1.  Incoming WebHooks을 클릭하여 해당 사이트를 방문합니다.

2. Post to Channel 섹션에서 channel 또는 DM 선택합니다. 이 가이드에서는 Create a new channel버튼을 클릭하여 새로운 Channel을 생성하겠습니다. 테스트 Channel 이름을 cloudhub-test-alert로 지정하고 Create 버튼을 눌러 생성합니다.
   

   

3. Incoming Webhooks 페이지에서 Add Incoming WebHooks integration을 클릭합니다.

   

4. Slack Webhooks URL을 복사(Copy URL)합니다.

   

5. Webhook URL 정보로 Kapacitor의 설정을 변경해 주어야 합니다.

   

   
   기본 설정을 변경하고자 하는 경우 Kapacitor의 설정 파일인 kapacitor.conf를 아래와 같이 수정하고, Kapacitor를 재시작합니다.

   ...
   [slack]
     enabled = true
     url = "Webhook URL"
     channel = "#cloudhub-test-alert"
     username = "kapacitor"
     icon-emoji = ""
     global = false
     state-changes-only = false
   ...

6. Send Test Alert 버튼을 눌러 #cloudhub-test-alertChannel에 도달하는지 확인합니다.

   

Slack Channel (optional)

CloudHub Portal은 지정된 Slack Channel 또는 DM(Direct Message)에 알람 메시지를 보냅니다. Slack Channel은 #로 접두사 하거나 DM(직접 메시지)을 @으로 접두사로 하세요. 예를 들면 Channel은 #cloudhub_cat, DM은 @cloudhub_dog입니다.

이 필드가 비어 있거나 지정되지 않은 경우 CloudHub Portal은 Slack WebHook URL에 의해 지정된 Channel 또는 DM에 알람 메시지를 보내거나 알람 규칙에서 지정된 Channel 또는 DM으로 알람 메시지를 전송합니다. 알람 규칙에서 지정된 Channel 또는 DM은 Slack Channel 구성 옵션과 WebHook URL 구성보다 우선합니다.

구성 활성화

Configuration Enabled를 선택하여 구성을 사용하도록 설정합니다.

변경 사항 저장

Save Changes을 클릭하여 Slack 구성의 변경 사항들을 저장합니다.

테스트 알람 보내기

Send Test Alert를 클릭하면 알람 엔드포인트 구성을 테스트할 수 있습니다.

다른 구성을 추가

Add Another Config를 클릭하여 Slack 알람 엔드포인트를 추가할 수 있습니다. 추가된 각각의 Slack 알람 엔드포인트는 초기 Slack 알람 엔드포인트가 구성된 후 활성화할 때 Nickname this Configuration 필드에서 고유 식별자를 지정해야 합니다.

SMTP/Email

SMTP를 통해 알람 메일 받을 수 있습니다. 가지고 계신 메일의 외부 메일 설정을 통해 SMTP을 활성화해주시고, 메일 호스트에서 제공하는 정보들을 하단의 기입란에 알맞게 입력하시면 됩니다.

필수 입력창에 대한 설명

1. SMTP host
   host가 제공하는 SMTP 주소입니다.

2. SMTP port
   hotst가 제공하는 SMTP port 입니다.

3. From Email
   알람 메일을 발송하는 메일 주소를 적어주세요.

4. To Email
   알람 메일을 수신하는 메일 주소를 적어주세요.

5. User
   From Email에 사용되는 메일 주소의 아이디를 적어주세요.

6. Password
   From Email에 사용되는 메일 주소의 비밀번호를 적어주세요.

아래는 SMTP 세팅 가이드용 샘플입니다.

Telegram

Telegram은 인기 있는 메시징 앱입니다. 이번 단계에서는 CloudHub Portal에서 Telegram bot으로 알람 메시지를 보내도록 구성합니다. 아래 부문에서 각 구성 옵션을 설명합니다.

Telegram bot

CloudHub Portal은 Telegram bot에게 알람을 보냅니다. 아래에서는 새로운 Telegram Bot을 만드는 방법을 설명합니다.

1. Telegram에서 @BotFather 을 검색하고, 검색된 @BotFather를 클릭합니다.
   

   

2. @BotFather와 대화를 시작하려면 start를 클릭하고, @BotFather에 /newbot 을 전송합니다.
   

   

   @BotFather 응답:

   Alright, a new bot. How are we going to call it? Please choose a name for your bot.

3. Telegram bot name을 @BotFather에게 전송하세요.
   

   

   Telegram bot name은 자유롭게 지정할 수 있습니다. 유의해야 할 것은 Telegram의@username이 아니라는 점입니다. 5 단계에서 사용자 이름을 만들 예정입니다.
   @BotFather 응답:

   Good. Now let's choose a username for your bot. It must end in `bot`. Like this, for example: TetrisBot or tetris_bot.

4. @BotFather에게 Telegram bot의 사용자 이름을 보내세요.
   Telegram bot의 사용자 이름은 bot으로 끝나야 합니다. 예를 들어 MyHappy_bot or MyHappyBot처럼 가이드에서는 CloudHubTest3Bot으로 설정하였습니다.

   

   @BotFather 응답:

   Done! Congratulations on your new bot. You will find it at t.me/<bot-username>. You can now add a description, about section and profile picture for your bot, see /help for a list of commands. By the way, when you've finished creating your cool bot, ping our Bot Support if you want a better username for it. Just make sure the bot is fully operational before you do this.
   
   Use this token to access the HTTP API:
   `<API-access-token>`
   
   For a description of the Bot API, see this page: https://core.telegram.org/bots/api

5. Telegram bot과 대화를 시작하세요.
   @BotFather의 응답에 있는 t.me/<bot-username> 링크를 클릭하고 Telegram 응용프로그램 하단에서 Start를 클릭하세요. 새로 만든 bot은 Telegram의 채팅 목록에 나타납니다.

   

Token

이 부문에서는 Telegram API access token을 생성과 식별에 대해 설명합니다. @BotFather는 유저가 bot을 만들 때 API access token을 보냅니다. token을 찾을 수 있는 곳은 이전 섹션의 5단계에서 @BotFather 응답을 참조합니다.

API access token을 찾을 수 없는 경우 아래 단계를 사용하여 새 token을 생성합니다.

1. @BotFather에게 /token보낸 후, 인터페이스 하단에서 새로운 token을 발급받을 Telegram bot을 선택합니다.

   

   @BotFather 응답과 새로운 API access token:

   You can use this token to access HTTP API:
   <API-access-token>
   
   For a description of the Bot API, see this page: https://core.telegram.org/bots/api

Chat ID

이번 섹션은 chat ID를 식별하는 방법을 설명합니다.

1. 아래 링크에서 <API-access-token>을 이전 섹션에서 만들어둔 API access token으로 변경하고 브라우저의 주소창에 붙여넣기 합니다.

   https://api.telegram.org/bot<API-access-token>/getUpdates?offset=0
   
   응답 샘플

   

2. bot으로 메시지를 전송하기.
   Telegram bot으로 메시지를 전송하기. 메시지에 담을 텍스트는 자유롭게 쓰실 수 있습니다. 채팅 기록을 알고 싶다면 채팅 내역에 하나 이상의 메시지가 포함되어야 합니다.
   1. 브라우저를 새로 고침 합니다.
   2. 아래의 링크에 API access token, chat Id, 메시지로 넣을 text를 대치하여 기입합니다.
   https://api.telegram.org/bot<API-access-token>/sendMessage?chat_id=<id>&text=<text>
   
   응답 샘플

   

   브라우저에서 숫자 형식으로 된 chat ID를 식별하세요. 아래의 예에서 chat ID는 123456789입니다.

   {"ok":true,"result":[{"update_id":XXXXXXXXX,
      "message":{"message_id":2,"from":{"id":123456789,"first_name":"Mushroom","last_name":"Kap"},"chat":{"id":123456789,"first_name":"Mushroom","last_name":"Kap","type":"private"},"date":1487183963,"text":"hi"}}]}

응답을 토대로 입력하기

1. Token
   bot의 API access token을 기재합니다.

2. Chat ID
   알람 메시지를 받을 계정의 Chat ID를 기재합니다.

3. Select the alert message format. 알람 메시지 형식을 선택합니다.
   알람 메시지의 형식을 지정하려면 마크다운(기본) 또는 HTML을 선택합니다.

4. Disable link previews in alert messages. 링크 미리 보기 비활성화
   알람 메시지에서 링크 미리 보기를 비활성화하려면 이 옵션을 선택합니다.

5. Disable notifications on iOS devices and disable sounds on Android devices. Android users continue to receive notifications. 알람 비활성화
   iOS 장치 및 안드로이드 장치의 사운드에 대한 알람을 비활성화하려면 이 옵션을 선택합니다. 안드로이드 사용자는 계속 알람을 수신합니다.

6. Send Test Alert 버튼을 클릭하면 아래의 이미지처럼 테스트 메시지가 전송됩니다.

   

TCP

TCP 이벤트 핸들러는 JSON 인코딩된 알람 데이터를 TCP 엔드포인트로 전송합니다.

id: handler-id
topic: topic-name
kind: tcp
options:
  address: 127.0.0.1:7777

|alert()
  // ...
  .tcp('127.0.0.1:7777')

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_idle" < 10)
    .message('Hey, check your CPU')
    .tcp('127.0.0.1:7777')

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_idle" < 10)
    .message('Hey, check your CPU')
    .topic('cpu')

kapacitor define cpu_alert -tick cpu_alert.tick
kapacitor enable cpu_alert

id: tcp-cpu-alert
topic: cpu
kind: tcp
options:
  address: 127.0.0.1:7777

kapacitor define-topic-handler tcp_cpu_handler.yaml

테스트 서버 만들기 Node.js

1. tcp-server 디렉터리 생성 및 진입

   $ mkdir tcp-server && cd tcp-server

   

2. package.json 생성

   $ yarn init
   yarn init v1.16.0
   question name (tcp-server): 
   question version (1.0.0): 
   question description: 
   question entry point (index.js): 
   question repository url: 
   question author: 
   question license (MIT): 
   question private: 
   success Saved package.json 

   

3. net 라이브러리 추가 후 의존성(package.json) 확인

   $ yarn add net
   $ cat package.json 
   {
     "name": "tcp-server",
     "version": "1.0.0",
     "main": "index.js",
     "license": "MIT",
     "dependencies": {
       "net": "^1.0.2"
     }
   }

   1. net 라이브러리 추가하기

      

   2. 의존성(package.json) 확인

      

4. server.js 생성 후 작성

   $ vi server.js
   
   --- vi ---
   const net_server = require('net')
   
   const server = net_server.createServer(client => {
     console.log('Client connection: ')
     console.log('   local = %s:%s', client.localAddress, client.localPort)
     console.log('   remote = %s:%s', client.remoteAddress, client.remotePort)
   
     client.setTimeout(500)
     client.setEncoding('utf8')
   
     client.on('data', data => {
       console.log(
         'Received data from client on port %d: %s',
         client.remotePort,
         data.toString()
       )
   
       writeData(client, 'Sending: ' + data.toString())
       console.log('  Bytes sent: ' + client.bytesWritten)
     })
   
     client.on('end', () => {
       console.log('Client disconnected')
     })
   
     client.on('error', err => {
       console.log('Socket Error: ', JSON.stringify(err))
     })
   
     client.on('timeout', () => {
       console.log('Socket Timed out')
     })
   })
   
   server.listen(7777, () => {
     console.log('Server listening: ' + JSON.stringify(server.address()))
     server.on('close', () => {
       console.log('Server Terminated')
     })
     server.on('error', err => {
       console.log('Server Error: ', JSON.stringify(err))
     })
   })
   
   const writeData = (socket, data) => {
     const success = socket.write(data)
     if (!success) console.log('Client Send Fail')
   }
   
   :wq

   

Cloudhub Portal에서 tcp 이벤트 핸들러를 설정하기

1. CloudHub Portal 부분입니다. 왼쪽 내비게이션에서 Alert → Alert Setting 탭을 클릭하여 페이지를 이동합니다.

   

2. 오른쪽 위의 + Build Alert Rule 버튼을 클릭합니다.

   

3. 알람 규칙의 이름을 “tcp idle cpu usage alert“ 으로 지정하고, Alert Type은 임계치 설정을 위해 Threshold로 지정합니다.

   

4. Time Series는 telegraf.autogen → cpu → usage_idle로 설정합니다. Condition은 현재 알람 규칙의 실행 조건을 결정하는 단계입니다. usage_idle이 100% 미만 일 때 이벤트 핸들러가 실행됩니다. (100%는 테스트를 위한 값입니다. 실제 적용 시 상황에 알맞게 사용해야 합니다.)

   

5. Condition의 조건에 만족했을 때 실행할 이벤트 핸들러입니다. 이 예제에서는 tcp를 선택합니다.

   

6. tcp 이벤트 핸들러의 입력창에 엔드포인트 주소는 127.0.0.1:7777입니다. 해당 엔드포인트에 JSON 인코딩된 알람 데이터가 전송됩니다.

   

7. 오른쪽 위의 Save Rule 버튼을 클릭하여 알람 규칙을 저장합니다.

   

8. 알람을 활성화되어있는지 확인합니다.

   

작성한 서버를 실행하고 들어오는 값 확인하기.

1. CLI 로 돌아와 테스트용 server를 실행하면 해당 포트로 알람 데이터를 수신받는 것을 알 수 있습니다.

   $ node server.js
   Server listening: {"address":"::","family":"IPv6","port":7777}
   Client connection: 
      local = ::ffff:127.0.0.1:7777
      remote = ::ffff:127.0.0.1:64908
   Received data from client on port 64908: {"id":"tcp idle cpu usage alert","message":"'2020-04-01 04:21:37 +0000 UTC: CPU idle usage 100%'","details":"{\u0026#34;Name\u0026#34;:\u0026#34;cpu\u0026#34;,\u0026#34;TaskName\u0026#34;:\u0026#34;cloudhub-v1-b89c9ad8-a7e5-4c15-b215-8671633564d6\u0026#34;,\u0026#34;Group\u0026#34;:\u0026#34;nil\u0026#34;,\u0026#34;Tags\u0026#34;:{\u0026#34;cpu\u0026#34;:\u0026#34;cpu-total\u0026#34;,\u0026#34;host\u0026#34;:\u0026#34;choedaebeom-ui-MacBook-Pro.local\u0026#34;},\u0026#34;ServerInfo\u0026#34;:{\u0026#34;Hostname\u0026#34;:\u0026#34;localhost\u0026#34;,\u0026#34;ClusterID\u0026#34;:\u0026#34;af16b4ea-7523-40fd-acc2-3ae2d33a8fe4\u0026#34;,\u0026#34;ServerID\u0026#34;:\u0026#34;a6f2b0a0-28d6-4825-a1e0-3b1b20b5b189\u0026#34;},\u0026#34;ID\u0026#34;:\u0026#34;tcp idle cpu usage alert\u0026#34;,\u0026#34;Fields\u0026#34;:{\u0026#34;value\u0026#34;:92.14607303651826},\u0026#34;Level\u0026#34;:\u0026#34;CRITICAL\u0026#34;,\u0026#34;Time\u0026#34;:\u0026#34;2020-04-01T04:21:37Z\u0026#34;,\u0026#34;Duration\u0026#34;:20000000000,\u0026#34;Message\u0026#34;:\u0026#34;\u0026#39;2020-04-01 04:21:37 \u0026#43;0000 UTC: CPU idle usage 100%\u0026#39;\u0026#34;}\n","time":"2020-04-01T04:21:37Z","duration":20000000000,"level":"CRITICAL","data":{"series":[{"name":"cpu","tags":{"cpu":"cpu-total","host":"choedaebeom-ui-MacBook-Pro.local"},"columns":["time","value"],"values":[["2020-04-01T04:21:37Z",92.14607303651826]]}]},"previousLevel":"CRITICAL","recoverable":true}