[Hyperledger Indy Docs] Indy Node: 9. Node Monitoring Tools for Stewards

이 글은 Hyperledger Indy의 공식 문서를 번역한 것입니다.
원본 사이트 : https://hyperledger-indy.readthedocs.io/projects/node/en/latest/node-monitoring-tools-for-stewards.html

 

• Plugin Manager(플러그인 관리자)
  • Events Emitted(이벤트 생성)

• Email Plugin(이메일 플러그인)
  • Prerequisites(전제 조건)
  • Install(설치)
  • Configuration(구성)
  • Email delivery frequency(이메일 배달 빈도)
• AWS SNS Plugin(AWS SNS 플러그인)
  • Prerequisites(전제 조건)
  • Setup(설정)
  • Configuration(구성)
  • Events(이벤트)
  • Hints(힌트)
  • Example(예)

 

Plugin Manager(플러그인 관리자)

현재 indy-node는 특정 기준이 충족되면 플러그인 관리자를 통해 다른 이벤트를 생성합니다. 플러그인 관리자는 이름이 "indynotifier*"로 시작하는 모든 pip 패키지를 가져오려고 합니다. 이러한 각 패키지는 send_message를 노출해야합니다. 추가 처리를 위해 관련 메시지가 있는 이벤트를 패키지로 전달하는 데 사용되는 인터페이스입니다.

플러그인 관리자 코드는 여기에 있습니다.

 

Events Emitted(이벤트 생성)

• .nodeRequestSpike : NodeRequestSuspiciousSpike
• .clusterThroughputSpike : ClusterThroughputSuspiciousSpike
• .clusterLatencyTooHigh : ClusterLatencyTooHigh
• .nodeUpgradeScheduled : NodeUpgradeScheduled
• .nodeUpgradeComplete : NodeUpgradeComplete
• .nodeUpgradeFail : NodeUpgradeFail
• .poolUpgradeCancel : PoolUpgradeCancel

 

Email Plugin(이메일 플러그인)

Prerequisites(전제 조건)

• SMTP 서버는 localhost에서 실행 중이어야합니다.
• SMTP 서버 설치(아직 없는 경우)

Ubuntu에서 가장 간단한 방법은 sendmail을 사용하는 것입니다:

$ sudo apt-get install sendmail

작동하는지 확인하려면 다음을 실행하십시오.

echo "Subject: sendmail test" | sendmail -v youremail@example.com -f alert@noreply.com

youremail@example.com에서 이메일을 받으면 sendmail이 작동하는 것입니다.

 

Install(설치)

# pip3 install indynotifieremail

 

Configuration(구성)

indy_config.py 구성 파일에 다음 줄을 추가하여 스파이크(spike) 탐지 및 알림 메커니즘을 활성화해야합니다:

SpikeEventsEnabled=True

패키지는 두 가지 환경 변수에 따라 다릅니다:

• INDY_NOTIFIER_EMAIL_RECIPIENTS (required)
• INDY_NOTIFIER_EMAIL_SENDER (optional)

아래 설명된 형식으로 indy-node 서비스에 대한 시스템 환경 변수를 설정하는 데 필요하므로 이러한 변수를 /etc/indy/indy.env 환경 파일에 추가하십시오.

 

INDY_NOTIFIER_EMAIL_RECIPIENTS

INDY_NOTIFIER_EMAIL_RECIPIENTS는 다음 형식의 문자열이어야합니다:

recipient1@adress.com [수신자가 받을 선택적 이벤트 리스트],recipient2@adress.com [이벤트 리스트]

리스트가 제공되지 않으면 수신자는 모든 이벤트에 대한 알림을 받습니다. 예:

steward1@company.com event1 event2, steward2@company.com, steward3@company.com event3

이 방법으로 steward1은 event1 및 event2에 대한 알림을 받고, steward2는 가능한 모든 알림을 받고, steward3는 event3에 대한 알림만 받습니다.

현재 이벤트 리스트는 위에서 찾을 수 있습니다.

 

INDY_NOTIFIER_EMAIL_SENDER

