Biblioteca de eventos

Caso de uso

La Biblioteca de eventos proporciona la capacidad de realizar auditorías para cumplir con los requisitos de cumplimiento en industrias altamente reguladas, como servicios de salud o financieros.

Cómo funciona

The Event Library opens a separate "event" realm on the user's device. This realm has access to any user realm that the developer chooses to monitor with the Event Library.

Cuando los desarrolladores implementan la Biblioteca de Eventos, especifican los tipos de eventos que desean registrar, así como los metadatos personalizados que desean añadir a las grabaciones de eventos. Al ejecutarse la aplicación cliente, registra las interacciones del usuario designadas en el dominio "evento" como eventos de lectura, escritura o personalizados.

While the client device has a network connection, Atlas Device Sync synchronizes this event realm data to an AuditEvent collection in the linked Atlas data source.

Esquema de biblioteca de eventos

Su colección AuditEvent debe tener un esquema que contenga los siguientes campos:

Además, el esquema debe contener un campo de string opcional para cada clave de metadatos que utilices. Por ejemplo:

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

Leer eventos

La Biblioteca de Eventos guarda los datos devueltos como resultado de una query como eventos de lectura. Los eventos de lectura también registran cualquier vez que se instancia un objeto Realm, como al seguir un enlace o buscar un objeto por llave primaria.

The Event Library records read events as a JSON object with two fields:

• type: almacena el nombre de la clase

• value: stores an array of serialized objects

Los eventos de lectura almacenan valores de la siguiente manera:

• Eventos de lectura de un solo objeto: el valor es una matriz que tiene un solo elemento

• Objetos que coinciden con una query: el valor es un arreglo de todos los objetos que coinciden con la query, incluso si nunca se utilizan los objetos

• Lecturas que ocurren durante una transacción de escritura: el valor son los datos que tenía el objeto antes de que comenzara la transacción de escritura; no refleja ningún cambio que ocurra durante el evento de escritura.

• Objetos que no existen cuando comienza una transacción de escritura: los objetos que se crean en una transacción de escritura no producen ningún evento de lectura.

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

Escribir eventos

The Event Library records write events when:

• Se crean nuevos objetos

• Los objetos existentes se modifican

• Los objetos se eliminan

The write event records both the before and after state of the object. For new objects created, the before state is null. For deletes, the after state of the object is null.

Por cada transacción de escritura que el cliente confirma durante un alcance de registro de eventos, la Biblioteca de eventos registra un solo evento de escritura. Este evento de escritura registra todos los cambios realizados durante la transacción de escritura.

La carga útil es un objeto codificado por nombres de clase. Cada tipo de objeto que tuvo objetos creados, modificados o eliminados tiene una entrada.

La Librería de eventos registra cambios en un tipo de objeto Realm como un objeto con tres arreglos:

• inserciones: contienen los objetos serializados que se insertaron, utilizando el mismo esquema de serialización que las lecturas

• modificaciones: informar tanto los valores antiguos como los nuevos de cada propiedad

• eliminaciones: contienen los objetos serializados que se borraron, utilizando el mismo esquema de serialización que la lectura

En una modificación, el objeto newValue solo incluye propiedades diferentes a las del objeto oldValue. Si una transacción de escritura asigna valores a un objeto, pero no modifica el valor de ninguna propiedad,

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

Los eventos personalizados pueden registrar tipos de eventos que no leen ni escriben en la base de datos, como:

• Cuando se muestra una pantalla específica

• When the user clicks a button

Puedes usar eventos personalizados para contextualizar eventos de lectura y escritura, como registrar un evento personalizado cuando la aplicación cliente muestra una pantalla determinada. De esta forma, puedes inferir que los eventos de lectura y escritura posteriores al evento personalizado que registra la carga de la pantalla de la aplicación ocurrieron en esa pantalla.

Los eventos personalizados pueden almacenar cualquier dato que desee el desarrollador, o no almacenar datos en absoluto.

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