Cisco SCMS SCE Subscriber API プログラミング ガイド Release 3.1
トラブルシューティング
トラブルシューティング
発行日;2012/02/06 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 946KB) | フィードバック

目次

トラブルシューティング

SCE ロギング

デフォルト ログ メッセージ

サブスクライバ操作のログ メッセージ

API クライアント ロギング

API クライアント ログ メッセージ

トラブルシューティング

この章では、API ロギング機能を使用した、API との統合に関するトラブルシューティング方法について説明します。API ロギングを使用すると、API クライアントと SCE 側の両方で受信されたパラメータを含めて、呼び出し中の処理をモニタできます。

「SCE ロギング」

「API クライアント ロギング」

SCE ロギング

SCE プラットフォームには、ポリシー サーバで呼び出されたすべての操作を SCE ユーザログ ファイルに記録する機能があります。

「デフォルト ログ メッセージ」

「サブスクライバ操作のログ メッセージ」

デフォルト ログ メッセージ

追加設定しなくても、SCE はデフォルトで次のメッセージを発行します。

接続操作の場合:

<client-name>- connect operation was called, registered listeners: <type of the listeners that were registered>
 

切断操作の場合:

<client-name>- disconnected
 

registerLoginPullListener 操作の場合:

<client-name>- registered a Login Pull Listener
 

unregisterPullListener 操作の場合:

<client-name>- unregistered a Pull Listener
 

registerLogoutListener 操作の場合:

<client-name>- registered a Logout Listener
 

unregisterLogoutListener 操作の場合:

<client-name>- unregistered a Logout Listener
 

registerQuotaListener 操作の場合:

<client-name>- registered Quota Listener
 

unregisterQuotaListener 操作の場合:

<client-name>- unregister Quota Listener
 

synchronizePushStart 操作の場合:

<client-name>- synchronize Push Start
 

synchronizePushEnd 操作の場合:

<client-name>- synchronize Push End
 

synchronizePullStart 操作の場合:

<client-name>- synchronize Pull Start
 

synchronizePullEnd 操作の場合:

<client-name>- synchronize Pull End
 

サブスクライバ操作のログ メッセージ

サブスクライバ操作のログ メッセージは、専用フラグでアクティブ化されます。これらのメッセージを受信するには、フラグをイネーブルにします。

ロギングをイネーブルにするには、SCE プラットフォームで次の CLI を使用します。

(config)# management-agent sce-api logging
 

USERLOG ファイルを表示するには、SCE プラットフォームで次の CLI を使用します。

#>logger get user-log FILE NAME
 

) ロギングをイネーブルにすると、パフォーマンスが低下します。したがって、ロギングはトラブルシューティングを行う場合のみ使用することを推奨します。


ロギングをディセーブルにするには、SCE プラットフォームで次の CLI を使用します。

(config)#>no management-agent sce-api logging
 

ロギングがイネーブルかどうかを表示するには、SCE プラットフォームで次の CLI を使用します。

#>show management-agent sce-api
 

ロギング フラグがイネーブルの場合に、次の操作を実行すると、以下のメッセージが発行されます。

ログイン操作

networkIDUpdate 操作

ログアウト操作

quotaUpdate 操作

loginPullResponse 操作

profileUpdate 操作

getQuotaStatus 操作

<operation name>operation was called
with parameters:
subscriberID - <subscriber ID>
anonymousSubscriberID - <anonymousSubscriberID >
mappings - <mappings list>
mappings types - <mapping types list>
policy - <policy properties list>
quota - <quota operation/quota buckets list>
 

次のバルク操作の場合:

loginBulk 操作

networkIDUpdateBulk 操作

logoutBulk 操作

quotaUpdateBulk 操作

loginPullBulkResponse 操作

profileUpdateBulk 操作

getQuotaStatuBulkRequest 操作

getSubscribersBulk

次のメッセージが発行されます。

<operation name>operation was called with parameters:
bulk size - <bulk size>
 

LoginPullListener の場合は、次のメッセージが発行されます。

loginPullRequest の場合:

loginPullRequest operation was called with parameters:
anonymousSubscriberID - <anonymous subscriber ID>
mappings - <mappings list>
mapping types - <mapping types>
 

loginPullRequestBulk の場合:

loginPullRequestBulk operation was called with parameters:
bulk size - <bulk size>
 

