Documentation Splunk Event Schema

LogEntry

Titre : LogEntry


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

Description : Le format de journal orienté client pour le service d'observabilité d'Equinix.

Exemple :

{
    "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. Propriété `LogEntry > stream`

Titre : Flux


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

Description : Fournit des métadonnées sur le flux d'observabilité qui a produit cette entrée de journal ; peut être utilisé pour différencier les sources de données dans les situations où plusieurs flux écrivent vers la même destination.

Exemple :

{
    "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. Propriété `LogEntry > stream > streamId`


Type	`string`
Required	Yes
Format	`uuid`

Description : Identifiant unique du flux d'observabilité qui a produit cette entrée de journal.

1.2. Propriété `LogEntry > stream > streamName`


Type	`string`
Required	Yes

Description : Nom du flux d'observabilité qui a produit cette entrée de journal.

Exemple :

"Example Stream"

2. Propriété `LogEntry > source`

Titre : Source


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

Description : Fournit des métadonnées sur la source d'où provient cette entrée de journal.

Exemple :

{
    "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. Propriété `LogEntry > source > category`


Type	`enum (of string)`
Required	Yes

Description : Regroupe les journaux dans des catégories d'application de haut niveau.

Il doit s'agir de l'un des éléments suivants

"audit"
"validation"

2.2. Propriété `LogEntry > source > type`


Type	`enum (of string)`
Required	Yes

Description : Différencie les types d'événements de journal au sein d'une catégorie particulière.

Il doit s'agir de l'un des éléments suivants

"api_request"
"validation_request"

2.3. Propriété `LogEntry > source > service`


Type	`enum (of string)`
Required	Yes

Description : Indique le service qui a produit cette entrée de journal.

Il doit s'agir de l'un des éléments suivants

"Metal

2.4. Propriété `LogEntry > source > organizationId`


Type	`string`
Required	Yes
Format	`uuid`

Description : Indique l'identifiant de l'organisation cliente à laquelle cette entrée de journal est associée.

2.5. Propriété `LogEntry > source > projectId`


Type	`string`
Required	No
Format	`uuid`

Description : Indique l'identifiant du projet du client auquel cette entrée de journal est associée.

3. Propriété `LogEntry > schema`


Type	`enum (of string)`
Required	Yes

Description : Indique la version du schéma de cette entrée de journal.

Il doit s'agir de l'un des éléments suivants

"v1"

4. Propriété `LogEntry > timestamp`


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

Description : L'horodatage auquel cette entrée de journal a été produite, au format ISO8601.

Exemple :

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

5. Propriété `LogEntry > level`


Type	`string`
Required	Yes

Description : Indication lisible par l'homme du niveau de gravité de cette entrée de journal.

Exemple :

"INFO"

6. Propriété `LogEntry > eventId`


Type	`string`
Required	Yes
Format	`uuid`

Description : Identifiant unique pour cet événement.

7. Propriété `LogEntry > event`

Titre : Événement


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

Description : La charge utile de l'événement de journal spécifique à l'application. À l'avenir, le format spécifique variera en fonction de la catégorie et du type de source, mais pour l'instant, nous utilisons un seul schéma d'événement de journal.

Exemple :

{
    "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. Propriété `LogEntry > event > eventName`


Type	`string`
Required	Yes

Description : Nom de l'événement fourni par l'application. Les noms des événements doivent être fixés par l'application (c'est-à-dire qu'ils ne doivent pas varier en fonction des paramètres de la demande) afin de permettre au client de filtrer ou d'interroger l'événement, et doivent avoir une signification pour le client. Dans le cas des journaux de demandes d'API, cela correspondrait à un nom d'opération.

Exemples :

"project_updated"

"instance_provision_requested"

7.2. Propriété `LogEntry > event > status`


Type	`string`
Required	Yes

Description : Indication de l'état associé à l'événement, par exemple succès/échec de la demande.

Exemples :

"success"

"failed"

"unauthorized"

7.3. Propriété `LogEntry > event > auth`

Titre : AuthInfo


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

Description : Fournit des informations d'authentification et d'autorisation sur le principal associé à l'événement du journal. Dans la plupart des cas, il s'agit de la personne qui a fait la demande.

Exemple :

{
    "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. Propriété `LogEntry > event > auth > authType`


Type	`enum (of string)`
Required	Yes

Description : Indique le type d'entité du principal associé à la demande.

Il doit s'agir de l'un des éléments suivants

"user"

7.3.2. Propriété `LogEntry > event > auth > user`

Titre : Utilisateur


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

Description : Fournit des informations d'identification sur l'utilisateur associé à l'événement du journal.

Exemple :

{
    "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. Propriété `LogEntry > event > auth > user > userId`


Type	`string`
Required	Yes

Description : Identifiant unique de l'utilisateur ; il s'agit d'un identifiant opaque attribué par le système qui n'est pas censé être reconnaissable par les personnes.

Exemple :

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

7.3.2.2. Propriété `LogEntry > event > auth > user > userName`


Type	`string`
Required	Yes

Description : Fournit un nom d'affichage plus convivial pour l'utilisateur.

Exemple :

"jdoe@equinix.com"

7.3.3. Propriété `LogEntry > event > auth > role`

Titre : Rôle


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

Description : Fournit des informations sur le rôle associé à l'événement du journal, qui détermine les permissions autorisées. Si le principal a accès à plusieurs rôles, cette information indique celui qu'il a assumé lors de la demande.

Exemple :

{
    "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. Propriété `LogEntry > event > auth > role > roleName`


Type	`string`
Required	Yes

Description : Le nom d'affichage convivial du rôle.

Exemple :

"collaborator"

7.4. Propriété `LogEntry > event > httpRequest`

Titre : HttpRequest


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

Description : Fournit des détails sur la requête HTTP associée à l'événement du journal, s'il y en a une (pour l'instant, il y en aura toujours une).

Exemple :

{
    "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. Propriété `LogEntry > event > httpRequest > host`


Type	`string`
Required	Yes

Description : Le nom d'hôte auquel la requête HTTP originale a été adressée.

Exemple :

"api.equinix.com"

7.4.2. Propriété `LogEntry > event > httpRequest > method`


Type	`string`
Required	Yes

Description : La méthode de requête HTTP.

Exemple :

"PUT"

7.4.3. Propriété `LogEntry > event > httpRequest > path`


Type	`string`
Required	Yes

Description : Partie du chemin d'accès de l'URL d'origine de la requête HTTP.

Exemple :

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

7.4.4. Propriété `LogEntry > event > httpRequest > scheme`


Type	`enum (of string)`
Required	Yes

Description : Le schéma de requête HTTP

Il doit s'agir de l'un des éléments suivants

"http"
"https"

7.4.5. Propriété `LogEntry > event > httpRequest > statusCode`


Type	`integer`
Required	Yes

Description : Code d'état HTTP résultant du traitement de la demande.

Exemple :

7.4.6. Propriété `LogEntry > event > httpRequest > userAgent`


Type	`string`
Required	Yes

Description : L'agent utilisateur qui a émis la requête, tel que rapporté par le client HTTP.

Exemple :

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

7.4.7. Propriété `LogEntry > event > httpRequest > sourceIpAddress`


Type	`string`
Required	Yes

Description : L'adresse IP à partir de laquelle la requête HTTP a été envoyée.

Exemple :

"111.111.111.11"

7.5. Propriété `LogEntry > event > resource`


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

Description : La ressource associée à la demande (pour une utilisation future).

Exemple :

{}

7.6. Propriété `LogEntry > event > request`


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

Description : Paramètres détaillés de la demande (pour une utilisation future)

Exemple :

{}

7.7. Propriété `LogEntry > event > response`


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

Description : Corps de réponse détaillé (pour utilisation future)

Exemple :

{}

---------------------------------------------------------------------------------------------------------------------------- Généré en utilisant json-schema-for-humans on 19/07/2024 at 16:25:20 -0500

LogEntry​

1. Propriété LogEntry > stream​

1.1. Propriété LogEntry > stream > streamId​

1.2. Propriété LogEntry > stream > streamName​

2. Propriété LogEntry > source​

2.1. Propriété LogEntry > source > category​

2.2. Propriété LogEntry > source > type​

2.3. Propriété LogEntry > source > service​

2.4. Propriété LogEntry > source > organizationId​

2.5. Propriété LogEntry > source > projectId​

3. Propriété LogEntry > schema​

4. Propriété LogEntry > timestamp​

5. Propriété LogEntry > level​

6. Propriété LogEntry > eventId​

7. Propriété LogEntry > event​

7.1. Propriété LogEntry > event > eventName​

7.2. Propriété LogEntry > event > status​

7.3. Propriété LogEntry > event > auth​

7.3.1. Propriété LogEntry > event > auth > authType​

7.3.2. Propriété LogEntry > event > auth > user​

7.3.2.1. Propriété LogEntry > event > auth > user > userId​

7.3.2.2. Propriété LogEntry > event > auth > user > userName​

7.3.3. Propriété LogEntry > event > auth > role​

7.3.3.1. Propriété LogEntry > event > auth > role > roleName​

7.4. Propriété LogEntry > event > httpRequest​

7.4.1. Propriété LogEntry > event > httpRequest > host​

7.4.2. Propriété LogEntry > event > httpRequest > method​

7.4.3. Propriété LogEntry > event > httpRequest > path​

7.4.4. Propriété LogEntry > event > httpRequest > scheme​

7.4.5. Propriété LogEntry > event > httpRequest > statusCode​

7.4.6. Propriété LogEntry > event > httpRequest > userAgent​

7.4.7. Propriété LogEntry > event > httpRequest > sourceIpAddress​

7.5. Propriété LogEntry > event > resource​

7.6. Propriété LogEntry > event > request​

7.7. Propriété LogEntry > event > response​

LogEntry

1. Propriété `LogEntry > stream`

1.1. Propriété `LogEntry > stream > streamId`

1.2. Propriété `LogEntry > stream > streamName`

2. Propriété `LogEntry > source`

2.1. Propriété `LogEntry > source > category`

2.2. Propriété `LogEntry > source > type`

2.3. Propriété `LogEntry > source > service`

2.4. Propriété `LogEntry > source > organizationId`

2.5. Propriété `LogEntry > source > projectId`

3. Propriété `LogEntry > schema`

4. Propriété `LogEntry > timestamp`

5. Propriété `LogEntry > level`

6. Propriété `LogEntry > eventId`

7. Propriété `LogEntry > event`

7.1. Propriété `LogEntry > event > eventName`

7.2. Propriété `LogEntry > event > status`

7.3. Propriété `LogEntry > event > auth`

7.3.1. Propriété `LogEntry > event > auth > authType`

7.3.2. Propriété `LogEntry > event > auth > user`

7.3.2.1. Propriété `LogEntry > event > auth > user > userId`

7.3.2.2. Propriété `LogEntry > event > auth > user > userName`

7.3.3. Propriété `LogEntry > event > auth > role`

7.3.3.1. Propriété `LogEntry > event > auth > role > roleName`

7.4. Propriété `LogEntry > event > httpRequest`

7.4.1. Propriété `LogEntry > event > httpRequest > host`

7.4.2. Propriété `LogEntry > event > httpRequest > method`

7.4.3. Propriété `LogEntry > event > httpRequest > path`

7.4.4. Propriété `LogEntry > event > httpRequest > scheme`

7.4.5. Propriété `LogEntry > event > httpRequest > statusCode`

7.4.6. Propriété `LogEntry > event > httpRequest > userAgent`

7.4.7. Propriété `LogEntry > event > httpRequest > sourceIpAddress`

7.5. Propriété `LogEntry > event > resource`

7.6. Propriété `LogEntry > event > request`

7.7. Propriété `LogEntry > event > response`