Azure イベント ハブの診断ログを設定するSet up diagnostic logs for an Azure event hub

Azure Event Hubs の 2 種類のログを表示できます。You can view two types of logs for Azure Event Hubs:

  • アクティビティ ログ : これらのログには、ジョブで実行された操作に関する情報が含まれます。Activity logs: These logs have information about operations done on a job. このログは常に有効になっています。The logs are always enabled. アクティビティ ログ エントリを確認するには、Azure portal のイベント ハブ名前空間の左側のウィンドウで [アクティビティ ログ] を選択します。You can see activity log entries by selecting Activity log in the left pane for your event hub namespace in the Azure portal. 次に例を示します。"名前空間の作成または更新"、"イベント ハブの作成または更新"。For example: "Create or Update Namespace", "Create or Update Event Hub".

    Event Hubs 名前空間のアクティビティ ログ

  • 診断ログ : 診断ログでは、API を使用して、または言語 SDK 上の管理クライアントを使用して、名前空間に対して実行された操作とアクションに関する詳細な情報が提供されます。Diagnostic logs: Diagnostic logs provide richer information about operations and actions that are conducted against your namespace by using the API, or through management clients on the language SDK.

    次のセクションでは、Event Hubs 名前空間の診断ログを有効にする方法について説明します。The following section shows you how to enable diagnostic logs for an Event Hubs namespace.

Traffic Manager で診断ログを有効にするEnable diagnostic logs

既定では、診断ログは無効になっています。Diagnostic logs are disabled by default. 診断ログを有効にするには、次の手順を実行します。To enable diagnostic logs, follow these steps:

  1. Azure portal で Event Hubs 名前空間に移動します。In the Azure portal, navigate to your Event Hubs namespace.

  2. 左側のウィンドウで [監視] の下にある [診断設定] を選択してから、 [+ 診断設定の追加] を選択します。Select Diagnostics settings under Monitoring in the left pane, and then select + Add diagnostic setting.

    [診断設定] ページ - 診断設定の追加

  3. [Category details] (カテゴリの詳細) セクションで、有効にする診断ログの種類を選択します。In the Category details section, select the types of diagnostic logs that you want to enable. これらのカテゴリの詳細については、この記事の後半で説明します。You'll find details about these categories later in this article.

  4. [Destination details] (送信先の詳細) セクションで、アーカイブ ターゲット (送信先) を設定します (例: ストレージ アカウント、イベント ハブ、Log Analytics ワークスペース)。In the Destination details section, set the archive target (destination) that you want; for example, a storage account, an event hub, or a Log Analytics workspace.

    診断設定の追加ページ

  5. ツール バーの [保存] を選択して診断設定を保存します。Select Save on the toolbar to save the diagnostics settings.

    新しい設定は、10 分ほどで有効になります。New settings take effect in about 10 minutes. その後、構成されたアーカイブ ターゲットのログが [診断ログ] ウィンドウに表示されます。After that, logs appear in the configured archival target, in the Diagnostics logs pane.

    診断の構成の詳細については、Azure 診断ログの概要に関するページを参照してください。For more information about configuring diagnostics, see the overview of Azure diagnostic logs.

診断ログのカテゴリDiagnostic logs categories

Event Hubs では、次のカテゴリの診断ログをキャプチャします。Event Hubs captures diagnostic logs for the following categories:

カテゴリCategory 説明Description
アーカイブ ログArchive Logs Event Hubs Capture 操作、特にログ関連のキャプチャ エラーに関する情報をキャプチャします。Captures information about Event Hubs Capture operations, specifically, logs related to capture errors.
操作ログOperational Logs Azure Event Hubs 名前空間上で実行されるすべての管理操作がキャプチャされます。Capture all management operations that are performed on the Azure Event Hubs namespace. Azure Event Hubs 上では大量のデータ操作が実行されるため、データ操作はキャプチャされません。Data operations are not captured, because of the high volume of data operations that are conducted on Azure Event Hubs.
自動スケール ログAuto scale logs Event Hubs 名前空間で実行される自動拡張操作をキャプチャします。Captures auto-inflate operations done on an Event Hubs namespace.
Kafka コーディネーター ログKafka coordinator logs Event Hubs に関連する Kafka コーディネーター操作をキャプチャします。Captures Kafka coordinator operations related to Event Hubs.
Kafka ユーザー エラー ログKafka user error logs Event Hubs で呼び出される Kafka API に関する情報をキャプチャします。Captures information about Kafka APIs called on Event Hubs.
Event Hubs 仮想ネットワーク (VNet) 接続イベントEvent Hubs virtual network (VNet) connection event Event Hubs にトラフィックを送信する IP アドレスと仮想ネットワークに関する情報をキャプチャします。Captures information about IP addresses and virtual networks sending traffic to Event Hubs.
カスタマー マネージド キーのユーザー ログCustomer-managed key user logs カスタマー マネージド キーに関連する操作をキャプチャします。Captures operations related to customer-managed key.

