웹사이트 검색

12일(6일차) - 기능 기반 생일 알림 서비스를 위한 외부 로깅 설정


12일간의 DigitalOcean에 다시 오신 것을 환영합니다! 지난 5일 동안 귀하는 PostgreSQL 데이터베이스에 연락처를 저장하고, 생일을 확인하고, SMS 알림을 보내고, DigitalOcean Functions를 사용하여 자동으로 실행하고, 트리거로 예약을 자동화하는 완전한 기능을 갖춘 생일 알림 서비스를 구축했습니다.

오늘은 로깅을 설정하여 앱의 안정성을 더욱 높여보겠습니다. 로그는 모든 앱의 숨은 영웅입니다. 로그는 뒤에서 무슨 일이 일어나고 있는지 확인하고, 버그를 잡아내고, 문제를 효과적으로 해결하는 데 도움이 됩니다.

✨ 외부 로깅 서비스를 사용하는 이유는 무엇입니까?

DigitalOcean은 모든 기능 로그(콘솔 출력 및 오류 메시지 모두)를 Papertrail, BetterStack(이전 LogTail) 또는 DataDog와 같은 외부 로깅 서비스로 전달하는 기본 제공 방법을 제공합니다. 이러한 서비스는 다음과 같은 강력한 기능을 제공합니다.

  • 로그를 검색하고 필터링하여 특정 이벤트나 오류를 빠르게 찾아보세요.
  • 디버깅이나 감사를 위해 로그 기록을 유지합니다.
  • 로그를 중앙 대시보드에 집계하여 여러 앱을 한 곳에서 모니터링하세요.
  • 중요한 문제에 대한 알림을 설정하고 Slack 또는 PagerDuty와 같은 도구와 통합하세요.

예를 들어, 생일 알림 서비스가 갑자기 알림 전송을 중단하는 경우 외부 로그를 통해 문제가 데이터베이스 연결 오류인지, 잘못 구성된 API인지, 아니면 완전히 다른 것인지를 정확히 찾아내는 데 도움이 될 수 있습니다.

🚀 무엇을 배울 것인가

이 가이드를 마치면 다음 방법을 알게 됩니다.

  • Papertrail을 사용하여 DigitalOcean 기능에 대한 로깅을 설정하세요.
  • 토큰 기반 인증을 사용하여 로그를 안전하게 전달하기 위한 진입점인 Papertrail에 로그 대상을 만듭니다.
  • Papertrail 대시보드에 로그가 캡처되고 있는지 확인하세요.

이 튜토리얼에서는 Papertrail을 예로 사용하지만 이 단계는 BetterStack 또는 DataDog와 같은 다른 서비스에 쉽게 적용할 수 있습니다.

🛠 필요한 것

시작하기 전에 다음 사항을 확인하세요.

  • DigitalOcean에 배포된 생일 알림 서비스(4일차부터).
  • Papertrail 계정에 액세스합니다(아직 계정이 없으면 계정을 만듭니다).
  • 함수에 대한 project.yml 파일입니다.

🧑🍳 6일차 레시피: 로깅 설정

1단계: DigitalOcean에서 Papertrail 로깅 활성화

먼저, 귀하의 계정에서 Papertrail이 활성화되어 있는지 확인하세요.

  1. DigitalOcean 계정에 로그인하세요.

  2. 대시보드에서 SaaS 추가 기능으로 이동합니다.

  3. 페이퍼트레일을 찾아 페이퍼트레일 추가를 클릭하세요.

  4. 무료 요금제를 선택하세요(고급 로그 검색은 포함되지 않지만 실험하기에 좋습니다).

  5. 약관에 동의하고 Papertrail 추가를 클릭하여 서비스를 활성화하세요.

그게 다야! 이제 Papertrail이 DigitalOcean 계정에 연결되었습니다. 🎉

이제 DigitalOcean 계정에 대해 Papertrail이 활성화되었으므로 다음 단계는 토큰 기반 인증을 사용하는 Papertrail에 로그 대상을 만드는 것입니다.

2단계: 토큰 기반 인증을 사용하여 Papertrail에 로그 대상 생성