getSubscribersBulkResponse の場合:

getSubscribersBulkResponse operation was called with parameters:
bulk size - <bulk size>
 

LogoutListener の場合は、次のメッセージが発行されます。

logoutIndication の場合

logoutIndication operation was called with parameters:
subscriberID - <anonymous subscriber ID>
 

logoutBulkIndication の場合:

logoutBulkIndication operation was called with parameters:
bulk size - <bulk size>
 

QuotaListenerEx の場合は、次のメッセージが発行されます。

quotaStatusIndication の場合:

quotaStatusIndication operation was called with parameters:
subscriberID - <Subscriber ID>
quota - <subscriber quota>
 

quotaBelowThresholdIndication の場合:

quotaBelowThresholdIndication operation was called with parameters:
subscriberID - <Subscriber ID>
quota - <subscriber quota>
 

quotaDepletedIndication の場合:

quotaDepletedIndication operation was called with parameters:
subscriberID - <Subscriber ID>
quota - <subscriber quota>
 

quotaStateRestore の場合:

quotaStateRestore operation was called with parameters:
subscriberID - <Subscriber ID>
quota - <subscriber quota>
 

quotaStatusBulkIndication の場合:

quotaStatusBulkIndication operation was called with parameters:
subs - <bulk size>
 

quotaBelowThresholdBulkIndication の場合:

quotaBelowThresholdBulkIndication operation was called with parameters:
subs - <bulk size>
 

quotaDepletedBulkIndication の場合:

quotaDepletedBulkIndication operation was called with parameters:
subs - <bulk size>
 

quotaStateBulkRestore の場合:

quotaStateBulkRestore operation was called with parameters:
subs - <bulk size>
 

API クライアント ロギング

API には、アクティブ化されたすべての処理を ${user.home} ディレクトリ内の apilog ファイルに記録する機能があります。ロギング パラメータは Log4J プロパティ ファイルを使用して設定します。ロギングをイネーブルにするには、アプリケーションの CLASSPATH にこのファイルが格納されていることを確認します。このファイルはアプリケーションを起動するときに読み込まれるため、ファイルを変更した場合は、アプリケーションを再起動する必要があります。

次に、 log4.properies ファイルの内容を示します。

# default Log4j configuration for SCE Subscriber API
log4j.rootCategory=INFO, apiStdout
# In order to enable the logging to the file Replace the above
# line with the following:
# log4j.rootCategory=INFO, files
# stdout is set to be a ConsoleAppender.
log4j.appender.apiStdout=org.apache.log4j.ConsoleAppender
log4j.appender.apiStdout.layout=org.apache.log4j.PatternLayout
log4j.appender.apiStdout.layout.ConversionPattern=+ %d{dd-MMM HH:mm:ss.SSS} [%t] %-5p %c%n%m%n
# files is set to be a RollingFileAppender.
#log4j.appender.files=org.apache.log4j.RollingFileAppender
#log4j.appender.files.layout=org.apache.log4j.PatternLayout
#log4j.appender.files.layout.ConversionPattern=+ %d{dd-MMM yyyy HH:mm:ss.SSS} [%t] %-5p %c %x\n%m\n
#log4j.appender.files.File=${user.home}/apilog
#log4j.appender.files.Threshold=INFO
#log4j.appender.files.ImmediateFlush=true
#log4j.appender.files.MaxFileSize=1MB
#log4j.appender.files.MaxBackupIndex=4
# In order to enable debug logging uncomment the following line
#log4j.category.com.scms.api.sce.prpc=DEBUG
 

デバッグ ロギングをイネーブルにするには、ファイルの最終行をコメント解除します。デフォルトでは、ロギングは標準出力に対して実行されます。ロギングをファイルに転送するには、ファイルの説明に従って、# log4j.rootCategory=INFO, files 行をコメント解除します。

API クライアント ログ メッセージ

log4j.properties ファイルを適切に設定すると、API クライアントは次のメッセージを発行します。

API コンストラクタの場合:

PRPC_SCESubscriberApi コンストラクタは、次のパラメータと一緒に呼び出されます。

apiName - <apiName>
host - <sceHost>
port - <scePort>
auto-reconnect - <autoReconnectInterval>

init 操作の場合:

init operation was called with parameters <properties>
 

