웹용 Firebase Performance Monitoring

1. 개요

이 Codelab에서는 Firebase Performance Monitoring을 사용하여 채팅 웹 앱의 성능을 측정하는 방법을 알아봅니다. 실시간 데모를 보려면 https://fireperf-friendchat.web.app/을 방문하세요.

3b1284f5144b54f6.png

학습 내용

  • 웹 앱에 Firebase Performance Monitoring을 추가하여 즉시 사용 가능한 측정항목 (페이지 로드 및 네트워크 요청)을 얻는 방법입니다.
  • 커스텀 trace로 특정 코드를 측정하는 방법
  • 커스텀 trace에 연결된 추가 커스텀 측정항목을 기록하는 방법
  • 맞춤 속성을 이용해 실적 데이터를 더욱 세부적으로 분류하는 방법
  • 성능 모니터링 대시보드를 사용하여 웹 앱의 성능을 파악하는 방법

필요한 사항

  • 원하는 IDE 또는 텍스트 편집기(예: WebStorm, Atom, Sublime, VS Code)
  • 터미널/콘솔
  • 원하는 브라우저(예: Chrome)
  • Codelab의 샘플 코드 (코드를 가져오는 방법은 이 Codelab의 다음 섹션 참고)

2. 샘플 코드 가져오기

명령줄에서 Codelab의 GitHub 저장소를 클론합니다.

git clone https://github.com/firebase/codelab-friendlychat-web

또는 git을 설치하지 않은 경우 저장소를 ZIP 파일로 다운로드할 수 있습니다.

시작 앱 가져오기

IDE를 사용하여 클론된 저장소에서 phone performance-monitoring-start 디렉터리를 열거나 가져옵니다. 이 📊 performance-monitoring-start 디렉터리에는 채팅 웹 앱인 Codelab의 시작 코드가 포함되어 있습니다.

3. Firebase 프로젝트 만들기 및 설정

Firebase 프로젝트 만들기

  1. Firebase Console에서 프로젝트 추가를 클릭합니다.
  2. Firebase 프로젝트의 이름을 FriendlyChat로 지정합니다.

Firebase 프로젝트의 프로젝트 ID를 기억해 둡니다.

  1. 프로젝트 만들기를 클릭합니다.

프로젝트에 Firebase 웹 앱 추가

  1. 웹 아이콘 58d6543a156e56f9.png을 클릭하여 새 Firebase 웹 앱을 만듭니다.
  2. 닉네임 Friendly Chat으로 앱을 등록한 후 이 앱의 Firebase 호스팅도 설정 옆의 체크박스를 선택합니다.
  3. 앱 등록을 클릭합니다.
  4. 나머지 단계를 클릭하여 진행합니다. 지금은 화면에 표시된 안내를 따를 필요가 없습니다. 이 Codelab의 이후 단계에서 설명합니다.

ea9ab0db531a104c.png

Firebase 인증을 위한 Google 로그인 사용 설정

사용자가 Google 계정으로 채팅 앱에 로그인할 수 있도록 Google에서는 Google 로그인 방법을 사용합니다.

다음과 같이 Google 로그인을 사용 설정해야 합니다.

  1. Firebase Console의 왼쪽 패널에서 개발 섹션을 찾습니다.
  2. 인증을 클릭한 후 로그인 방법 탭을 클릭합니다 ( 콘솔로 이동).
  3. Google 로그인 제공업체를 사용 설정한 다음 저장을 클릭합니다.

7f3040a646c2e502.png

Cloud Firestore 사용 설정

웹 앱은 Cloud Firestore를 사용하여 채팅 메시지를 저장하고 새 채팅 메시지를 수신합니다.

Cloud Firestore를 사용 설정해야 합니다.

  1. Firebase Console의 개발 섹션에서 데이터베이스를 클릭합니다.
  2. Cloud Firestore 창에서 데이터베이스 만들기를 클릭합니다.
  3. 테스트 모드에서 시작 옵션을 선택하고 보안 규칙에 관한 면책조항을 읽은 후 사용 설정을 클릭합니다.

이 Codelab의 시작 코드에는 더 안전한 규칙이 포함되어 있습니다. Codelab 후반부에서 이를 배포합니다.

24bd1a097492eac6.png

