SMS Gateway からの usage イベントのレポート

tenantID を持つ SMS Gateway テナントごとに、各 SMS Gateway テナントの使用量が 10 秒ごとに測定されます。 SMS Gateway は、イベントを保管する Splunk HTTP Event Collector (HEC) または REST サーバーと容易に統合できる形式の HTTP POST 要求として、usage レポート・イベントを生成します。

usage イベントを IBM Cloudant データベースにパブリッシュするための SMS Gateway の構成
usage イベントを CouchDB にパブリッシュするための SMS Gateway の構成
usage イベントをパブリッシュするための SMS Gateway の構成
usage イベントのフォーマット

usage イベントを IBM Cloudant データベースにパブリッシュするための SMS Gateway の構成

データベースにパブリッシュするよう SMS Gateway を構成する前に、IBM® Cloudant® for IBM Cloud をセットアップしてください。

usage イベントを IBM Cloudant データベースにパブリッシュするため、構成に以下の環境変数を設定します。構成に IBM Cloudant 構成変数を追加することによって、IBM Cloudant および別のレポート・サービスの両方を同時に使用できます。

以下の例は、usage イベントを IBM Cloudant にパブリッシュするための構成を示しています。

シングル・テナント環境: 構成に以下の環境変数を設定します。 IBM Cloudant に対する認証を、REPORTING_USAGE_CLOUDANT_APIKEY 変数を追加することによって API 鍵で行うように構成するか、または、REPORTING_USAGE_CLOUDANT_USERNAME と REPORTING_USAGE_CLOUDANT_PASSWORD を追加することによってユーザー名とパスワードで行うように構成することができます。

REPORTING_USAGE_CLOUDANT_URL=http://usageCloudantURL.ibm.com/
REPORTING_USAGE_CLOUDANT_APIKEY=a1b2c3d3fgh1jk1mn0
REPORTING_USAGE_CLOUDANT_USERNAME=myAdmin
REPORTING_USAGE_CLOUDANT_PASSWORD=myTokenOrPassword
REPORTING_USAGE_CLOUDANT_DB_NAME=myDBname
REPORTING_USAGE_CLOUDANT_EVENT_INDEX=usage

マルチテナント JSON 構成: マルチテナント JSON 構成ファイルで、usage イベントを有効にする各テナントに、以下のプロパティーを含む reporting オブジェクトを構成します。 IBM Cloudant に対して、デフォルト以外のアカウント構成を使用する場合、追加の環境変数の組み込みが必要になる場合があります。 IBM Cloudant に対する認証を、apiKey 変数を追加することによって API 鍵で行うように構成するか、または、username と password を追加することによってユーザー名とパスワードで行うように構成することができます。
```
"reporting": {
  "usageCloudant": {
    "url": "http://usageCloudantURL.ibm.com/",
    "dbName": "myDBName",
    "username": "myAdmin",
    "password": "myTokenOrPassword",
    "apiKey": "myApiKey",
    "usageEventInd": "usage"
  }
}
```

usage イベントを CouchDB にパブリッシュするための SMS Gateway の構成

CouchDB をセットアップするには、リポジトリーを複製し、Github にある指示に従います。 CouchDB を使用する場合は、認証のために API 鍵を使用することはできません。

usage イベントを CouchDB データベースにパブリッシュするため、構成に以下の環境変数を設定します。構成に CouchDB 構成変数を追加することによって、CouchDB および別のレポート・サービスの両方を同時に使用できます。

以下の例は、usage イベントを CouchDB にパブリッシュするための構成を示しています。

シングル・テナント環境: 構成に以下の環境変数を設定します。

REPORTING_USAGE_CLOUDANT_URL="http://<svc-couchdb>:5984/"
REPORTING_USAGE_CLOUDANT_USERNAME=myCouchDBUsername
REPORTING_USAGE_CLOUDANT_PASSWORD=myCouchDBPassword
REPORTING_USAGE_CLOUDANT_DB_NAME=myCouchDB
REPORTING_USAGE_CLOUDANT_EVENT_INDEX=usage

マルチテナント JSON 構成: マルチテナント JSON 構成ファイルで、usage イベントを有効にする各テナントに、以下のプロパティーを含む reporting オブジェクトを構成します。
```
"reporting": {
  "usageCloudant": {
    "url": "http://<svc-couchdb>:5984/",
    "dbName": "myDBName",
    "username": "myAdmin",
    "password": "myTokenOrPassword",
    "usageEventInd": "usage"
  }
}
```

usage レポート・イベントをパブリッシュするための SMS Gateway の構成

例えば noSQL データベースなどに、イベントを保管できるよう Splunk HTTP Event Collector (HEC) または REST サーバーをセットアップします。
REST サーバー URL と許可資格情報を構成し、SMS Gateway で usage イベントを有効にします。

シングル・テナント環境: 構成に以下の環境変数を設定します。

REPORTING_URL=http://myresteventserver.ibm.com/
  REPORTING_USERNAME=myRestAdmin
  REPORTING_PASSWORD=myRestTokenOrPassword
  REPORTING_USAGE_EVENT_INDEX=usage

マルチテナント JSON 構成: マルチテナント JSON 構成ファイルで、使用量レポートを有効にする各テナントに、以下のプロパティーを含む reporting オブジェクトを構成します。同じオブジェクト内で、他のタイプのレポート・イベントに対するインデックスを構成できます。
```
  "reporting": {
   "url": "http://myresteventserver.ibm.com/",
     "username": "myRestAdmin",
     "password": "myRestTokenOrPassword",
     "usageEventInd": "usage"
    }
```
usage イベントをコンシュームする REST サーバーがイベントのタイプを識別できるように、usage イベント・インデックス値 usage が、すべての usage イベントに index 値として組み込まれます。インデックス・フィールドは Splunk HEC には必須ですが、これらのイベントを処理するために独自の REST サーバーを作成するユーザーにも役立ちます。

usage イベントのフォーマット

すべての SMS Gateway レポート・イベントは、Splunk HTTP Event Controller JSON フォーマットに基づきます。

次の例では、usage イベント JSON オブジェクトが、10000 ms の時間間隔内で、1 つのメッセージを受信し、1 つのメッセージを送信したことを示しています。

{
  "time": 1514131211,
  "host": "8.64.81.144",
  "source": "tenantID",
  "sourceType": "smsgw",
  "index": "usage",
  "event": {
    "periodLength": "10000",
    "inbound": "1",
    "outbound": "1",
    "total": "2",
  }
}

イベント・メタデータ

すべてのレポート・イベントは、以下のメタデータから開始します。

表 1. イベント・メタデータのキー
キー	説明
`time`	イベントの時刻。デフォルト形式は、エポックタイム (形式 `<sec>.<ms>`) です。
`host`	イベントを生成した SMS Gateway インスタンスのホスト名。
`source`	イベントを生成した SMS Gateway テナントを表します。
`sourceType`	イベントを生成したソースのタイプ。デフォルトは `smsgw` です。
`index`	レポート・イベントのタイプ。 usage イベントの場合、デフォルト値は `usage` です。
`event`	usage イベント・レポート。 usage イベント・オブジェクトを参照。

usage イベント・オブジェクト

各 usage イベントの JSON オブジェクトには、以下のキーが含まれています。

表 2. 書き起こしを定義するためのキー
キー	説明
`periodLength`	イベントの時間間隔。デフォルトのフォーマットは `ms` 単位です。
`inbound`	インバウンド・メッセージの数。
`outbound`	アウトバウンド・メッセージの数。
`total`	間隔内のメッセージの総数。