setConnectionListener の場合:

setConnectionListener operation was called
 

setRedundancyStateListener の場合:

setRedundancyStateListener operation was called
 

isConnected の場合:

isConnected operation was called
 

getAPIVersion の場合:

getAPIVersion operation was called
 

次の操作の場合:

ログイン操作

networkIDUpdate 操作

ログアウト操作

quotaUpdate 操作

loginPullResponse 操作

profileUpdate 操作

getQuotaStatus 操作

次のメッセージが発行されます。

<operation name>operation was called with parameters:
subscriberID - <subscriber ID>
anonymousSubscriberID - <anonymousSubscriberID>
mappings - <mappings list>
mappings types - <mapping types list>
policy - <policy properties list>
quota - <quota operation/quota buckets list>
 

次のバルク操作の場合:

loginBulk 操作

networkIDUpdateBulk 操作

logoutBulk 操作

quotaUpdateBulk 操作

loginPullBulkResponse 操作

profileUpdateBulk 操作

getQuotaStatuBulkRequest 操作

getSubscribersBulk 操作

次のメッセージが発行されます。

operation name>operation was called with parameters:
bulk size - <bulk size>
 

接続操作の場合:

connect operation was called, registered listeners:
<type of the listeners that were registered>
 

切断操作の場合:

disconnect operation was called
 

registerLoginPullListener 操作の場合:

registerLoginPullListener operation was called
 

unregisterPullListener 操作の場合:

unregisterPullListener operation was called
 

registerLogoutListener 操作の場合:

registerLogoutListener operation was called
 

unregisterLogoutListener 操作の場合:

unregisterLogoutListener operation was called
 

registerQuotaListener 操作の場合:

registerQuotaListener operation was called
 

unregisterQuotaListener 操作の場合:

unregisterQuotaListener operation was called
 

synchronizePushStart 操作の場合:

synchronizePushStart operation was called
 

synchronizePushEnd 操作の場合:

synchronizePushEnd operation was called
 

synchronizePullStart 操作の場合:

synchronizePullStart operation was called
 

synchronizePullEnd 操作の場合:

synchronizePullEnd operation was called
 

LoginPullListener リスナ コールバック メソッドの場合は、次のメッセージが発行されます。

loginPullRequest の場合:

loginPullRequest operation was called with parameters:
anonymousSubscriberID - <anonymous subscriber ID>
mappings - <mappings list>
mapping types - <mapping types>
 

loginPullRequestBulk の場合:

loginPullRequestBulk operation was called with parameters:
bulk size - <bulk size>
 

getSubscribersBulkResponse の場合:

getSubscribersBulkResponse operation was called with parameters:
bulk size - <bulk size>
 

LogoutListener リスナ コールバック メソッドの場合は、次のメッセージが発行されます。

logoutIndication の場合

logoutIndication operation was called with parameters:
subscriberID - <anonymous subscriber ID>
 

logoutBulkIndication の場合:

logoutBulkIndication operation was called with parameters:
bulk size - <bulk size>
 

QuotaListenerEx リスナ コールバック メソッドの場合は、次のメッセージが発行されます。

quotaStatusIndication の場合:

quotaStatusIndication operation was called with parameters:
subscriberID - <Subscriber ID>
quota - <subscriber quota>
 

quotaBelowThresholdIndication の場合:

quotaBelowThresholdIndication operation was called with parameters:
subscriberID - <Subscriber ID>
quota - <subscriber quota>
 

quotaDepletedIndication の場合:

quotaDepletedIndication operation was called with parameters:
subscriberID - <Subscriber ID>
quota - <subscriber quota>
 

quotaStateRestore の場合:

quotaStateRestore operation was called with parameters:
subscriberID - <Subscriber ID>
quota - <subscriber quota>
 

quotaStatusBulkIndication の場合:

quotaStatusBulkIndication operation was called with parameters:
subs - <bulk size>
 

quotaBelowThresholdBulkIndication の場合:

quotaBelowThresholdBulkIndication operation was called with parameters:
subs - <bulk size>
 

quotaDepletedBulkIndication の場合:

quotaDepletedBulkIndication operation was called with parameters:
subs - <bulk size>
 

quotaStateBulkRestore の場合:

quotaStateBulkRestore operation was called with parameters:
subs - <bulk size>