Cloud Storage 사용 설정

웹 앱은 Firebase용 Cloud Storage를 사용하여 사진을 저장, 업로드, 공유합니다.

Cloud Storage를 사용 설정해야 합니다.

  1. Firebase Console의 개발 섹션에서 스토리지를 클릭합니다.
  2. 시작하기를 클릭합니다.
  3. Firebase 프로젝트의 보안 규칙에 대한 면책 조항을 읽은 다음 확인을 클릭합니다.

시작 코드에는 Codelab의 후반부에서 배포할 기본 보안 규칙이 포함되어 있습니다.

4. Firebase 명령줄 인터페이스 설치

Firebase 명령줄 인터페이스 (CLI)를 사용하면 Firebase 호스팅을 사용하여 웹 앱을 로컬에서 제공하고 Firebase 프로젝트에 웹 앱을 배포할 수 있습니다.

  1. Firebase 문서의 안내에 따라 CLI를 설치합니다.
  2. 터미널에서 다음 명령어를 실행하여 CLI가 올바르게 설치되었는지 확인합니다.
firebase --version

Firebase CLI 버전이 v8.0.0 이상인지 확인합니다.

  1. 다음 명령어를 실행하여 Firebase CLI를 승인합니다.
firebase login

앱의 로컬 디렉터리 (앞서 Codelab에서 클론한 저장소)에서 Firebase 호스팅을 위한 앱 구성을 가져오도록 웹 앱 템플릿을 설정했습니다. 하지만 구성을 가져오려면 앱을 Firebase 프로젝트와 연결해야 합니다.

  1. 명령줄에서 앱의 로컬 performance-monitoring-start 디렉터리에 액세스하는지 확인합니다.
  2. 다음 명령어를 실행하여 앱을 Firebase 프로젝트와 연결합니다.
firebase use --add
  1. 메시지가 표시되면 프로젝트 ID를 선택한 후 Firebase 프로젝트에 별칭을 지정합니다.

별칭은 여러 환경 (프로덕션, 스테이징 등)이 있는 경우에 유용합니다. 그러나 이 Codelab에서는 default의 별칭을 사용하겠습니다.

  1. 명령줄의 나머지 안내를 따릅니다.

5. Firebase Performance Monitoring과 통합

다양한 방법으로 웹용 Firebase Performance Monitoring SDK와 통합할 수 있습니다 (자세한 내용은 문서 참조). 이 Codelab에서는 호스팅 URL에서 성능 모니터링을 사용 설정합니다.

성능 모니터링 추가 및 Firebase 초기화

  1. src/index.js 파일을 연 후 TODO 아래에 다음 줄을 추가하여 Firebase Performance Monitoring SDK를 포함합니다.

index.js

// TODO: Import the Firebase Performance Monitoring library here.
 import {
   getPerformance,
   trace
 } from 'firebase/performance';
  1. 또한 Firebase 프로젝트 및 사용하려는 웹 앱에 대한 정보가 포함된 구성 객체로 Firebase SDK를 초기화해야 합니다. 여기서는 Firebase 호스팅을 사용하고 있으므로 이 구성을 자동으로 수행하는 특수 스크립트를 가져올 수 있습니다. 이 Codelab에서는 public/index.html 파일 하단에 이미 다음 줄을 추가했지만 이 줄이 있는지 다시 한번 확인합니다.

index.html

<!-- This script is created by webpack -->
<script type="module" src="scripts/main.js"></script>
  1. src/index.js 파일에서 TODO 아래에 다음 줄을 추가하여 성능 모니터링을 초기화합니다.

index.js

// TODO: Initialize Firebase Performance Monitoring.
getPerformance();

이제 사용자가 내 사이트를 사용할 때 Performance Monitoring에서 자동으로 페이지 로드 및 네트워크 요청 측정항목을 수집합니다. 자동 페이지 로드 trace에 대한 자세한 내용은 문서를 참조하세요.

첫 입력 지연 폴리필 라이브러리 추가

첫 입력 지연은 사용자 상호작용에 반응하는 브라우저가 사용자에게 앱의 반응성에 대한 첫인상을 주기 때문에 유용합니다.