すべてのログは、JavaScript Object Notation (JSON) 形式で格納されます。All logs are stored in JavaScript Object Notation (JSON) format. 各エントリには、以下のセクションで説明している形式を使用する文字列フィールドがあります。Each entry has string fields that use the format described in the following sections.

アーカイブ ログ スキーマArchive logs schema

アーカイブ ログの JSON 文字列には、次の表に示す要素が含まれます。Archive log JSON strings include elements listed in the following table:

名前Name 説明Description
TaskNameTaskName 失敗したタスクの説明Description of the task that failed
ActivityIdActivityId 内部 ID。追跡目的で使用されますInternal ID, used for tracking
trackingIdtrackingId 内部 ID。追跡目的で使用されますInternal ID, used for tracking
resourceIdresourceId Azure Resource Manager リソース IDAzure Resource Manager resource ID
eventHubeventHub イベント ハブの完全名 (名前空間の名前を含みます)Event hub full name (includes namespace name)
partitionIdpartitionId 書き込み先のイベント ハブ パーティションEvent Hub partition being written to
archiveSteparchiveStep 使用可能な値:ArchiveFlushWriter、DestinationInitpossible values: ArchiveFlushWriter, DestinationInit
startTimestartTime 障害開始時刻Failure start time
failuresfailures 障害が発生した回数Number of times the failure occurred
durationInSecondsdurationInSeconds 障害の時間Duration of failure
messagemessage エラー メッセージError message
categorycategory ArchiveLogsArchiveLogs

次のコードは、アーカイブ ログの JSON 文字列の例です。The following code is an example of an archive log JSON string:

{
   "TaskName": "EventHubArchiveUserError",
   "ActivityId": "000000000-0000-0000-0000-0000000000000",
   "trackingId": "0000000-0000-0000-0000-00000000000000000",
   "resourceId": "/SUBSCRIPTIONS/000000000-0000-0000-0000-0000000000000/RESOURCEGROUPS/<Resource Group Name>/PROVIDERS/MICROSOFT.EVENTHUB/NAMESPACES/<Event Hubs Namespace Name>",
   "eventHub": "<Event Hub full name>",
   "partitionId": "1",
   "archiveStep": "ArchiveFlushWriter",
   "startTime": "9/22/2016 5:11:21 AM",
   "failures": 3,
   "durationInSeconds": 360,
   "message": "Microsoft.WindowsAzure.Storage.StorageException: The remote server returned an error: (404) Not Found. ---> System.Net.WebException: The remote server returned an error: (404) Not Found.\r\n   at Microsoft.WindowsAzure.Storage.Shared.Protocol.HttpResponseParsers.ProcessExpectedStatusCodeNoException[T](HttpStatusCode expectedStatusCode, HttpStatusCode actualStatusCode, T retVal, StorageCommandBase`1 cmd, Exception ex)\r\n   at Microsoft.WindowsAzure.Storage.Blob.CloudBlockBlob.<PutBlockImpl>b__3e(RESTCommand`1 cmd, HttpWebResponse resp, Exception ex, OperationContext ctx)\r\n   at Microsoft.WindowsAzure.Storage.Core.Executor.Executor.EndGetResponse[T](IAsyncResult getResponseResult)\r\n   --- End of inner exception stack trace ---\r\n   at Microsoft.WindowsAzure.Storage.Core.Util.StorageAsyncResult`1.End()\r\n   at Microsoft.WindowsAzure.Storage.Core.Util.AsyncExtensions.<>c__DisplayClass4.<CreateCallbackVoid>b__3(IAsyncResult ar)\r\n--- End of stack trace from previous location where exception was thrown ---\r\n   at System.",
   "category": "ArchiveLogs"
}