기본적으로 모든 이메일 알림은 alert@noreply.com에서 발송됩니다. INDY_NOTIFIER_EMAIL_SENDER를 설정하여 이를 변경할 수 있습니다. 이메일 필터에 유용할 수 있습니다.

 

Email delivery frequency(이메일 배달 빈도)

기본적으로 한 시간에 한 번 이상 같은 주제의 이메일을 받지 않습니다. 이것은 SILENCE_TIMEOUT에 의해 정의됩니다. /etc/indy/indy.env 파일에서 INDY_NOTIFIER_SILENCE_TIMEOUT 환경 변수를 설정하여 재정의 할 수 있습니다. 업데이트 절차에 관한 이메일은 항상 전달됩니다.

 

AWS SNS Plugin(AWS SNS 플러그인)

Prerequisites(전제 조건)

• 게시 권한으로 생성된 AWS SNS 토픽
• 설치된 Sovrin Validator 인스턴스

 

Setup(설정)

sovrin-notifier-awssns용 python 패키지를 설치하십시오. pip3을 사용해서만 설치해야합니다.

pip3 install sovrinnotifierawssns

 

Configuration(구성)

AWS Credential을 구성하려면 다음 값을 알아야합니다: aws_access_key_id 및 aws_secret_access_key의 값. Boto3 Configurating Credentials에 설명된 단계를 따르십시오.

다음 방법 중 하나를 사용하십시오:

• 환경 변수 AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY
• 공유된 Credential 파일(~/.aws/credentials)
• Boto2 구성 파일(/etc/boto.cfg 및 ~/.boto)

AWS Region을 구성하려면 SNS Topic이 호스팅되는 값을 알아야합니다(예:us-west-1, us-west-2, sa-east-1).

이를 달성하려면:

• AWS_DEFAULT_REGION 환경 변수 설정
• 파일(~/.aws/config)을 사용하여 region 설정

Validator에서 SOVRIN_NOTIFIER_AWSSNS_TOPICARN 환경 변수를 정의하고 유효한 AWS SNS TopicARN을 값으로 설정하십시오.

 

Events(이벤트)

알림을 발생시키는 이벤트:

• NodeRequestSuspiciousSpike
• ClusterThroughputSuspiciousSpike
• ClusterLatencyTooHigh
• NodeUpgradeScheduled
• NodeUpgradeComplete
• NodeUpgradeFail,
• PoolUpgradeCancel

 

Hints(힌트)

Validator에서 sovrin-node.service를 실행하는 계정의 홈 디렉토리는 /home/sovrin/입니다. 따라서 AWS Credential/구성 파일은 /home/sovrin/.aws 폴더에 만들어야합니다.

Validator에서 환경 변수를 설정하려면 /home/sovrin/.sovrin/sovrin.env 파일에 환경 변수를 추가하고 Validator를 다시 시작해야합니다. 이 파일에서 TopicARN을 정의해야합니다.

Ubuntu 시스템에서 Validator를 다시 시작하려면 sovrin 사용자로 로그인하지 않은 상태에서 sudo systemctl restart sovrin-node.service 명령을 실행해야합니다.

 

Example(예)

sovrinnotifierawssns 패키지가 이미 설치되어 있다고 가정하면 이 간단한 스크립트는 설정을 완료합니다:

#!/bin/bash

sudo mkdir /home/sovrin/.aws

sudo sh -c "printf \"[default]\nregion=us-west-2\" > /home/sovrin/.aws/config"

sudo sh -c "printf \" .[default]\naws_access_key_id=AKIAIGKGW3CKRXKKWPZA\naws_secret_access_key=<YOUR_SECRET_KEY>\" > /home/sovrin/.aws/credentials"

sudo sh -c "printf \"SOVRIN_NOTIFIER_AWSSNS_TOPICARN=arn:aws:sns:us-west-2:034727365312:validator-health-monitor-STN\" >> /home/sovrin/.sovrin/sovrin.env"

sudo chown -R sovrin:sovrin /home/sovrin/.aws /home/sovrin/.sovrin/sovrin.env

sudo systemctl restart sovrin-node