최초 입력 지연은 사용자가 버튼이나 하이퍼링크를 클릭하는 등 페이지의 요소와 처음 상호작용할 때 시작됩니다. 브라우저가 입력에 응답할 수 있게 되면 즉시 중지됩니다. 즉, 브라우저가 콘텐츠를 로드하거나 파싱하지 않는다는 의미입니다.

이 polyfill 라이브러리는 Performance Monitoring 통합에 선택사항입니다.

public/index.html 파일을 열고 다음 줄의 주석 처리를 삭제합니다.

index.html

<!-- TODO: Enable First Input Delay polyfill library. -->
<script type="text/javascript">!function(n,e){var t,o,i,c=[],f={passive:!0,capture:!0},r=new Date,a="pointerup",u="pointercancel";function p(n,c){t||(t=c,o=n,i=new Date,w(e),s())}function s(){o>=0&&o<i-r&&(c.forEach(function(n){n(o,t)}),c=[])}function l(t){if(t.cancelable){var o=(t.timeStamp>1e12?new Date:performance.now())-t.timeStamp;"pointerdown"==t.type?function(t,o){function i(){p(t,o),r()}function c(){r()}function r(){e(a,i,f),e(u,c,f)}n(a,i,f),n(u,c,f)}(o,t):p(o,t)}}function w(n){["click","mousedown","keydown","touchstart","pointerdown"].forEach(function(e){n(e,l,f)})}w(n),self.perfMetrics=self.perfMetrics||{},self.perfMetrics.onFirstInputDelay=function(n){c.push(n),s()}}(addEventListener,removeEventListener);</script>

이제 코드에서 Firebase Performance Monitoring과의 통합을 완료했습니다.

다음 단계에서는 Firebase Performance Monitoring을 사용하여 커스텀 trace를 추가하는 방법을 알아봅니다. 자동 trace만 수집하려면 '이미지 배포 및 전송 시작' 섹션으로 이동하세요.

6. 앱에 맞춤 트레이스 추가

Performance Monitoring을 사용하면 커스텀 trace를 만들 수 있습니다. 맞춤 trace는 앱의 실행 블록 기간에 대한 보고서입니다. SDK에서 제공하는 API를 사용하여 맞춤 trace의 시작과 끝을 정의합니다.

  1. src/index.js 파일에서 성능 객체를 가져온 후 이미지 메시지를 업로드하기 위한 맞춤 트레이스를 만듭니다.

index.js

// TODO: Create custom trace to monitor image upload.
const t = trace(perf, "saveImageMessage");
  1. 커스텀 trace를 기록하려면 trace의 시작점과 중지점을 지정해야 합니다. 트레이스를 타이머라고 생각하면 됩니다.

index.js

// TODO: Start the "timer" for the custom trace.
t.start();

 ...

    // TODO: Stop the "timer" for the custom trace.
    t.stop();

커스텀 trace를 정의했습니다. 코드를 배포한 후 사용자가 이미지 메시지를 보내면 커스텀 trace의 지속 시간이 기록됩니다. 이를 통해 실제 사용자가 채팅 앱에서 이미지를 전송하는 데 걸리는 시간을 파악할 수 있습니다.

7. 앱에 맞춤 측정항목을 추가합니다.

범위 내에서 발생하는 성능 관련 이벤트에 대한 맞춤 측정항목을 기록하도록 맞춤 trace를 추가로 구성할 수 있습니다. 예를 들어 측정항목을 사용하여 업로드 시간에 이전 단계에서 정의한 맞춤 trace의 이미지 크기가 이미지 크기에 영향을 미치는지 조사할 수 있습니다.

  1. src/index.js 파일에 정의된 이전 단계의 커스텀 trace를 찾습니다.
  2. TODO 아래에 다음 줄을 추가하여 업로드된 이미지의 크기를 기록합니다.

index.js

 ...

// TODO: Record image size.
t.putMetric('imageSize', file.size);

 ...

이 측정항목을 사용하면 성능 모니터링을 통해 커스텀 trace 기간과 업로드된 이미지 크기를 기록할 수 있습니다.

8. 앱에 맞춤 속성 추가

이전 단계를 기반으로 커스텀 trace에서 커스텀 속성을 수집할 수도 있습니다. 맞춤 속성을 사용하면 앱에 해당하는 카테고리별로 데이터를 세분화할 수 있습니다. 예를 들어 이미지 파일의 MIME 유형을 수집하여 MIME 유형이 성능에 미치는 영향을 조사할 수 있습니다.

  1. src/index.js 파일에 정의된 맞춤 트레이스를 사용합니다.
  2. TODO 아래에 다음 줄을 추가하여 업로드된 이미지의 MIME 유형을 기록합니다.

index.js

 ...

// TODO: Record image MIME type.
t.putAttribute('imageType', file.type);

 ...

이 속성을 사용하면 성능 모니터링을 통해 업로드된 이미지 유형에 따라 커스텀 trace 기간을 분류할 수 있습니다.

9. [확장] User Timing API를 사용하여 맞춤 트레이스 추가

Firebase Performance Monitoring SDK는 비동기식으로 로드될 수 있으므로 페이지 로드 중 웹 앱의 성능에 부정적인 영향을 미치지 않도록 설계되었습니다. SDK가 로드되기 전에는 Firebase Performance Monitoring API를 사용할 수 없습니다. 이 시나리오에서는 User Timing API를 사용하여 커스텀 trace를 추가할 수 있습니다. Firebase Performance SDK는 measure()에서 기간을 선택하여 커스텀 trace로 기록합니다.

User Timing API를 사용하여 앱 스타일 지정 스크립트를 로드하는 시간을 측정해 보겠습니다.

  1. public/index.html 파일에서 다음 줄을 추가하여 앱 스타일 지정 스크립트 로드의 시작을 표시합니다.

index.html

<!-- TODO: Mark the starting of `timer` for loading App Styling script. -->
<script type="text/javascript">performance && performance.mark('loadStylingStart');</script>
  1. 다음 줄을 추가하여 앱 스타일 지정 스크립트 로드의 끝을 표시하고 시작과 종료 사이의 시간을 측정합니다.

index.html

<!-- TODO: Mark the ending of `timer` for loading App Styling script. Measure the duration from start to end. -->
<script type="text/javascript">
  performance && performance.mark('loadStylingEnd');
  performance && performance.measure('loadStyling', 'loadStylingStart', 'loadStylingEnd');
</script>

여기에서 만든 항목은 Firebase Performance Monitoring에서 자동으로 수집합니다. 나중에 Firebase Performance Console에서 loadStyling라는 커스텀 trace를 찾을 수 있습니다.

10. 이미지 배포 및 전송 시작

Firebase 호스팅에 배포

코드에 Firebase Performance Monitoring을 추가한 후 다음 단계에 따라 코드를 Firebase 호스팅에 배포합니다.

  1. 명령줄에서 앱의 로컬 performance-monitoring-start 디렉터리에 액세스하는지 확인합니다.
  2. 다음 명령어를 실행하여 파일을 Firebase 프로젝트에 배포합니다.
firebase deploy
  1. 콘솔에 다음이 표시됩니다.
=== Deploying to 'friendlychat-1234'...

i  deploying firestore, storage, hosting
i  storage: checking storage.rules for compilation errors...
✔  storage: rules file storage.rules compiled successfully
i  firestore: checking firestore.rules for compilation errors...
✔  firestore: rules file firestore.rules compiled successfully
i  storage: uploading rules storage.rules...
i  firestore: uploading rules firestore.rules...
i  hosting[friendlychat-1234]: beginning deploy...
i  hosting[friendlychat-1234]: found 8 files in ./public
✔  hosting[friendlychat-1234]: file upload complete
✔  storage: released rules storage.rules to firebase.storage/friendlychat-1234.appspot.com
✔  firestore: released rules firestore.rules to cloud.firestore
i  hosting[friendlychat-1234]: finalizing version...
✔  hosting[friendlychat-1234]: version finalized
i  hosting[friendlychat-1234]: releasing new version...
✔  hosting[friendlychat-1234]: release complete

✔  Deploy complete!

