前のトピック: CA Capacity Command Center 用のメトリック コネクタの作成次のトピック: ビジネス インジケータのメトリックの選択


Web サービス コネクタの設定

Web サービス コネクタ機能を使用すると、リモート Web サービスからデータにアクセスしてモバイル アプリケーション ダッシュボードに表示させることができます。 Basic、Digest、OAuth 1.0a、NLTM の認証方式または認証なしの RESTful Web サービス、および、XML、JSON、ATOM 形式での応答がサポートされています。たとえば、CA APM Cloud Monitor、Yahoo Services、General Sentiment、Markit On Demand、および Klout などです。

Web コネクタ機能は以下をサポートしています。

注: 以下のナレッジ ベース記事では、実際の Web サービスの例を使用して Web サービス コネクタを作成する方法についての詳細情報を提供しています: https://support.ca.com/irj/portal/anonymous/redirArticles?reqPage=search&searchID=TEC604364

メトリックおよびメタデータの要求について

要求タイプ

知っておくべき情報

メトリック

  • 利用可能なメトリックを公開し、[メトリック]タブに表示されています。
  • パラメータを使用して、Web サービスから収集するデータを指定します。 たとえば、パラメータを使用して時間間隔(開始および終了)を定義することができます。
  • この要求の実行による出力変数は、別の要求の設定時の入力値として使用することができます。

メタデータ

  • デフォルトでは、コネクタの起動時および 12 時間ごとに実行されます。 デフォルトのリフレッシュ間隔は、以下を更新することにより変更できます:
    install_dir/config/execConfig.properties ファイル内のプロパティ値 http.connector.incrementalSync.reschedule FullSync.minutes
  • [メトリック]タブには表示されません。
  • この要求の実行による出力変数は、別の要求の設定時の入力値として使用することができます。

変数について

一般的な変数使用の一例としては、ある Web サービス呼び出しが認証要求で「sessionId」を返し、2 番目の Web サービス呼び出しがこの「sessionId」を入力値の 1 つとして使用してメトリック データを取得するなどの場合があります。 この場合、最初の要求を「メタデータ」タイプ(変数「sessionId」を出力)として設定し、2 番目の要求は、メトリック データを取得するための ${sessionId} としてこの変数を使用する「メトリック」要求として設定する必要があります。

その他の考慮事項:

以下の図では、管理者が Web サービス コネクタを設定する方法について説明しています。

CA Executive Insight と Web サービス コネクタの統合

Web サービス コネクタを設定するには、以下の手順に従います。

  1. コネクタの Web サービス要求を設定します
  2. Web サービス出力の応答処理を設定します
  3. ビジネス インジケータのメトリックを選択します

コネクタの Web サービス要求の設定

CA Executive Insight は、ユーザが RESTful Web サービスを介してメトリックを取得することを可能にします。 これをするには、任意の認証情報を含めて、Web サービスに関連する情報をまず指定する必要があります。

注: ひとつのコネクタには複数の要求を含めることができますが、それが可能となるのは、要求間に相互依存関係がある場合のみです。 1 つの要求が実行に失敗した場合、コネクタは「障害」状態になり、すべての要求が正常に実行されるまでは他の要求の実行ができません。

  1. 管理 UI にログインします
  2. [管理]タブの[メトリック コネクタ]をクリックします。

    [メトリック コネクタ]ページが表示されます。

  3. [新規追加]をクリックし、ドロップダウン リストから[Web コネクタ]を選択します。

    新規の[ユニバーサル Web サービス コネクタ]ページが表示されます。

  4. 情報セクションでは、必要なコネクタ情報を入力します。
    名前

    コネクタの名前を定義します。

    制限: 225 文字以下

    注: コネクタ名は内部的に使用されるもので、Web サービスのいずれの値とも一致している必要はありません。

    説明

    (オプション)コネクタの説明を定義します。

    制限: 512 文字以下

  5. [プロパティ]タブに、メトリックを収集する Web サービス要求で必要な情報を入力します。
    要求名

    要求名を定義します。 要求が保存されれば、この名前が[アクティブな要求]ドロップダウンに表示されます。

    メソッド

    要求に使用される HTTP メソッドを指定します。 GET または POST メソッドのいずれかが使用可能です。

    URL

    要求している Web サービスに使用される URL を指定します。

    パラメータ

    (オプション)要求に必要で、URL に追加される HTTP パラメータを定義します。 パラメータは、キーおよび値のペアとして追加されます。

    POST メソッドが選択されている場合:

    Raw ボディ

    (オプション) POST 要求で必要となる要求メッセージのボディ パラメータ、および application/x-www-form-urlencoded メディア タイプ(コンテンツ)を定義します。

    ペイロード

    (オプション) キーおよび値のペアとして追加できる、POST 要求のボディ パラメータを定義します。 Raw ボディ パラメータはペイロードより優先されます。

    認証

    要求で使用される認証方式のタイプを定義します。

    デフォルト: [なし]に設定されています。

    コンテンツ

    (オプション)要求にとって受け入れ可能なコンテンツ タイプ。

    ヘッダ

    (オプション)要求に使用される HTTP ヘッダを定義します。 ヘッダは、キーおよび値のペアとして追加されます。

    HTTP プロキシ

    要求に対して HTTP プロキシ を使用するべきかどうかを指定します。

    デフォルト: HTTP プロキシを使用しないと設定

  6. [テスト]ボタンをクリックします。

    Web サービス接続がテストされ、応答が要求のステータスとともに表示されます。

  7. 応答のテキスト セクションでは要求の結果を表示します。 以下のいずれかの方法で応答を確認できます。