操作ログのスキーマOperational logs schema

操作ログの JSON 文字列には、次の表に示す要素が含まれます。Operational log JSON strings include elements listed in the following table:

名前Name 説明Description
ActivityIdActivityId 内部 ID。追跡目的で使用されますInternal ID, used for tracking purposes
EventNameEventName 操作の名前Operation name
resourceIdresourceId Azure Resource Manager リソース IDAzure Resource Manager resource ID
SubscriptionIdSubscriptionId サブスクリプション IDSubscription ID
EventTimeStringEventTimeString 操作時間Operation time
EventPropertiesEventProperties 操作プロパティOperation properties
StatusStatus 操作の状態Operation status
CallerCaller 操作の呼び出し元 (Azure Portal または管理クライアント)Caller of operation (Azure portal or management client)
カテゴリCategory OperationalLogsOperationalLogs

次のコードは、操作ログの JSON 文字列の例です。The following code is an example of an operational log JSON string:

Example:
{
   "ActivityId": "00000000-0000-0000-0000-00000000000000",
   "EventName": "Create EventHub",
   "resourceId": "/SUBSCRIPTIONS/00000000-0000-0000-0000-0000000000000/RESOURCEGROUPS/<Resource Group Name>/PROVIDERS/MICROSOFT.EVENTHUB/NAMESPACES/<Event Hubs namespace name>",
   "SubscriptionId": "000000000-0000-0000-0000-000000000000",
   "EventTimeString": "9/28/2016 8:40:06 PM +00:00",
   "EventProperties": "{\"SubscriptionId\":\"0000000000-0000-0000-0000-000000000000\",\"Namespace\":\"<Namespace Name>\",\"Via\":\"https://<Namespace Name>.servicebus.windows.net/f8096791adb448579ee83d30e006a13e/?api-version=2016-07\",\"TrackingId\":\"5ee74c9e-72b5-4e98-97c4-08a62e56e221_G1\"}",
   "Status": "Succeeded",
   "Caller": "ServiceBus Client",
   "category": "OperationalLogs"
}

自動スケール ログのスキーマAutoscale logs schema

自動スケール ログの JSON には、次の表に示す要素が含まれます。Autoscale log JSON includes elements listed in the following table:

名前Name 説明Description
TrackingIdTrackingId 内部 ID。トレース目的で使用されますInternal ID, which is used for tracing purposes
ResourceIdResourceId Azure Resource Manager リソース ID。Azure Resource Manager resource ID.
MessageMessage 情報メッセージ。自動インフレ アクションに関する詳細情報を提供します。Informational message, which provides details about auto-inflate action. このメッセージには、特定の名前空間のスループット ユニットの以前の値と現在の値、および TU のインフレをもたらした要因が含まれます。The message contains previous and current value of throughput unit for a given namespace and what triggered the inflate of the TU.

自動スケーリング イベントの例を次に示します。Here's an example autoscale event:

{
    "TrackingId": "fb1b3676-bb2d-4b17-85b7-be1c7aa1967e",
    "Message": "Scaled-up EventHub TUs (UpdateStartTimeUTC: 5/13/2020 7:48:36 AM, PreviousValue: 1, UpdatedThroughputUnitValue: 2, AutoScaleReason: 'IncomingMessagesPerSecond reached 2170')",
    "ResourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/microsoft.eventhub/namespaces/namespace-name"
}

Kafka コーディネーター ログのスキーマKafka coordinator logs schema

Kafka コーディネーター ログの JSON には、次の表に示す要素が含まれます。Kafka coordinator log JSON includes elements listed in the following table:

名前Name 説明Description
RequestIdRequestId 要求 ID。トレース目的で使用されますRequest ID, which is used for tracing purposes
ResourceIdResourceId Azure Resource Manager リソース IDAzure Resource Manager resource ID
操作Operation グループの調整中に実行された操作の名前Name of the operation that's done during the group coordination
ClientIdClientId クライアント IDClient ID
NamespaceNameNamespaceName 名前空間名Namespace name
SubscriptionIdSubscriptionId Azure サブスクリプション IDAzure subscription ID
MessageMessage 情報または警告メッセージ。グループの調整中に実行されたアクションに関する詳細情報を提供します。Informational or warning message, which provides details about actions done during the group coordination.