이미 Papertrail 계정이 있는 경우 계정에 로그인하세요. 그렇지 않더라도 걱정하지 마세요. Papertrail을 사용하면 쉽게 시작할 수 있습니다. 신용카드 없이도 무료로 가입할 수 있습니다. 일단 가입하면 로그 대상을 생성할 준비가 된 것입니다.

  1. Papertrail 계정에 로그인하고 설정 > 로그 대상으로 이동합니다.

  2. 새 목적지를 클릭합니다.

  3. 대상 생성 페이지에서:

    • 목적지 이름 지정: my-birthday-reminder-service-logs와 같이 설명적인 이름을 사용하세요.
    • 다음을 통해 연결 허용에서 토큰 기반 인증을 위해 토큰을 선택합니다(HTTPS가 선택되어 있는지 확인).
    • 만들기를 클릭합니다.

  4. 생성되면 로그 대상 세부정보 아래에 토큰이 표시됩니다. 이 토큰을 복사하세요. 앱을 구성하는 데 필요합니다.

3단계: .env 파일 및 project.yml 업데이트

DigitalOcean Function의 로그를 Papertrail로 전달하려면 .env 파일에 토큰을 추가하고 의 LOG_DESTINATIONS 필드에서 직접 참조해야 합니다. project.yml.

  1. 프로젝트 루트에서 .env 파일을 열고 다음 줄을 추가하세요.

    PAPERTRAIL_API_TOKEN=<your-token>
    

    을 Papertrail에서 복사한 토큰으로 바꾸세요.

  2. 다음으로, project.yml 파일을 열고 LOG_DESTINATIONS 필드를 포함하도록 environment 섹션을 업데이트하세요. 업데이트된 project.yml은 다음과 같습니다.

    packages:
      - name: reminders
        shared: false
        environment:
          DB_NAME: "${DB_NAME}"
          DB_USER: "${DB_USER}"
          DB_PASSWORD: "${DB_PASSWORD}"
          DB_HOST: "${DB_HOST}"
          DB_PORT: "${DB_PORT}"
          TWILIO_ACCOUNT_SID: "${TWILIO_ACCOUNT_SID}"
          TWILIO_AUTH_TOKEN: "${TWILIO_AUTH_TOKEN}"
          TWILIO_PHONE_FROM: "${TWILIO_PHONE_FROM}"
          TWILIO_PHONE_TO: "${TWILIO_PHONE_TO}"
          LOG_DESTINATIONS: '[{"papertrail":{"token":"${PAPERTRAIL_API_TOKEN}"}}]'
        functions:
          - name: birthdays
            runtime: python:default
            triggers:
              - name: daily-birthday-trigger
                sourceType: scheduler
                sourceDetails:
                  cron: "50 7 * * *"
    
    

    이 구성에서는 다음을 수행합니다.

    • .env 파일의 PAPERTRAIL_API_TOKEN은 LOG_DESTINATIONS 필드에서 자동으로 참조됩니다.
    • 이렇게 하면 인증을 위해 토큰이 Papertrail로 안전하게 전달됩니다.
  3. 변경 사항을 저장하고 함수를 배포합니다.

    doctl serverless deploy my-birthday-reminder-service
    

도움말: 이 명령을 실행할 때 my-birthday-reminder-service 디렉토리 내에 있지 않은지 확인하세요. 배포 오류를 방지하려면 상위 디렉터리에서 실행하세요.

4단계: Papertrail에서 로그 확인

구성이 완료되면 로그를 확인하여 모든 것이 작동하는지 확인해 보겠습니다. curl 명령을 사용하여 빠른 테스트를 시작한 다음 함수가 예상대로 로그를 보내는지 확인합니다.

Curl을 사용한 빠른 테스트

기능을 테스트하기 전에 다음 curl 명령을 사용하여 Papertrail 로그 대상이 올바르게 설정되었는지 확인하세요.

  • 터미널을 열고 다음 명령을 실행하세요.

    curl -u :<your-token> \
        -H "Content-Type: application/json" \
        -d '{"hello": "world"}' \
        https://logs.collector.solarwinds.com/v1/log
    