Web サービス出力の応答処理の設定

要求設定が完了しテストが成功したら、応答処理設定を作成します。 これは、Web サービス応答本文からメトリックおよびその値を取得するために、Web サービス コネクタによって使用されます。 応答の[ボディ]オプション ボタンと併せて[テスト]ボタンを使用すると、処理する必要がある項目を特定するのに役立ちます。

応答処理フィールドには、応答のモデルを作成するために Web サービス コネクタが使用する XPath または JSONPath 解析命令が含まれる必要があります。

次の手順に従ってください:

  1. [処理]タブで、メトリックへのWeb サービス出力を処理するために必要な情報を入力します。
    タイプ

    応答のタイプを定義します。

    オプション: メトリックまたはメタデータ

    パーサ

    応答本文に使用されるパーサを定義します。

    デフォルト:自動

    メトリック名

    呼び出し間でメトリックを識別するために一意の名前を指定します。

    例: XPath 式: //field[@[name='name']

    例: 定数値: {CAStock}

    例: 複数の式および定数値。3 つのメトリック名が選択されます: //resource{2}/field{@name='name'];{CAStock};//resource[25}/field[@name='name']

    メトリック値

    メトリックの値を指定します。

    : //field[@name='price'] //LastPrice

    メトリック タイムスタンプ

    メトリック値のタイム スタンプを指定します。

    : //field[@name='ts'] //Timestamp

    日付/時間形式

    メトリック タイムスタンプの解析に使用される format 文字列を指定します。

    オプション: ミリ秒、秒、分、時間、日または Java SimpleDateFormat の文字列

    例: //field[@name='ts'] //Timestamp

    例: yyyy-MM-dd'T'HH:mm:ss'Z'

  2. [保存]をクリックします。

    新しい Web サービス メトリック コネクタが作成され、コネクタ メトリック フォームが表示されます。

  3. ビジネス インジケータのメトリックの選択

応答モデル 1

この応答モデルには、メトリック名、メトリック値およびメトリック タイム スタンプとして使用可能なフィールドが含まれます。 メトリック名は一意である必要があり、データベースのプライマリ キー同様に、指定のコネクタに対するすべての要求についてメトリックを一意に識別するために使用されます。

応答:

<StockQuote>
  <Symbol>CA</Symbol>
  <LastPrice>31.98</LastPrice>
  <Timestamp>Wed Dec 18 12:47:46 GMT-05:00 2013</Timestamp>
</StockQuote>

このようなモデルの XPath 処理命令は以下のとおりです。

メトリック名: //Symbol

メトリック値: //LastPrice

メトリック タイムスタンプ: //timestamp

日付/時間形式の文字列は次のとおりです。

EEE MMM d HH:mm:s z yyy

この設定では 1 つのメトリックが作成されます。

応答モデル バリエーション

以下のサブケースでは、利用可能な情報に応じて、さまざまな Web サービス応答モデルのバリエーションを示します。

応答モデル バリエーション タイプ A - タイムスタンプなし

応答にはメトリック タイムスタンプが含まれないか、メトリック タイムスタンプはシンプル フォーマットの式を使用して解析できないか、または事前定義済みの定数の 1 つに一致せず、空白にする必要があります。 タイムスタンプの式や形式を指定しない場合、対応するビジネス インジケータ データのタイムスタンプとしてポーリング要求時間が使用されます。