Example

{
    "RequestId": "FE01001A89E30B020000000304620E2A_KafkaExampleConsumer#0",
    "Operation": "Join.Start",
    "ClientId": "KafkaExampleConsumer#0",
    "Message": "Start join group for new member namespace-name:c:$default:I:KafkaExampleConsumer#0-cc40856f7f3c4607915a571efe994e82, current group size: 0, API version: 2, session timeout: 10000ms, rebalance timeout: 300000ms.",
    "SubscriptionId": "0000000-0000-0000-0000-000000000000",
    "NamespaceName": "namespace-name",
    "ResourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/microsoft.eventhub/namespaces/namespace-name",
    "Category": "KafkaCoordinatorLogs"
}

Kafka ユーザー エラー ログのスキーマKafka user error logs schema

Kafka ユーザー エラー ログの JSON には、次の表に示す要素が含まれます。Kafka user error log JSON includes elements listed in the following table:

名前Name 説明Description
TrackingIdTrackingId 追跡 ID。トレース目的で使用されます。Tracking ID, which is used for tracing purposes.
NamespaceNameNamespaceName 名前空間名Namespace name
EventhubEventhub イベント ハブ名Event hub name
PartitionIdPartitionId Partition IDPartition ID
GroupIdGroupId グループ IDGroup ID
ClientIdClientId クライアント IDClient ID
ResourceIdResourceId Azure Resource Manager リソース ID。Azure Resource Manager resource ID.
MessageMessage 情報メッセージ。エラーに関する詳細情報を提供しますInformational message, which provides details about an error

Event Hubs 仮想ネットワーク接続イベントのスキーマEvent Hubs virtual network connection event schema

Event Hubs 仮想ネットワーク (VNet) 接続イベントの JSON には、次の表に示す要素が含まれます。Event Hubs virtual network (VNet) connection event JSON includes elements listed in the following table:

名前Name 説明Description
SubscriptionIdSubscriptionId Azure サブスクリプション IDAzure subscription ID
NamespaceNameNamespaceName 名前空間名Namespace name
IPAddressIPAddress Event Hubs サービスに接続しているクライアントの IP アドレスIP address of a client connecting to the Event Hubs service
アクションAction 接続要求を評価するときに Event Hubs サービスによって実行されたアクション。Action done by the Event Hubs service when evaluating connection requests. サポートされているアクションは、接続の受け入れ接続の拒否です。Supported actions are Accept Connection and Deny Connection.
理由Reason アクションが実行された理由を提供しますProvides a reason why the action was done
CountCount 指定されたアクションの発生回数Number of occurrences for the given action
ResourceIdResourceId Azure Resource Manager リソース ID。Azure Resource Manager resource ID.

Example

{
    "SubscriptionId": "0000000-0000-0000-0000-000000000000",
    "NamespaceName": "namespace-name",
    "IPAddress": "1.2.3.4",
    "Action": "Deny Connection",
    "Reason": "IPAddress doesn't belong to a subnet with Service Endpoint enabled.",
    "Count": "65",
    "ResourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/microsoft.eventhub/namespaces/namespace-name",
    "Category": "EventHubVNetConnectionEvent"
}

カスタマー マネージド キーのユーザー ログCustomer-managed key user logs

カスタマー マネージド キーのユーザー ログの JSON には、次の表に示す要素が含まれます。Customer-managed key user log JSON includes elements listed in the following table:

名前Name 説明Description
カテゴリCategory メッセージのカテゴリの種類。Type of category for a message. errorinfo のどちらかの値ですIt's one of the following values: error and info
ResourceIdResourceId 内部リソース ID。Azure サブスクリプション ID と名前空間名が含まれますInternal resource ID, which includes Azure subscription ID and namespace name
KeyVaultKeyVault Key Vault リソースの名前Name of the Key Vault resource
KeyKey Key Vault キーの名前。Name of the Key Vault key.
VersionVersion Key Vault キーのバージョンVersion of the Key Vault key
操作Operation 要求を処理するために実行された操作の名前The name of an operation done to serve requests
コードCode status codeStatus code
MessageMessage メッセージ。エラーまたは情報メッセージに関する詳細情報を提供しますMessage, which provides details about an error or informational message

次のステップNext steps