를 Papertrail에서 복사한 토큰으로 바꾸세요.

  • Papertrail 계정에 로그인하고 이벤트 탭(https://my.papertrailapp.com/events)으로 이동합니다.

  • {"hello": "world"}라는 로그 항목을 찾으세요.

    1. 로그가 나타나는 경우: 축하합니다! 로그 대상이 올바르게 설정되었습니다.
    2. 그렇지 않은 경우: 토큰을 다시 확인하고 curl 명령을 다시 시도하세요. 올바른 토큰과 엔드포인트 URL을 사용하고 있는지 확인하세요.

기능 테스트

로그 대상이 작동하는지 확인했으면 이제 기능을 테스트할 차례입니다.

  • 로그를 생성하려면 함수를 수동으로 트리거하세요.
doctl serverless activations invoke reminders/birthdays

도움말: 원하는 경우 제어판에서 해당 기능으로 이동한 후 실행을 클릭하여 수동으로 기능을 실행할 수도 있습니다.

  • 제어판에서 실행할 경우 확인:

    • 실행을 클릭하면 기능이 활성화되었다는 확인 메시지가 표시됩니다.
    • 모든 것이 올바르게 설정되면 로그에 다음과 유사한 메시지도 표시됩니다.
    2024-12-26T22:58:27.164476652Z stdout: Logs will be written to the specified remote location. Only errors in doing so will be surfaced here.
    

    이는 로그가 Papertrail에 성공적으로 전달되고 있음을 확인합니다.

  • Papertrail 계정에 로그인하고 이벤트 탭(https://my.papertrailapp.com/events)으로 이동합니다.

  • 다음과 같은 함수의 로그 항목을 확인하세요.

    2024-12-26T23:05:39 INFO: Reminder sent to +1234567890 for Alice Smith's birthday.
    
    1. 로그가 나타나는 경우: 함수가 Papertrail에 로그를 성공적으로 보내는 중입니다.
    2. 그렇지 않은 경우: 아래 문제해결 섹션으로 진행하세요.

문제 해결

Papertrail에 로그가 표시되지 않는 경우 디버깅할 수 있는 몇 가지 단계는 다음과 같습니다.

  1. 구성 확인: project.yml 파일에 LOG_DESTINATIONS 필드가 포함되어 있고 Papertrail 토큰을 올바르게 참조하는지 확인하세요.

  2. 로깅 문 확인: __main__.py 파일에 로그를 생성하는 print 또는 logger.info 문이 포함되어 있는지 확인하세요. . 예를 들어:

    import logging
    
    logging.basicConfig(level=logging.INFO)
    
    def main(params):
        logging.info("Reminder function triggered.")
        print("Reminder function executed.")
    
  3. Curl로 테스트: curl 명령을 다시 실행하여 토큰과 로그 대상이 여전히 예상대로 작동하는지 확인합니다.

  4. 함수 재배포: 구성이나 로깅 문이 변경된 경우 함수를 다시 배포합니다.

    doctl serverless deploy my-birthday-reminder-service
    
  5. 활성화 로그 확인: 다음 명령을 사용하여 최신 활성화 로그에 오류가 있는지 확인하세요.

    doctl serverless activations logs --function reminders/birthdays --last
    

다음 단계를 수행하면 로깅 설정과 관련된 문제를 식별하고 해결할 수 있습니다.

🎁 마무리

오늘 귀하는 다음을 통해 생일 알림 서비스 수준을 높였습니다.

  1. DigitalOcean에서 Papertrail 로깅을 활성화합니다.
  2. Papertrail에 토큰 기반 로그 대상을 만들었습니다.
  3. Papertrail의 토큰 기반 로그 대상을 사용하여 앱에서 Papertrail로 로그를 전달합니다.
  4. Papertrail에서 확인된 로그입니다.

로그인하면 앱을 보다 효과적으로 모니터링하고 문제를 해결할 수 있습니다. 🎉

되돌아보기: 지금까지의 여정

이제 지금까지 생일 알림 서비스를 통해 달성한 모든 것을 축하하는 시간을 가져보겠습니다. 지난 6일 동안 귀하의 활동은 다음과 같습니다.

  1. 1일차: 연락처를 저장할 PostgreSQL 데이터베이스 설정
  2. 2일차: 데이터베이스에 연결하고 생일을 가져오는 Python 스크립트 작성
  3. 3일차: Twilio를 사용하여 SMS 알림을 보내는 기능이 추가되었습니다.
  4. 4일차: DigitalOcean Functions에 앱을 배포하여 서버리스 및 확장 가능하게 만들었습니다.
  5. 5일차: 일정에 따라 실행되도록 자동 알림
  6. 6일차: PaperTrail과 같은 서비스를 사용하여 로그를 캡처하고 저장하도록 로깅 설정

다음으로 우리는 두 번째 앱인 이메일 기반 영수증 프로세서를 구축하기 위해 방향을 전환할 것입니다. 이건 조금 다르지만 똑같이 흥미롭습니다. 내일 다음 챌린지에 뛰어들면서 더 멋진 도구와 기술을 배울 준비를 하세요! 🚀

관련기사: