本文へスキップ

イベントストリーム

!!!お知らせ

Equinix Metal Observabilityの機能は現在ベータ版であり、すべてのお客様にご利用いただけるわけではありません。これは評価およびテストのみを目的としています。この機能は現在非課金であり、SLAの対象ではありません。

イベントストリームを使用して、メタル組織の特定のイベントおよびアクティビティデータをほぼリアルタイムで監視できます。イベント ストリームは、ビジネス ニーズの把握と分析に役立つ重要なイベント データを提供します。これらのイベントには以下が含まれます：

  • アカウントと組織のイベント
  • サービスと請求イベント
  • デバイス管理イベント
  • ネットワーク・マネジメント・イベント

イベントストリームは、組織のオーナーと管理者のみが見ることができます。

制限事項​

現在、イベントストリームは送信先として Splunk のみをサポートしています。可視性ストリームのデータは、[Splunk HTTP Event Collector ("HEC") インターフェースを通じて Splunk に送信されます。Observability Stream データを受信するには、まず Splunk インスタンスに HTTP Event Collector を設定する必要があります。可視性ストリームデータの受信専用のコレクタを作成することをお勧めします。

Observability StreamデータをSplunkに送信するには、以下の制限があります：

  • 転送中のデータを確実に暗号化するため、HTTPS 接続のみが許可されます。暗号化されていないプレーンな HTTP を使用して Splunk HEC にデータを送信することはサポートされていません。
  • すべての Observability Stream データは、JSON イベントとして Splunk に送信されます。
  • JSON イベントは標準 /services/collector/event エンドポイントに送信されます。別のエンドポイント URL はサポートされていません。
  • JSON イベントは、Splunk HTTP Event Collector の作成時に設定されたデフォルトのインデックスに送信されます。Splunk に送信されるイベントのインデックスを上書きすることはサポートされていません。
  • インデクサの確認はサポートされていない。

オブザーバビリティAPI​

可視性APIを利用する場合、現在のEquinix Metal APIとの違いに注意してください。

  • 新しいAPIエンドポイント
  • 新しい認証メカニズム

まず、可視性はhttps://observability.equinixmetal.netで到達できる独自のAPIエンドポイントを持っています。

次に、可視性APIには認証メカニズムがあり、お客様はEquinix Metal APIキーと短命のJSONウェブトークン（JWT）を交換し、すべての可視性リクエストの認証に使用します。トークンの有効期限は5分です。JWTを取得するには、iam.metalctrl.io/api-keys/exchangeエンドポイントにPOSTリクエストを送信します。

curl -X POST \
-H "Authorization: bearer <API_TOKEN>" \
https://iam.metalctrl.io/api-keys/exchange

応答は、可視性APIへのリクエストを認証するために使用するJSON "access_token"になります。

{
"access_token": "eyJ....98"
}

Observability APIは、認証のためにエクイニクスメタルAPIキーを受け付けません。

イベント・ストリームの作成​

イベントストリームを作成し、サーバデータを Splunk にエクスポートして保存・分析する。ストリームを作成するには、以下のようにします：

  1. Equinix Metal Portal にアクセスし、認証情報を入力してポータルにサインインします。

  2. Organization's_］ドロップダウンメニューから、イベントストリームを作成する組織を選択します。

  3. Observability_タブをクリックします。

    Event Streams page from the Observability tab

  4. イベントストリームの作成 をクリックします。

  5. イベントストリームの作成］モーダルで、［名前］フィールドにユーザーフレンドリーな名前を入力します。

  6. オプション説明フィールドにイベントストリームの説明を入力します。

  7. Splunk ホスト名と API キーをプロバイダのフィールドに入力して、Splunk にデータを送信します。

    接続ホスト名は、[HTTP イベントコレクタ URI から取得する必要があります。ホスト名は、オプションのポート番号サフィックスを持つ文字列として指定する必要があります。

    API Key は、Splunk HEC エンドポイントの作成時に生成された HTTP Event Collector トークンでなければなりません。これは暗号化された形式で保存され、Observability Stream データを送信するワーカーによってのみ復号化されます。

ストリーム接続のテスト​

データ接続を Splunk にストリーム接続する前に、その有効性を確認するためにテストする必要があります。ストリーム接続をテストするには、以下のようにします：

  1. イベントストリームの作成」モーダルで、Splunk のホスト名と API キーを入力します。

  2. クリック、テストストリーム接続.

    画面にTest Passed というメッセージが表示されれば、接続は有効です。テスト接続に合格しなかった場合は、エラーメッセージが表示されます。テスト接続が Splunk にデータをストリーミングするために有効であることを確認するには、Test Passed メッセージを受信する必要があります。

    Testing an event stream in the console

  3. 保存 をクリックして、イベントストリームを保存します。 イベント・ストリームは、可視性ページのイベント・ストリーム・テーブルに保存されます。

イベントストリームの管理​

Metalコンソールでイベントストリームが作成されると、組織の_Observability_タブからイベントストリームを管理できます。

Event Streams Table

イベントストリームの削除​

Splunk インスタンスへのデータストリームを停止するには、イベントストリームを削除する。イベントストリームを削除するには、以下のようにします：

  1. Event Streamsテーブルで、_Delete_列のゴミ箱アイコンをクリックします。 イベントストリームの削除］ウィンドウが表示されます。

  2. フィールドにDelete と入力し、Delete をクリックします。

ストリームが削除されると、ソースからの新しいデータの受け入れは直ちに停止されるが、インフライトデータの配信は継続される。飛行中のデータがすべて配信されると、ストリームは削除され、すべてのリソースが解放される。

Splunk イベントメタデータ​

可視性サービスは、ストリームに送信するすべての監査ログイベントに対して、以下の [Splunk Event metadata キーを設定します：

  • time - The timestamp at which the event occurred, specified in seconds since the Unix epoch.
  • source - All events will specify a source of equinix.
  • sourcetype- Audit log events will specify a source type of log.
  • fields - Additional fields for indexing as described below.

インデックス・フィールド​

上記の標準 Splunk メタデータキーに加えて、Observability サービスはストリームに送信する各ログイベントに対して以下のカスタムインデックスフィールドを設定します。これらのフィールドはオプションであり、存在しない場合は省略されます。

  • level - A human-readable indication of the logging level, such as INFO or DEBUG.
  • severity - A numeric severity level; higher numbers indicate more severe events (such as errors or violations).

Splunk イベントデータ​

Splunk HTTP Event Collector に "Event data" として送信される event キーの内容は、ログに記録されるイベントに関するアプリケーション固有の情報を持つ構造化 JSON ドキュメントです。

完全なリファレンスについては、Splunk Event Schema Documentation を参照してください。

{
"stream" : {
    "streamId" : "dce13c1d-0589-406b-af40-854156a0621e",
    "streamName" : "Example Stream"
},
"source" : {
    "category" : "audit",
    "type" : "api_request",
    "service" : "metal",
    "organizationId" : "99be473c-ee3c-4aeb-a678-eba3fdae7ca6",
    "projectId" : "99be473c-ee3c-4aeb-a678-eba3fdaebeef"

},
"schema" : "v1",
"timestamp" : "2024-04-16T14:58:21.442334Z",
"level" : "INFO",
"eventId" : "6910f03f-ec60-42fc-9e9d-c5f6af2f732d",
"event" : {
    "eventName" : "instance_provision_requested",
    "status" : "failed",
    "auth" : {
        "authType" : "user",
        "user" : {
            "userId" : "582865f9-904b-4061-b536-2420eb01ecdc",
            "userName" : "jdoe@equinix.com"
        },
        "role" : {
            "roleName" : "collaborator"
        }
    },
    "httpRequest" : {
        "host" : "api.equinix.com",
        "method" : "PUT",
        "path" : "/metal/v1/projects/99f8e7f1-fe4a-441a-ade9-687743f080f6",
        "scheme" : "http",
        "statusCode" : 200,
        "userAgent" : "metal-cli/metal equinix-sdk-go/0.30.0",
        "sourceIpAddress" : "111.111.111.11"
    }
}
}
このページは役に立ちましたか？