応答:

 <StockQuote>
   <Symbol>CA</Symbol>
   <LastPrice>31.98</LastPrice>
</StockQuote>

上記の応答例の場合、このようなモデルでの XPATH 処理命令は以下のようになります。

メトリック名: //Symbol

メトリック値: //LastPrice

モデル バリエーション タイプ B - メトリック名なし

応答には、メトリック名として使用可能なフィールドが含まれません。 この場合、解析式の代わりに中括弧 {} でテキスト値を囲んでメトリック名を入力します。

応答:

<StockQuote>
   <LastPrice>31.98</LastPrice>
   <Timestamp>Wed Dec 18 12:47:46 GMT-05:00 2013</Timestamp>
</StockQuote>

上記の応答例の場合、このようなモデルでの XPATH 処理命令は以下のようになります。

メトリック名: {My Metric Name}

メトリック値: //LastPrice

メトリック タイムスタンプ: //timestamp

日付/時間形式の文字列は次のとおりです。

EEE MMM d HH:mm:ss z yyy

モデル バリエーション タイプ C - メトリック名およびタイムスタンプなし

応答には、メトリック名およびメトリック タイムスタンプとして使用可能なフィールドが含まれません。

応答:

<StockQuote>
   <LastPrice>31.98</LastPrice>
</StockQuote>

上記の応答例の場合、このようなモデルでの XPATH 処理命令は以下のようになります。

メトリック名: {My Metric Name}

メトリック値: //LastPrice

応答モデル 2

この応答モデルには、メトリック名、メトリック値、メトリック タイム スタンプとして使用できるルート要素の内部に複数の子要素が含まれます。 メトリック名は一意である必要があり、データベースのプライマリ キー同様に、このメトリックを一意に識別するために使用されます。

応答:

<weather>
  <humidity>50</humidity>
  <temperature>98</temperature>
  <date>Wed, 18 Dec 2013 13:52 EST</date>
<weather>

上記の応答例の場合、このようなモデルでの XPATH 処理命令は以下のようになります。

メトリック名: //{Temperature};{Humidity}

メトリック値: //temperature;//humidity

メトリック タイムスタンプ: //date;//date

日付/時間形式の文字列は次のとおりです。

EEE, d MMM yyy HH:mm a z

この設定では、湿度および温度用に 2 つのメトリックが作成されます。 両方のメトリックで、単一の日付値も使用されます。

応答モデル 3

この応答モデルには、各レコードのフィールドがメトリック名、メトリック値、メトリック タイムスタンプとして使用可能なレコードのリストが含まれます。 メトリック名は一意である必要があり、データベースのプライマリ キー同様に、このメトリックを一意に識別するために使用されます。

応答:

<resource classname="Quote">
        <field name="name">USD/ARS</field>
        <field name="price">6.375500</field>
        <field name="ts">1387395903</field>
</resource>
<resource classname="Quote">
        <field name="name">USD/ARS</field>
        <field name="price">1052.199951</field>
        <field name="ts">1387395903</field>
</resource>

上記の応答例の場合、このようなモデルでの XPATH 処理命令は以下のようになります。

メトリック名: //field[@name='name']

メトリック値: //field[@name='price']

メトリック タイムスタンプ: //field[@name=’ts’]

日付/時間形式の文字列は次のとおりです。

この設定では、各 Quote のメトリック リストが作成されます。

応答モデル 4

この応答例には 1 つのメトリック名と、タイム スタンプを含むメトリック値のリストが含まれます。 この場合、CA Executive Insight は、単一のポーリング要求で特定のメトリックに対するメトリック値のリストを取得します。

応答:

<collection>
   <name>Brand Name</name>
   <record>
        <sentiment>0.4567</sentiment>
        <timestamp>20131218</timestamp>
   </record>
   <record>
        <sentiment>0.4893</sentiment> 
       <timestamp>20131219</timstamp>
   </record>
</collection>

上記の応答例の場合、このようなモデルでの XPATH 処理命令は以下のようになります。

メトリック名: //metric name

メトリック値: //sentiment

メトリック タイムスタンプ: //timestamp

日付/時間形式の文字列は次のとおりです。

yyyMMdd

この設定では、値のリストを含む単一のメトリックが作成されます。 メトリック名を使用できない場合は、中括弧 {} のメトリック名を使用することを検討してください。