3.2. デバッグロギング

手順

1. debug ロギング定義を追加します。

   const debug = require('debug')('myexample');

2. デバッグステートメントを追加します。

   app.use('/api/greeting', (request, response) => {
     const name = request.query ? request.query.name : undefined;
     //log name in debugging
     debug('name: '+name);
     response.send({content: `Hello, ${name || 'World'}`});
   });

3. デバッグ モジュールを package.json に追加します。

   ...
   "dependencies": {
       "debug": "^3.1.0"
     }

   アプリケーションによっては、このモジュールはすでに含まれている場合があります。たとえば、express generator を使用してアプリケーションを作成する場合、debug モジュールはすでに package.json に追加されています。

4. アプリケーションの依存関係をインストールします。

   $ npm install

手順

1. アプリケーションを起動し、デバッグロギングを有効にする場合は、DEBUG 環境変数を設定します。

   $ DEBUG=myexample npm start

   debug モジュールでは、ワイルドカード を使用してデバッグメッセージをフィルターできます。これは DEBUG 環境変数を使用して設定されます。

2. アプリケーションをテストしてデバッグロギングを呼び出します。

   たとえば、次のコマンドは、/api/greeting メソッドで name 変数をログに記録するようにデバッグログが設定されている REST API レベル 0 アプリケーションの例に基づいています。

   $ curl http://localhost:8080/api/greeting?name=Sarah

3. アプリケーションログを表示して、デバッグメッセージを表示します。

   myexample name: Sarah +3m

手順

1. oc CLI クライアントを使用して、OpenShift インスタンスにログインします。

   $ oc login ...

2. アプリケーションを OpenShift にデプロイします。

   $ npm run openshift

   これにより、openshift npm スクリプトを実行します。これは nodeshift への直接呼び出しをラップします。

3. Pod の名前を見つけ、ログを追跡して起動を監視します。

   $ oc get pods
   ....
   $ oc logs -f pod/POD_NAME

   重要

   Pod が起動したら、このコマンドを実行したままにして、新しいのターミナルウィンドウで残りの手順を実行します。これにより、ログを 追跡 でき、そのログの新しいエントリーを確認することができます。

4. アプリケーションをテストします。

   たとえば、次のコマンドは、/api/greeting メソッドで name 変数をログに記録するようにデバッグログが設定されている REST API レベル 0 アプリケーションの例に基づいています。

   $ oc get routes
   ...
   $ curl $APPLICATION_ROUTE/api/greeting?name=Sarah

5. Pod ログに戻り、ログにデバッグロギングメッセージがないことに注意してください。

6. DEBUG 環境変数を設定して、デバッグロギングを有効にします。

   $ oc get dc
   ...
   $ oc set env dc DC_NAME DEBUG=myexample

7. Pod ログに戻り、更新ロールアウトを監視します。

   更新がロールアウトされると Pod が停止し、ログをフォローしなくなります。

8. 新規 Pod の名前を見つけ、ログを追跡します。

   $ oc get pods
   ....
   $ oc logs -f pod/POD_NAME

   重要

   Pod が起動したら、このコマンドを実行したままにして、別のターミナルウィンドウで残りの手順を実行します。これにより、ログを 追跡 でき、そのログの新しいエントリーを確認することができます。具体的には、ログにはデバッグメッセージが表示されます。

9. アプリケーションをテストして、デバッグロギングを呼び出します。

   $ oc get routes
   ...
   $ curl $APPLICATION_ROUTE/api/greeting?name=Sarah

10. Pod ログに戻り、デバッグメッセージを表示します。

    ...
    myexample name: Sarah +3m