Amazon Connect CCP ログを取得する方法

CCP ログはブラウザを閉じたり、ブラウザのリロードや再ログインを行うとリセットされてしまうので、事象が再現した際のログを速やかに取得してください

困っていた内容

AWS サポートより調査のために、事象が発生した際の CCP(コンタクトコントロールパネル)ログの提出を求められました。 CCP ログの取得方法を教えて下さい。

どう対応すればいいの?

CCP ログは Amazon Connect を利用するエージェントに起因するエラーをトラブルシューティングする際に役立ちます。
CCP ログの取得方法は、 Amazon Connect にサインインしているエージェントの CCP (ウェブ上)からダウンロード可能です。
ログは、自身のブラウザのデフォルトのダウンロードディレクトリに保存されます。

ただし、CCP ログはブラウザを閉じたり、ブラウザのリロードや再ログインを行うとリセットされてしまうため、過去に起きた事象のログをさかのぼって取得することはできなくなります。
そのため、サポートへ提出する CCP ログは事象が再現した際のログを速やかに取得するようにしてください。

また、コンタクトコントロールパネル (CCP) にアクセスするには、セキュリティプロファイルで問い合わせコントロールパネルへのアクセス許可を持つユーザーとしてログインする必要があります。

手順

Amazon Connect コンソールへサインイン

構築した Amazon Connect インスタンスのコンソールへ作成したユーザを利用してサインインします。

エージェントが CCP を利用

通常の利用のように CCP の画面を開いて、エージェントから顧客へ発信・着信をします。

CCP ログをダウンロード

CCP の利用が終わったら、CCP ログをダウンロードします。

右上の歯車マークから設定画面を開きます。 その後、「設定」>「電話の種類」を任意のものを選択 >「言語」を任意のものを選択します。

設定が完了したら、下部の「ログをダウンロード」をクリックすると、「agent-log.txt」というファイルがダウンロードされます。

最後に

CCP ログを一部抜粋しますが、以下のような形式となっており、ログの中身を確認するにはユーザフレンドリーではありません。
そのため、CCP Log Parser という AWS 製のツールを利用することで視覚的にログの分析を行うこともできます。
GitHub で公開されており、ローカルにクローンして起動したり、静的な Web サイトとしてホスティング(CloudFront + S3 など)することも可能です。

また、CCP Log Parser 上で、キーワードやログレベルでフィルタリングすることでき、取得したい情報をより早く見つけることができます。
ログ内に記録されたエラーに関するヒントも表示されるため、自身でトラブルシューティングする際にかなり有用です。

[
    {
        "component": "ccp",
        "level": "INFO",
        "text": "User Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/94.0.4606.61 Safari/537.36",
        "time": "2021-10-05T03:16:29.252Z",
        "exception": "null",
        "objects": "[]",
        "line": 0,
        "agentResourceId": null,
        "loggerId": "1633403788770-8khsz0mycfb"
    },
    {
        "component": "ccp",
        "level": "INFO",
        "text": "isCCPv2: true",
        "time": "2021-10-05T03:16:29.253Z",
        "exception": "null",
        "objects": "[]",
        "line": 1,
        "agentResourceId": null,
        "loggerId": "1633403788770-8khsz0mycfb"
    },
    {
        "component": "ccp",
        "level": "INFO",
        "text": "isFramed: false",
        "time": "2021-10-05T03:16:29.253Z",
        "exception": "null",
        "objects": "[]",
        "line": 2,
        "agentResourceId": null,
        "loggerId": "1633403788770-8khsz0mycfb"
    },
    {
        "component": "ccp",
        "level": "INFO",
        "text": "[Softphone Manager] initSoftphoneManager started",
        "time": "2021-10-05T03:16:29.257Z",
        "exception": "null",
        "objects": "[]",
        "line": 3,
        "agentResourceId": null,
        "loggerId": "1633403788770-8khsz0mycfb"
    },
    {
        "component": "ccp",
        "level": "INFO",
        "text": "[Softphone Manager] competeForMasterOnAgentUpdate executed",
        "time": "2021-10-05T03:16:29.258Z",
        "exception": "null",
        "objects": "[]",
        "line": 4,
        "agentResourceId": null,
        "loggerId": "1633403788770-8khsz0mycfb"
    },

--- 以下、省略 ---

参考資料