Biblioteca de eventos

Caso de uso

A Biblioteca de eventos oferece a capacidade de realizar auditorias para atender aos requisitos de conformidade em setores fortemente regulamentados, como saúde ou serviços financeiros.

Como Funciona

A Biblioteca de Eventos abre um domínio de "evento" separado no dispositivo do usuário. Esse domínio tem acesso a qualquer domínio do usuário que o desenvolvedor escolha monitorar com a Biblioteca de eventos.

Quando os desenvolvedores implementam a Biblioteca de eventos, eles designam os tipos de eventos que desejam gravar, bem como quaisquer metadados personalizados que desejam anexar às gravações dos eventos. Quando o aplicativo cliente é executado, ele registra as interações do usuário designado no domínio "vento" como eventos de leitura, eventos de gravação ou eventos personalizados.

Enquanto o dispositivo cliente tiver uma conexão de rede, o Atlas Device Sync sincroniza os dados do realm do evento com uma collection AuditEvent na fonte de dados do Atlas vinculada.

Esquema da Biblioteca de Eventos

Sua collection AuditEvent deve ter um esquema contendo os seguintes campos:

Além disso, o esquema deve conter um campo de string opcional para cada chave de metadados que você usa. Por exemplo:

{
  "<Metadata Key>": {
    "bsonType": "string"
  }
}

{
  "title": "AuditEvent",
  "bsonType": "object",
  "required": [
    "_id",
    "_partition",
    "timestamp",
    "activity"
  ],
  "properties": {
    "_id": {
      "bsonType": "objectId"
    },
    "_partition": {
      "bsonType": "string"
    },
    "timestamp": {
      "bsonType": "date"
    },
    "activity": {
      "bsonType": "string"
    },
    "event": {
      "bsonType": "string"
    },
    "data": {
      "bsonType": "string"
    }
  }
}

Ler eventos

A Biblioteca de eventos registra os dados retornados como resultado de uma query como eventos de leitura. Os eventos de leitura também registram qualquer momento em que um objeto do Realm é instanciado, como ao seguir um link ou procurar um objeto por chave primária.

A Biblioteca de eventos registra eventos de leitura como um objeto JSON com dois campos:

• type: armazena o nome da classe

• value: armazena uma array de objetos serializados

Leia os valores do armazenamento de eventos da seguinte forma:

• Eventos de leitura de objeto único: o valor é uma array que tem um único elemento

• Objetos que correspondem a uma query: o valor é uma array de todos os objetos que correspondem a uma query, mesmo que os objetos nunca sejam usados

• Leituras que ocorrem durante uma transação de escrita: o valor são os dados que o objeto tem antes do início da transação de escrita; ele não reflete nenhuma alteração que ocorra durante o evento de gravação.

• Objetos que não existem quando uma transação de escrita começa: objetos criados em uma transação de escrita não produzem nenhum evento de leitura.

{
  "_id": "62b396f4ebe94d2b871889bb",
  "_partition":"events-62b396f4ebe94d2b871889ba",
  "activity":"read object",
  "data": "{
      "type":"Person",
      "value": [{
        "_id": "62b396f4ebe94d2b871889b9",
        "_partition":"",
        "employeeId":1,
        "name":"Anthony"
      }]
  }",
  "event":"read",
  "timestamp": 2022-06-23T14:54:37.756+00:00
}

{
  "type": "Person",
  "value": [{
    "_id": "62b47624265ff7b58e9b204e",
    "_partition": "",
    "employeeId": 1,
    "name": "Michael Scott",
    "office": "62b47624265ff7b58e9b204f"
  }]
}

{
  "type":"Person",
  "value": [{
    "_id": "62b47975a33224558bdf8b4d",
    "_partition": "",
    "employeeId": 1,
    "name": "Michael Scott",
    "office": {
      "_id": "62b47975a33224558bdf8b4e",
      "_partition": "",
      "city": "Scranton",
      "locationNumber": 123,
      "name": "Dunder Mifflin"
    }
  }]
}
{
  "type": "Office",
  "value": [{
    "_id": "62b47975a33224558bdf8b4e",
    "_partition": "",
    "city": "Scranton",
    "locationNumber": 123,
    "name": "Dunder Mifflin"
  }]
}

Eventos de gravação

A Biblioteca de Eventos registra eventos de gravação quando:

• Novos objetos são criados

• Objetos existentes são modificados

• Objetos são excluídos

O evento de gravação registra o estado antes e depois do objeto. Para novos objetos criados, o estado anterior é null. Para exclusões, o estado posterior do objeto é null.

Para cada transação de escrita que o cliente confirma durante um escopo de gravação de eventos, a Biblioteca de Eventos registra um único evento de escrita. Esse evento de gravação registra todas as alterações feitas durante a transação de escrita.

A carga útil é um objeto chaveado nos nomes das classes. Cada tipo de objeto que teve objetos criados, modificados ou excluídos tem uma entrada.

A Biblioteca de eventos registra as alterações em um tipo de objeto como um objeto com três arrays:

• inserções: contém os objetos serializados que foram inseridos, usando o mesmo esquema de serialização das leituras

• modificações: relatar os valores antigos e novos de cada propriedade

• exclusões: contém os objetos serializados que foram excluídos, usando o mesmo esquema de serialização das leituras

Em uma modificação, o objeto newValue inclui somente propriedades que são diferentes do objeto oldValue . Se uma transação de escrita atribuir a um objeto, mas na verdade não alterar o valor de nenhuma propriedade,

{
  "Person": {
    "insertions": [{
      "_id": "62b47ead6a178a314ae0eb52",
      "_partition": "",
      "employeeId": 1,
      "name": "Anthony"
    }]
  }
}

{
  "Person":{
    "modifications": [{
      "newValue": {
        "name": "Tony"
      },
      "oldValue": {
        "_id": "62b47d83cdac49f904c5737b",
        "_partition": "",
        "employeeId": 1,
        "name": "Anthony"
      }
    }]
  }
}

{
  "Person":{
    "deletions":[{
      "_id":"62b47ead6a178a314ae0eb52",
      "_partition":"",
      "employeeId":1,
      "name":"Tony",
      "userId":"tony.stark@starkindustries.com"
    }]
  }
}

Eventos personalizados

Os eventos personalizados podem registrar tipos de eventos que não leem ou gravam no banco de dados, como:

• Quando uma tela específica é exibida

• Quando o usuário clica em um botão

Você pode usar eventos personalizados para dar contexto a eventos de leitura e escrita, como gravar um evento personalizado quando o aplicativo cliente exibe uma determinada tela. Em seguida, é possível inferir que os eventos de leitura e escrita após o evento personalizado de gravação do carregamento da tela do aplicativo ocorreram todos nessa tela de aplicativo.

Os eventos personalizados podem armazenar quaisquer dados que um desenvolvedor deseje ou nenhum dado.

{
  "_id": "62b4804c15659310991e5e0a",
  "_partition": "events-62b4804b15659310991e5e09",
  "activity": "login",
  "event": "custom event",
  "timestamp": 2022-06-23T15:01:31.941+00:00
}