Splunk Event Schema ドキュメント

LogEntry

タイトル ログエントリ


Type	`object`
Required	No
Additional properties	[Any type: allowed]

説明 Equinix Observability Serviceの顧客向けログフォーマットです。

例

{
    "stream": {
        "streamId": "b47f2eaf-d5c6-485c-a081-5d12333aa2e2",
        "streamName": "Example Stream"
    },
    "source": {
        "category": "validation",
        "type": "validation_request",
        "service": "metal",
        "organizationId": "a2337a57-4ad0-4708-abc6-c0973055c91e"
    },
    "schema": "v1",
    "timestamp": "2024-04-16T14:58:21.442334Z",
    "level": "INFO",
    "eventId": "e6de0ec4-027e-4733-aeb4-058c1fc53493",
    "event": {
        "eventName": "instance_provision_requested",
        "status": "unauthorized",
        "auth": {
            "authType": "user",
            "user": {
                "userId": "1bec4119-a889-4809-89e9-c4572dc002ec",
                "userName": "jdoe@equinix.com"
            },
            "role": {
                "roleName": "collaborator"
            }
        },
        "httpRequest": {
            "host": "api.equinix.com",
            "method": "PUT",
            "path": "/metal/v1/projects/99f8e7f1-fe4a-441a-ade9-687743f080f6",
            "scheme": "https",
            "statusCode": 200,
            "userAgent": "metal-cli/metal equinix-sdk-go/0.30.0",
            "sourceIpAddress": "111.111.111.11"
        },
        "response": {}
    }
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ stream	No	object	No	-	Stream
+ source	No	object	No	-	Source
+ schema	No	enum (of string)	No	-	Indicates the schema version of this log entry.
+ timestamp	No	string	No	-	The timestamp at which this log entry was produced, in ISO8601 format.
+ level	No	string	No	-	A human-readable indication of the severity level of this log entry.
+ eventId	No	string	No	-	Unique identifier for this log event.
+ event	No	object	No	-	Event

1.プロパティ `LogEntry > stream`

タイトル ストリーム


Type	`object`
Required	Yes
Additional properties	[Any type: allowed]

説明このログエントリを生成した可視性ストリームに関するメタデータを提供します。複数のストリームが同じ宛先に書き込まれている状況で、データソースを区別するために使用できます。

例

{
    "streamId": "e55f79d4-0d8a-4460-a566-ff93af4f90e4",
    "streamName": "Example Stream"
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ streamId	No	string	No	-	Unique identifier of the observability stream that produced this log entry.
+ streamName	No	string	No	-	Name of the observability stream that produced this log entry.

1.1.プロパティ `LogEntry > stream > streamId` {#stream_streamId}.


Type	`string`
Required	Yes
Format	`uuid`

説明このログエントリを生成した可視性ストリームの一意の識別子。

1.2.プロパティ `LogEntry > stream > streamName` {#stream_streamName}.


Type	`string`
Required	Yes

説明このログエントリを生成した可視性ストリームの名前。

例

"Example Stream"

2.プロパティ `LogEntry > source`

タイトル ソース


Type	`object`
Required	Yes
Additional properties	[Any type: allowed]

説明このログエントリの発信元に関するメタデータを提供します。

例

{
    "category": "audit",
    "type": "api_request",
    "service": "metal",
    "organizationId": "0e714017-6d9c-4dc5-828d-b8a156502496"
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ category	No	enum (of string)	No	-	Groups logs into high-level application categories.
+ type	No	enum (of string)	No	-	Differentiates types of log events withing a particular category.
+ service	No	enum (of string)	No	-	Indicates the service that produced this log entry.
+ organizationId	No	string	No	-	Indicates the customer Organization ID with which this log entry is associated.
- projectId	No	string	No	-	Indicates the customer Project ID with which this log entry is associated.

2.1.プロパティ `LogEntry > source > category` {#source_category}.


Type	`enum (of string)`
Required	Yes

説明ログを高レベルのアプリケーションカテゴリーにグループ化します。

のいずれかでなければなりません：

監査
「バリデーション

2.2.プロパティ `LogEntry > source > type` {#source_type}.


Type	`enum (of string)`
Required	Yes

説明特定のカテゴリ内のログイベントのタイプを区別します。

のいずれかでなければなりません：

"api_request"
"validation_request"

2.3.プロパティ `LogEntry > source > service` {#source_service}.


Type	`enum (of string)`
Required	Yes

説明このログエントリを作成したサービスを示します。

のいずれかでなければなりません：

「メタル

2.4.プロパティ `LogEntry > source > organizationId` {#source_organizationId}.


Type	`string`
Required	Yes
Format	`uuid`

説明このログエントリが関連付けられている顧客の組織 ID を示します。

2.5.プロパティ `LogEntry > source > projectId` {#source_projectId}.


Type	`string`
Required	No
Format	`uuid`

説明このログエントリが関連付けられている顧客のプロジェクトIDを示します。

3.プロパティ `LogEntry > schema`


Type	`enum (of string)`
Required	Yes

説明このログエントリのスキーマバージョンを示します。

のいずれかでなければなりません：

"v1"

4.プロパティ `LogEntry > timestamp`


Type	`string`
Required	Yes
Format	`date-time`

説明このログエントリが作成されたタイムスタンプ（ISO8601 形式）。

例

"2024-04-16T14:58:21.442334Z"

5.プロパティ `LogEntry > level`


Type	`string`
Required	Yes

説明このログエントリの重大度レベルを示す、人間が読める表示。

例

"INFO"

6.プロパティ `LogEntry > eventId`


Type	`string`
Required	Yes
Format	`uuid`

説明このログイベントの一意の識別子。

7.プロパティ `LogEntry > event`

タイトル イベント


Type	`object`
Required	Yes
Additional properties	[Any type: allowed]

説明アプリケーション固有のログイベントペイロード。将来、具体的なフォーマットはソースカテゴリとタイプによって異なりますが、今のところ、単一のログイベントスキーマを使用します。

例

{
    "eventName": "project_updated",
    "status": "unauthorized",
    "auth": {
        "authType": "user",
        "user": {
            "userId": "1bec4119-a889-4809-89e9-c4572dc002ec",
            "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"
    },
    "resource": {},
    "response": {}
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ eventName	No	string	No	-	An application-provided name for the event. Event names should be fixed by the application (i.e. should not vary based on request parameters) to enable filtering/querying by the customer, and should carry meaning to the customer. In the case of API request logs, this would correspond to an operation name.
+ status	No	string	No	-	An indication of the status associated with the event, e.g. request success/failure.
+ auth	No	object	No	-	AuthInfo
+ httpRequest	No	object	No	-	HttpRequest
- resource	No	object	No	-	The resource associated with the request (for future use)
- request	No	object	No	-	Detailed request parameters (for future use)
- response	No	object	No	-	Detailed response body (for future use)

7.1.プロパティ `LogEntry > event > eventName` {#event_eventName}.


Type	`string`
Required	Yes

説明アプリケーションによって提供されるイベント名。イベント名は、顧客によるフィルタリング/クエリを可能にするために、アプリケーションによって固定されるべきであり（すなわち、リクエストパラメータに基づいて変化すべきではない）、顧客にとって意味を持つべきです。API リクエストログの場合、これはオペレーション名に相当します。

例

"project_updated"

"instance_provision_requested"

7.2.プロパティ `LogEntry > event > status` {#event_status}.


Type	`string`
Required	Yes

説明リクエストの成功/失敗など、イベントに関連するステータスの表示。

例

"success"

"failed"

"unauthorized"

7.3.プロパティ `LogEntry > event > auth` {#event_auth}.

タイトル AuthInfo


Type	`object`
Required	Yes
Additional properties	[Any type: allowed]

説明説明：ログ・イベントに関連付けられた本人に関する認証および承認情報をプロバイダ。ほとんどの場合、これはリクエストを行った人です。

例

{
    "authType": "user",
    "user": {
        "userId": "1bec4119-a889-4809-89e9-c4572dc002ec",
        "userName": "jdoe@equinix.com"
    },
    "role": {
        "roleName": "collaborator"
    }
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ authType	No	enum (of string)	No	-	Indicates the type of entity for the principal associated with the request.
+ user	No	object	No	-	User
+ role	No	object	No	-	Role

7.3.1.プロパティ `LogEntry > event > auth > authType` {#event_auth_authType}.


Type	`enum (of string)`
Required	Yes

説明リクエストに関連付けられたプリンシパルのエンティティタイプを示します。

のいずれかでなければなりません：

"user"

7.3.2.プロパティ `LogEntry > event > auth > user` {#event_auth_user}.

タイトル ユーザー


Type	`object`
Required	Yes
Additional properties	[Any type: allowed]

説明ログイベントに関連付けられたユーザーに関する識別情報を提供します。

例

{
    "userId": "1bec4119-a889-4809-89e9-c4572dc002ec",
    "userName": "jdoe@equinix.com"
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ userId	No	string	No	-	Unique user identifier; this is an opaque system-assigned ID that is not expected to be recognizable to people.
+ userName	No	string	No	-	Provides a more human-friendly display name for the user.

7.3.2.1.プロパティ `LogEntry > event > auth > user > userId` {#event_auth_user_userId}。


Type	`string`
Required	Yes

説明一意のユーザー識別子。これは不透明なシステム割り当てIDで、人が認識できることは想定されていません。

例

"1bec4119-a889-4809-89e9-c4572dc002ec"

7.3.2.2.プロパティ `LogEntry > event > auth > user > userName` {#event_auth_user_userName}。


Type	`string`
Required	Yes

説明ユーザーにより親しみやすい表示名をプロバイダに提供します。

例

"jdoe@equinix.com"

7.3.3.プロパティ `LogEntry > event > auth > role` {#event_auth_role}.

タイトル 役割


Type	`object`
Required	Yes
Additional properties	[Any type: allowed]

説明説明：ログイベントに関連付けられたロールに関する情報をプロバイダします。プリンシパルが複数のロールにアクセスできる場合、これは、リクエストを行ったときに想定したロールを示します。

例

{
    "roleName": "collaborator"
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ roleName	No	string	No	-	The human-friendly display name for the role.

7.3.3.1.プロパティ `LogEntry > event > auth > role > roleName` {#event_auth_role_roleName}。


Type	`string`
Required	Yes

説明ロールの人間にとって使いやすい表示名。

例

"collaborator"

7.4.プロパティ `LogEntry > event > httpRequest` {#event_httpRequest} {#event_httpRequest

タイトル: HttpRequest


Type	`object`
Required	Yes
Additional properties	[Any type: allowed]

説明ログイベントに関連付けられた HTTP リクエストの詳細をプロバイダに提供します。

例

{
    "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"
}

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ host	No	string	No	-	The hostname to which the original HTTP request was made.
+ method	No	string	No	-	The HTTP request method.
+ path	No	string	No	-	The path portion of the original HTTP request URL.
+ scheme	No	enum (of string)	No	-	The HTTP request scheme
+ statusCode	No	integer	No	-	The HTTP status code that resulted from the processing of the request.
+ userAgent	No	string	No	-	The user-agent that issued the request, as reported by the HTTP client.
+ sourceIpAddress	No	string	No	-	The IP address from which the HTTP request was sent.

7.4.1.プロパティ `LogEntry > event > httpRequest > host` {#event_httpRequest_host} {#event_httpRequest_host} 7.4.1.


Type	`string`
Required	Yes

説明元の HTTP リクエストが送信されたホスト名。

例

"api.equinix.com"

7.4.2.プロパティ `LogEntry > event > httpRequest > method` {#event_httpRequest_method}。


Type	`string`
Required	Yes

説明 HTTP リクエストメソッド。

例

"PUT"

7.4.3.プロパティ `LogEntry > event > httpRequest > path` {#event_httpRequest_path} {#event_httpRequest_path}。


Type	`string`
Required	Yes

説明元の HTTP リクエスト URL のパス部分。

例

"/metal/v1/projects/99f8e7f1-fe4a-441a-ade9-687743f080f6"

7.4.4.プロパティ `LogEntry > event > httpRequest > scheme` {#event_httpRequest_scheme} {#event_httpRequest_scheme}。


Type	`enum (of string)`
Required	Yes

説明 HTTPリクエストスキーム

のいずれかでなければなりません：

"http"
"https"

7.4.5.プロパティ `LogEntry > event > httpRequest > statusCode` {#event_httpRequest_statusCode} {#event_httpRequest_statusCode}。


Type	`integer`
Required	Yes

説明リクエストの処理結果の HTTP ステータスコード。

例

7.4.6.プロパティ `LogEntry > event > httpRequest > userAgent` {#event_httpRequest_userAgent} {#event_httpRequest_userAgent}。


Type	`string`
Required	Yes

説明 HTTP クライアントが報告する、リクエストを発行したユーザーエージェント。

例

"metal-cli/metal equinix-sdk-go/0.30.0"

7.4.7.プロパティ `LogEntry > event > httpRequest > sourceIpAddress` {#event_httpRequest_sourceIpAddress}。


Type	`string`
Required	Yes

説明 HTTP リクエストの送信元 IP アドレス。

例

"111.111.111.11"

7.5.プロパティ `LogEntry > event > resource` {#event_resource}.


Type	`object`
Required	No
Additional properties	[Any type: allowed]

説明リクエストに関連付けられたリソース(将来使用するため)

例

{}

7.6.プロパティ `LogEntry > event > request` {#event_request}。


Type	`object`
Required	No
Additional properties	[Any type: allowed]

説明詳細なリクエストパラメータ（将来使用するため）

例

{}

7.7.プロパティ `LogEntry > event > response` {#event_response}.


Type	`object`
Required	No
Additional properties	[Any type: allowed]

説明詳細な回答本文（将来使用するため）

例

{}

Generated using json-schema-for-humans on2024/07/19 at 16:25:20 -0500

LogEntry​

1.プロパティ LogEntry > stream​

1.1.プロパティ LogEntry > stream > streamId {#stream_streamId}.​

1.2.プロパティ LogEntry > stream > streamName {#stream_streamName}.​

2.プロパティ LogEntry > source​

2.1.プロパティ LogEntry > source > category {#source_category}.​

2.2.プロパティ LogEntry > source > type {#source_type}.​

2.3.プロパティ LogEntry > source > service {#source_service}.​

2.4.プロパティ LogEntry > source > organizationId {#source_organizationId}.​

2.5.プロパティ LogEntry > source > projectId {#source_projectId}.​

3.プロパティ LogEntry > schema​

4.プロパティ LogEntry > timestamp​

5.プロパティ LogEntry > level​

6.プロパティ LogEntry > eventId​

7.プロパティ LogEntry > event​

7.1.プロパティ LogEntry > event > eventName {#event_eventName}.​

7.2.プロパティ LogEntry > event > status {#event_status}.​

7.3.プロパティ LogEntry > event > auth {#event_auth}.​

7.3.1.プロパティ LogEntry > event > auth > authType {#event_auth_authType}.​

7.3.2.プロパティ LogEntry > event > auth > user {#event_auth_user}.​

7.3.2.1.プロパティ LogEntry > event > auth > user > userId {#event_auth_user_userId}。​

7.3.2.2.プロパティ LogEntry > event > auth > user > userName {#event_auth_user_userName}。​

7.3.3.プロパティ LogEntry > event > auth > role {#event_auth_role}.​

7.3.3.1.プロパティ LogEntry > event > auth > role > roleName {#event_auth_role_roleName}。​

7.4.プロパティ LogEntry > event > httpRequest {#event_httpRequest} {#event_httpRequest​

7.4.1.プロパティ LogEntry > event > httpRequest > host {#event_httpRequest_host} {#event_httpRequest_host} 7.4.1.​

7.4.2.プロパティ LogEntry > event > httpRequest > method {#event_httpRequest_method}。​

7.4.3.プロパティ LogEntry > event > httpRequest > path {#event_httpRequest_path} {#event_httpRequest_path}。​

7.4.4.プロパティ LogEntry > event > httpRequest > scheme {#event_httpRequest_scheme} {#event_httpRequest_scheme}。​

7.4.5.プロパティ LogEntry > event > httpRequest > statusCode {#event_httpRequest_statusCode} {#event_httpRequest_statusCode}。​

7.4.6.プロパティ LogEntry > event > httpRequest > userAgent {#event_httpRequest_userAgent} {#event_httpRequest_userAgent}。​

7.4.7.プロパティ LogEntry > event > httpRequest > sourceIpAddress {#event_httpRequest_sourceIpAddress}。​

7.5.プロパティ LogEntry > event > resource {#event_resource}.​

7.6.プロパティ LogEntry > event > request {#event_request}。​

7.7.プロパティ LogEntry > event > response {#event_response}.​

LogEntry

1.プロパティ `LogEntry > stream`

1.1.プロパティ `LogEntry > stream > streamId` {#stream_streamId}.

1.2.プロパティ `LogEntry > stream > streamName` {#stream_streamName}.

2.プロパティ `LogEntry > source`

2.1.プロパティ `LogEntry > source > category` {#source_category}.

2.2.プロパティ `LogEntry > source > type` {#source_type}.

2.3.プロパティ `LogEntry > source > service` {#source_service}.

2.4.プロパティ `LogEntry > source > organizationId` {#source_organizationId}.

2.5.プロパティ `LogEntry > source > projectId` {#source_projectId}.

3.プロパティ `LogEntry > schema`

4.プロパティ `LogEntry > timestamp`

5.プロパティ `LogEntry > level`

6.プロパティ `LogEntry > eventId`

7.プロパティ `LogEntry > event`

7.1.プロパティ `LogEntry > event > eventName` {#event_eventName}.

7.2.プロパティ `LogEntry > event > status` {#event_status}.

7.3.プロパティ `LogEntry > event > auth` {#event_auth}.

7.3.1.プロパティ `LogEntry > event > auth > authType` {#event_auth_authType}.

7.3.2.プロパティ `LogEntry > event > auth > user` {#event_auth_user}.

7.3.2.1.プロパティ `LogEntry > event > auth > user > userId` {#event_auth_user_userId}。

7.3.2.2.プロパティ `LogEntry > event > auth > user > userName` {#event_auth_user_userName}。

7.3.3.プロパティ `LogEntry > event > auth > role` {#event_auth_role}.

7.3.3.1.プロパティ `LogEntry > event > auth > role > roleName` {#event_auth_role_roleName}。

7.4.プロパティ `LogEntry > event > httpRequest` {#event_httpRequest} {#event_httpRequest

7.4.1.プロパティ `LogEntry > event > httpRequest > host` {#event_httpRequest_host} {#event_httpRequest_host} 7.4.1.

7.4.2.プロパティ `LogEntry > event > httpRequest > method` {#event_httpRequest_method}。

7.4.3.プロパティ `LogEntry > event > httpRequest > path` {#event_httpRequest_path} {#event_httpRequest_path}。

7.4.4.プロパティ `LogEntry > event > httpRequest > scheme` {#event_httpRequest_scheme} {#event_httpRequest_scheme}。

7.4.5.プロパティ `LogEntry > event > httpRequest > statusCode` {#event_httpRequest_statusCode} {#event_httpRequest_statusCode}。

7.4.6.プロパティ `LogEntry > event > httpRequest > userAgent` {#event_httpRequest_userAgent} {#event_httpRequest_userAgent}。

7.4.7.プロパティ `LogEntry > event > httpRequest > sourceIpAddress` {#event_httpRequest_sourceIpAddress}。

7.5.プロパティ `LogEntry > event > resource` {#event_resource}.

7.6.プロパティ `LogEntry > event > request` {#event_request}。

7.7.プロパティ `LogEntry > event > response` {#event_response}.