Documentación de Splunk Event Schema

LogEntry

Título: LogEntry


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

Descripción: El formato de registro de cara al cliente para el servicio de observabilidad de Equinix.

Ejemplo:

{
    "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. Propiedad `LogEntry > stream`

Título: Stream


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

Descripción: Proporciona metadatos sobre el flujo de observabilidad que produjo esta entrada de registro; puede utilizarse para diferenciar las fuentes de datos en situaciones en las que varios flujos están escribiendo en el mismo destino.

Ejemplo:

{
    "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. Propiedad `LogEntry > stream > streamId`


Type	`string`
Required	Yes
Format	`uuid`

Descripción: Identificador único del flujo de observabilidad que produjo esta entrada de registro.

1.2. Propiedad `LogEntry > stream > streamName`


Type	`string`
Required	Yes

Descripción: Nombre del flujo de observabilidad que produjo esta entrada de registro.

Ejemplo:

"Example Stream"

2. Propiedad `LogEntry > source`

Título: Fuente


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

Descripción: Proporciona metadatos sobre la fuente de la que procede esta entrada de registro.

Ejemplo:

{
    "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. Propiedad `LogEntry > source > category`


Type	`enum (of string)`
Required	Yes

Descripción: Agrupa los registros en categorías de aplicaciones de alto nivel.

Debe ser uno de:

"auditoría"
"validación"

2.2. Propiedad `LogEntry > source > type`


Type	`enum (of string)`
Required	Yes

Descripción: Diferencia los tipos de eventos de registro dentro de una categoría determinada.

Debe ser uno de:

"api_request"
"validation_request"

2.3. Propiedad `LogEntry > source > service`


Type	`enum (of string)`
Required	Yes

Descripción: Indica el servicio que produjo esta entrada de registro.

Debe ser uno de:

"Metal"

2.4. Propiedad `LogEntry > source > organizationId`


Type	`string`
Required	Yes
Format	`uuid`

Descripción: Indica el ID de organización del cliente con el que está asociada esta entrada de registro.

2.5. Propiedad `LogEntry > source > projectId`


Type	`string`
Required	No
Format	`uuid`

Descripción: Indica el ID del proyecto del cliente al que está asociada esta entrada de registro.

3. Propiedad `LogEntry > schema`


Type	`enum (of string)`
Required	Yes

Descripción: Indica la versión del esquema de esta entrada de registro.

Debe ser uno de:

"v1"

4. Propiedad `LogEntry > timestamp`


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

Descripción: La marca de tiempo en la que se produjo esta entrada de registro, en formato ISO8601.

Ejemplo:

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

5. Propiedad `LogEntry > level`


Type	`string`
Required	Yes

Descripción: Una indicación legible por humanos del nivel de gravedad de esta entrada de registro.

Ejemplo:

"INFO"

6. Propiedad `LogEntry > eventId`


Type	`string`
Required	Yes
Format	`uuid`

Descripción: Identificador único para este evento de registro.

7. Propiedad `LogEntry > event`

Título: Evento


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

Descripción: La carga útil del evento de registro específico de la aplicación. En el futuro, el formato específico variará en función de la categoría y el tipo de fuente, pero por ahora utilizamos un único esquema de eventos de registro.

Ejemplo:

{
    "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. Propiedad `LogEntry > event > eventName`


Type	`string`
Required	Yes

Descripción: Un nombre proporcionado por la aplicación para el evento. Los nombres de los eventos deben ser fijados por la aplicación (es decir, no deben variar en función de los parámetros de la solicitud) para permitir el filtrado/consulta por parte del cliente, y deben tener un significado para el cliente. En el caso de los registros de solicitudes de la API, correspondería a un nombre de operación.

Ejemplos:

"project_updated"

"instance_provision_requested"

7.2. Propiedad `LogEntry > event > status`


Type	`string`
Required	Yes

Descripción: Indicación del estado asociado al evento, por ejemplo, éxito/fracaso de la solicitud.

Ejemplos:

"success"

"failed"

"unauthorized"

7.3. Propiedad `LogEntry > event > auth`

Título: AuthInfo


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

Descripción: Proporciona información de autenticación y autorización sobre la entidad de seguridad asociada al evento de registro. En la mayoría de los casos, éste será el que realizó la solicitud.

Ejemplo:

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


Type	`enum (of string)`
Required	Yes

Descripción: Indica el tipo de entidad para el mandante asociado a la solicitud.

Debe ser uno de:

"user"

7.3.2. Propiedad `LogEntry > event > auth > user`

Título: Usuario


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

Descripción: Proporciona información identificativa sobre el usuario asociado al evento de registro.

Ejemplo:

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


Type	`string`
Required	Yes

Descripción: Identificador único de usuario; se trata de un ID opaco asignado por el sistema que no se espera que sea reconocible por las personas.

Ejemplo:

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

7.3.2.2. Propiedad `LogEntry > event > auth > user > userName`


Type	`string`
Required	Yes

Descripción: Proporciona un nombre de visualización más amigable para el usuario.

Ejemplo:

"jdoe@equinix.com"

7.3.3. Propiedad `LogEntry > event > auth > role`

Título: Función


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

Descripción: Proporciona información sobre el rol asociado al evento de registro, que determina los permisos permitidos. Si el mandante tiene acceso a varios roles, indica el que asumió al realizar la solicitud.

Ejemplo:

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


Type	`string`
Required	Yes

Descripción: El nombre para mostrar amigable para el rol.

Ejemplo:

"collaborator"

7.4. Propiedad `LogEntry > event > httpRequest`

Título: HttpRequest


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

Descripción: Proporciona detalles sobre la solicitud HTTP asociada con el evento de registro, si es que hay una (por ahora, siempre habrá una).

Ejemplo:

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


Type	`string`
Required	Yes

Descripción: El nombre de host al que se realizó la solicitud HTTP original.

Ejemplo:

"api.equinix.com"

7.4.2. Propiedad `LogEntry > event > httpRequest > method`


Type	`string`
Required	Yes

Descripción: El método de solicitud HTTP.

Ejemplo:

"PUT"

7.4.3. Propiedad `LogEntry > event > httpRequest > path`


Type	`string`
Required	Yes

Descripción: La parte de la ruta de la URL original de la solicitud HTTP.

Ejemplo:

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

7.4.4. Propiedad `LogEntry > event > httpRequest > scheme`


Type	`enum (of string)`
Required	Yes

Descripción: El esquema de petición HTTP

Debe ser uno de:

"http"
"https"

7.4.5. Propiedad `LogEntry > event > httpRequest > statusCode`


Type	`integer`
Required	Yes

Descripción: El código de estado HTTP resultante del procesamiento de la solicitud.

Ejemplo:

7.4.6. Propiedad `LogEntry > event > httpRequest > userAgent`


Type	`string`
Required	Yes

Descripción: El usuario-agente que emitió la solicitud, según lo informado por el cliente HTTP.

Ejemplo:

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

7.4.7. Propiedad `LogEntry > event > httpRequest > sourceIpAddress`


Type	`string`
Required	Yes

Descripción: La dirección IP desde la que se envió la solicitud HTTP.

Ejemplo:

"111.111.111.11"

7.5. Propiedad `LogEntry > event > resource`


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

Descripción: El recurso asociado a la solicitud (para uso futuro)

Ejemplo:

{}

7.6. Propiedad `LogEntry > event > request`


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

Descripción: Parámetros detallados de la solicitud (para uso futuro)

Ejemplo:

{}

7.7. Propiedad `LogEntry > event > response`


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

Descripción: Cuerpo detallado de la respuesta (para uso futuro)

Ejemplo:

{}

---------------------------------------------------------------------------------------------------------------------------- Generado usando json-schema-for-humans en 19/07/2024 a las 16:25:20 -0500

LogEntry​

1. Propiedad LogEntry > stream​

1.1. Propiedad LogEntry > stream > streamId​

1.2. Propiedad LogEntry > stream > streamName​

2. Propiedad LogEntry > source​

2.1. Propiedad LogEntry > source > category​

2.2. Propiedad LogEntry > source > type​

2.3. Propiedad LogEntry > source > service​

2.4. Propiedad LogEntry > source > organizationId​

2.5. Propiedad LogEntry > source > projectId​

3. Propiedad LogEntry > schema​

4. Propiedad LogEntry > timestamp​

5. Propiedad LogEntry > level​

6. Propiedad LogEntry > eventId​

7. Propiedad LogEntry > event​

7.1. Propiedad LogEntry > event > eventName​

7.2. Propiedad LogEntry > event > status​

7.3. Propiedad LogEntry > event > auth​

7.3.1. Propiedad LogEntry > event > auth > authType​

7.3.2. Propiedad LogEntry > event > auth > user​

7.3.2.1. Propiedad LogEntry > event > auth > user > userId​

7.3.2.2. Propiedad LogEntry > event > auth > user > userName​

7.3.3. Propiedad LogEntry > event > auth > role​

7.3.3.1. Propiedad LogEntry > event > auth > role > roleName​

7.4. Propiedad LogEntry > event > httpRequest​

7.4.1. Propiedad LogEntry > event > httpRequest > host​

7.4.2. Propiedad LogEntry > event > httpRequest > method​

7.4.3. Propiedad LogEntry > event > httpRequest > path​

7.4.4. Propiedad LogEntry > event > httpRequest > scheme​

7.4.5. Propiedad LogEntry > event > httpRequest > statusCode​

7.4.6. Propiedad LogEntry > event > httpRequest > userAgent​

7.4.7. Propiedad LogEntry > event > httpRequest > sourceIpAddress​

7.5. Propiedad LogEntry > event > resource​

7.6. Propiedad LogEntry > event > request​

7.7. Propiedad LogEntry > event > response​

LogEntry

1. Propiedad `LogEntry > stream`

1.1. Propiedad `LogEntry > stream > streamId`

1.2. Propiedad `LogEntry > stream > streamName`

2. Propiedad `LogEntry > source`

2.1. Propiedad `LogEntry > source > category`

2.2. Propiedad `LogEntry > source > type`

2.3. Propiedad `LogEntry > source > service`

2.4. Propiedad `LogEntry > source > organizationId`

2.5. Propiedad `LogEntry > source > projectId`

3. Propiedad `LogEntry > schema`

4. Propiedad `LogEntry > timestamp`

5. Propiedad `LogEntry > level`

6. Propiedad `LogEntry > eventId`

7. Propiedad `LogEntry > event`

7.1. Propiedad `LogEntry > event > eventName`

7.2. Propiedad `LogEntry > event > status`

7.3. Propiedad `LogEntry > event > auth`

7.3.1. Propiedad `LogEntry > event > auth > authType`

7.3.2. Propiedad `LogEntry > event > auth > user`

7.3.2.1. Propiedad `LogEntry > event > auth > user > userId`

7.3.2.2. Propiedad `LogEntry > event > auth > user > userName`

7.3.3. Propiedad `LogEntry > event > auth > role`

7.3.3.1. Propiedad `LogEntry > event > auth > role > roleName`

7.4. Propiedad `LogEntry > event > httpRequest`

7.4.1. Propiedad `LogEntry > event > httpRequest > host`

7.4.2. Propiedad `LogEntry > event > httpRequest > method`

7.4.3. Propiedad `LogEntry > event > httpRequest > path`

7.4.4. Propiedad `LogEntry > event > httpRequest > scheme`

7.4.5. Propiedad `LogEntry > event > httpRequest > statusCode`

7.4.6. Propiedad `LogEntry > event > httpRequest > userAgent`

7.4.7. Propiedad `LogEntry > event > httpRequest > sourceIpAddress`

7.5. Propiedad `LogEntry > event > resource`

7.6. Propiedad `LogEntry > event > request`

7.7. Propiedad `LogEntry > event > response`