Documentação do esquema de eventos do Splunk

LogEntry

Título: Registro de Log

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

Descrição: O formato de log voltado para o cliente do Equinix Observability Service.

Exemplo:

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

Título: Transmissão

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

Descrição: Fornece metadados sobre o fluxo de observabilidade que gerou esta entrada de log; pode ser usado para diferenciar fontes de dados em situações onde vários fluxos estão gravando no mesmo destino.

Exemplo:

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

Type	string
Required	Yes
Format	uuid

Descrição: Identificador único do fluxo de observabilidade que gerou esta entrada de log.

1.2. Propriedade LogEntry > stream > streamName

Type	string
Required	Yes

Descrição: Nome do fluxo de observabilidade que gerou esta entrada de log.

Exemplo:

"Example Stream"

2. Propriedade LogEntry > source

Título: Fonte

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

Descrição: Fornece metadados sobre a origem desta entrada de registro.

Exemplo:

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

Type	enum (of string)
Required	Yes

Descrição: Agrupa os logins em categorias de aplicativos de alto nível.

Deve ser um dos seguintes:

• "auditoria"
• "validação"

2.2. Propriedade LogEntry > source > type

Type	enum (of string)
Required	Yes

Descrição: Diferencia os tipos de eventos de registro dentro de uma categoria específica.

Deve ser um dos seguintes:

• "api_request"
• "validation_request"

2.3. Propriedade LogEntry > source > service

Type	enum (of string)
Required	Yes

Descrição: Indica o serviço que gerou esta entrada de registro.

Deve ser um dos seguintes:

• "metal"

2.4. Propriedade LogEntry > source > organizationId

Type	string
Required	Yes
Format	uuid

Descrição: Indica o ID da organização do cliente à qual esta entrada de registro está associada.

2.5. Propriedade LogEntry > source > projectId

Type	string
Required	No
Format	uuid

Descrição: Indica o ID do projeto do cliente ao qual esta entrada de registro está associada.

3. Propriedade LogEntry > schema

Type	enum (of string)
Required	Yes

Descrição: Indica a versão do esquema desta entrada de log.

Deve ser um dos seguintes:

• "v1"

4. Propriedade LogEntry > timestamp

Type	string
Required	Yes
Format	date-time

Descrição: O registro de data e hora em que esta entrada de log foi gerada, no formato ISO8601.

Exemplo:

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

5. Propriedade LogEntry > level

Type	string
Required	Yes

Descrição: Uma indicação legível por humanos do nível de gravidade desta entrada de registro.

Exemplo:

"INFO"

6. Propriedade LogEntry > eventId

Type	string
Required	Yes
Format	uuid

Descrição: Identificador único para este evento de registro.

7. Propriedade LogEntry > event

Título: Evento

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

Descrição: O conteúdo do evento de log específico da aplicação. No futuro, o formato específico poderá variar de acordo com a aplicação. categoria e tipo de origem, mas por enquanto usamos um único esquema de evento de log.

Exemplo:

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

Type	string
Required	Yes

Descrição: Um nome fornecido pela aplicação para o evento. Os nomes dos eventos devem ser definidos pela aplicação. (ou seja, não deve variar com base nos parâmetros da solicitar ) para permitir a filtragem/consulta pelo cliente e deve conter significado para o cliente. No caso de registros de solicitar de API, isso corresponderia a um nome de operação.

Exemplos:

"project_updated"

"instance_provision_requested"

7.2. Propriedade LogEntry > event > status

Type	string
Required	Yes

Descrição: Uma indicação do status associado ao evento, por exemplo, sucesso/falha da solicitar .

Exemplos:

"success"

"failed"

"unauthorized"

7.3. Propriedade LogEntry > event > auth

Título: Informações de autenticação

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

Descrição: Fornece informações de autenticação e autorização sobre a entidade associada ao Registre o evento. Na maioria dos casos, será quem fez a solicitar.

Exemplo:

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

Type	enum (of string)
Required	Yes

Descrição: Indica o tipo de entidade para o principal associado à solicitar.

Deve ser um dos seguintes:

• "user"

7.3.2. Propriedade LogEntry > event > auth > user

Título: Usuário

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

Descrição: Fornece informações de identificação sobre o usuário associado ao evento de registro.

Exemplo:

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

Type	string
Required	Yes

Descrição: Identificador de usuário único; trata-se de um ID opaco atribuído pelo sistema, que não deve ser reconhecido por pessoas.

Exemplo:

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

7.3.2.2. Propriedade LogEntry > event > auth > user > userName

Type	string
Required	Yes

Descrição: Fornece um nome de exibição mais amigável para o usuário.

Exemplo:

"jdoe@equinix.com"

7.3.3. Propriedade LogEntry > event > auth > role

Título: Função

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

Descrição: Fornece informações sobre a função associada ao evento de log, que determina quais permissões. são permitidos. Se o diretor tiver acesso a várias funções, isso indica qual função ele assumiu ao criar a conta. solicitar.

Exemplo:

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

Type	string
Required	Yes

Descrição: O nome de exibição amigável para o cargo.

Exemplo:

"collaborator"

7.4. Propriedade LogEntry > event > httpRequest

Título: Requisição HTTP

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

Descrição: Fornece detalhes sobre a solicitar HTTP associada ao evento de log, se houver (por enquanto, há sempre haverá um).

Exemplo:

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

Type	string
Required	Yes

Descrição: O nome do host para o qual a solicitar HTTP original foi feita.

Exemplo:

"api.equinix.com"

7.4.2. Propriedade LogEntry > event > httpRequest > method

Type	string
Required	Yes

Descrição: O método de solicitar HTTP.

Exemplo:

"PUT"

7.4.3. Propriedade LogEntry > event > httpRequest > path

Type	string
Required	Yes

Descrição: A parte do caminho da URL da solicitar HTTP original.

Exemplo:

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

7.4.4. Propriedade LogEntry > event > httpRequest > scheme

Type	enum (of string)
Required	Yes

Descrição: O esquema de solicitar HTTP

Deve ser um dos seguintes:

• "http"
• "https"

7.4.5. Propriedade LogEntry > event > httpRequest > statusCode

Type	integer
Required	Yes

Descrição: O código de status HTTP resultante do processamento da solicitar.

Exemplo:

200

7.4.6. Propriedade LogEntry > event > httpRequest > userAgent

Type	string
Required	Yes

Descrição: O agente do usuário que emitiu a solicitar, conforme relatado pelo cliente HTTP.

Exemplo:

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

7.4.7. Propriedade LogEntry > event > httpRequest > sourceIpAddress

Type	string
Required	Yes

Descrição: O endereço IP a partir do qual a solicitar HTTP foi enviada.

Exemplo:

"111.111.111.11"

7.5. Propriedade LogEntry > event > resource

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

Descrição: O recurso associado à solicitar (para uso futuro)

Exemplo:

{}

7.6. Propriedade LogEntry > event > request

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

Descrição: Parâmetros detalhados da solicitar (para uso futuro)

Exemplo:

{}

7.7. Propriedade LogEntry > event > response

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

Descrição: Corpo da resposta detalhado (para uso futuro)

Exemplo:

{}

---

Gerado usando json-schema-for-humans em 19/07/2024 às 16:25:20 -0500