Project Console: https://console.firebase.google.com/project/friendlychat-1234/overview
Hosting URL: https://friendlychat-1234.firebaseapp.com
  1. 자체 Firebase 하위 도메인 2개(https://<projectId>.firebaseapp.comhttps://<projectId>.web.app)에서 Firebase 호스팅을 사용해 완전히 호스팅되는 웹 앱을 방문합니다.

성능 모니터링이 사용 설정되어 있는지 확인하기

Firebase Console을 열고 성능 탭으로 이동합니다. 'SDK 감지됨'이라는 환영 메시지가 표시되면 Firebase Performance Monitoring과 성공적으로 통합한 것입니다.

30df67e5a07d03b0.png

이미지 메시지 보내기

채팅 앱에서 이미지를 전송하여 일부 성능 데이터를 생성합니다.

  1. 채팅 앱에 로그인한 후 이미지 업로드 버튼 13734cb66773e5a3.png을 클릭합니다.
  2. 파일 선택 도구를 사용하여 이미지 파일을 선택합니다.
  3. 커스텀 측정항목과 커스텀 속성의 분포를 테스트할 수 있도록 여러 개의 이미지를 전송해 보세요 (몇 개의 샘플은 public/images/에 저장됨).

새 메시지는 선택한 이미지와 함께 앱 UI에 표시됩니다.

11. 대시보드 모니터링

웹 앱을 배포하고 사용자로 이미지 메시지를 보낸 후 Firebase Console의 Performance Monitoring 대시보드에서 성능 데이터를 검토할 수 있습니다.

대시보드 액세스

  1. Firebase Console에서 Friendly Chat 앱이 있는 프로젝트를 선택합니다.
  2. 왼쪽 패널에서 품질 섹션을 찾아 성능을 클릭합니다.

기기 내 데이터 검토

성능 모니터링에서 앱 데이터가 처리되면 대시보드 상단에 탭이 표시됩니다. 아직 데이터나 탭이 표시되지 않으면 나중에 다시 확인하세요.

  1. 기기별 탭을 클릭합니다.
  • 페이지 로드 표에는 페이지가 로드되는 동안 성능 모니터링에서 자동으로 수집하는 다양한 성능 측정항목이 표시됩니다.
  • 기간 표에는 앱의 코드에 정의한 모든 커스텀 trace가 표시됩니다.
  1. 기간 테이블에서 saveImageMessage를 클릭하여 trace의 특정 측정항목을 검토합니다.

e28758fd02d9ffac.png

  1. 집계를 클릭하여 이미지 크기의 분포를 검토합니다. 이 커스텀 trace의 이미지 크기를 측정하기 위해 추가한 측정항목을 확인할 수 있습니다.

C3cbcfc0c739a0a8.png

  1. 이전 단계의 집계 옆에 있는 시간 경과를 클릭합니다. 커스텀 trace의 기간도 확인할 수 있습니다. 수집된 데이터를 자세히 검토하려면 더보기를 클릭합니다.

16983baa31e05732.png

  1. 페이지가 열리면 imageType을 클릭하여 이미지 MIME 유형별로 기간 데이터를 분류할 수 있습니다. 이 데이터는 맞춤 trace에 추가한 imageType 속성으로 인해 로깅되었습니다.

8e5c9f32f42a1ca1.png

네트워크 데이터 검토하기

HTTP/S 네트워크 요청은 네트워크 호출의 응답 시간과 페이로드 크기를 캡처하는 보고서입니다.

  1. Performance Monitoring 대시보드의 기본 화면으로 돌아갑니다.
  2. 네트워크 탭을 클릭하여 웹 앱의 네트워크 요청 항목 목록을 확인합니다.
  3. 이러한 요청을 살펴보고 느린 요청을 파악하고 앱 성능을 개선하기 위한 수정 작업을 시작하세요.

26a2be152a77ffb9.png

12. 수고하셨습니다

성능 모니터링을 위해 Firebase SDK를 사용 설정하고 자동 trace 및 커스텀 trace를 수집하여 채팅 앱의 실제 성능을 측정했습니다.

학습한 내용:

  • 웹 앱에 Firebase Performance Monitoring SDK 추가
  • 코드에 커스텀 trace 추가
  • 커스텀 trace에 연결된 커스텀 측정항목을 기록합니다.
  • 맞춤 속성을 사용하여 실적 데이터 세분화
  • 성능 모니터링 대시보드를 사용하여 앱 성능에 대한 유용한 정보를 얻는 방법 이해

자세히 알아보기: