M

MLOG

Български

Научете как Event Sourcing революционизира одиторските следи: ненадмината проследяемост, интегритет на данните, устойчивост. Практически примери и стратегии.

Event Sourcing: Внедряване на одиторски следи за надеждни и проследими системи

В днешния сложен и взаимосвързан цифров пейзаж, поддържането на стабилна и всеобхватна одиторска следа е от първостепенно значение. Това не само често е регулаторно изискване, но е и от решаващо значение за отстраняване на грешки, анализ на сигурността и разбиране на еволюцията на вашата система. Event Sourcing, архитектурен модел, който улавя всички промени в състоянието на приложението като последователност от събития, предлага елегантно и мощно решение за внедряване на одиторски следи, които са надеждни, подлежащи на одит и разширяеми.

Какво представлява Event Sourcing?

Традиционните приложения обикновено съхраняват само текущото състояние на данните в база данни. Този подход затруднява възстановяването на минали състояния или разбирането на поредицата от събития, довели до текущото състояние. Event Sourcing, за разлика от това, се фокусира върху улавянето на всяка значителна промяна в състоянието на приложението като неизменно събитие. Тези събития се съхраняват в хранилище за събития само за добавяне (append-only event store), формирайки пълен и хронологичен запис на всички действия в системата.

Представете си го като банкова счетоводна книга. Вместо просто да се записва текущият баланс, всяко депозиране, теглене и превод се записват като отделно събитие. Чрез преиграване на тези събития можете да възстановите състоянието на сметката по всяко време.

Защо да използваме Event Sourcing за одиторски следи?

Event Sourcing предлага няколко убедителни предимства за внедряване на одиторски следи:

Внедряване на Event Sourcing за одиторски следи: Ръководство стъпка по стъпка

Ето практическо ръководство за внедряване на Event Sourcing за одиторски следи:

1. Идентифицирайте ключовите събития

Първата стъпка е да идентифицирате ключовите събития, които искате да уловите във вашата одиторска следа. Тези събития трябва да представляват значителни промени в състоянието на приложението. Разгледайте действия като:

Пример: За платформа за електронна търговия, ключови събития могат да включват „ПоръчкаСъздадена“, „ПлащанеПолучено“, „ПоръчкаИзпратена“, „ПродуктДобавенВКоличката“ и „ПотребителскиПрофилАктуализиран“.

2. Дефинирайте структурата на събитието

Всяко събитие трябва да има добре дефинирана структура, която включва следната информация:

Пример: Събитието „ПоръчкаСъздадена“ може да има следната структура:

{
  \"eventType\": \"OrderCreated\",
  \"eventData\": {
    \"orderId\": \"12345\",
    \"customerId\": \"67890\",
    \"orderDate\": \"2023-10-27T10:00:00Z\",
    \"totalAmount\": 100.00,
    \"currency\": \"USD\",
    \"shippingAddress\": {
      \"street\": \"123 Main St\",
      \"city\": \"Anytown\",
      \"state\": \"CA\",
      \"zipCode\": \"91234\",
      \"country\": \"USA\"
    }
  },
  \"timestamp\": \"2023-10-27T10:00:00Z\",
  \"userId\": \"user123\",
  \"transactionId\": \"tx12345\",
  \"correlationId\": \"corr123\",
  \"metadata\": {
    \"ipAddress\": \"192.168.1.1\",
    \"browser\": \"Chrome\",
    \"location\": {
       \"latitude\": 34.0522,
       \"longitude\": -118.2437
    }
  }
}

3. Изберете хранилище за събития

Хранилището за събития е централното хранилище за съхраняване на събития. То трябва да бъде база данни само за добавяне, оптимизирана за запис и четене на последователности от събития. Налични са няколко опции:

При избора на хранилище за събития вземете предвид фактори като:

4. Внедрете публикуване на събития

Когато възникне събитие, вашето приложение трябва да го публикува в хранилището за събития. Това обикновено включва следните стъпки:

Пример (използвайки хипотетичен EventStoreService):

public class OrderService {

  private final EventStoreService eventStoreService;

  public OrderService(EventStoreService eventStoreService) {
    this.eventStoreService = eventStoreService;
  }

  public void createOrder(Order order, String userId) {
    // ... business logic to create the order ...

    OrderCreatedEvent event = new OrderCreatedEvent(
        order.getOrderId(),
        order.getCustomerId(),
        order.getOrderDate(),
        order.getTotalAmount(),
        order.getCurrency(),
        order.getShippingAddress()
    );

    eventStoreService.appendEvent(\"order\", order.getOrderId(), event, userId);
  }
}

public class EventStoreService {

  public void appendEvent(String streamName, String entityId, Object event, String userId) {
    // Create an event object
    EventRecord eventRecord = new EventRecord(
        UUID.randomUUID(), // eventId
        streamName,  // streamName
        entityId,   // entityId
        event.getClass().getName(), // eventType
        toJson(event),  // eventData
        Instant.now().toString(), // timestamp
        userId  // userId
    );

    // Serialize the event
    String serializedEvent = toJson(eventRecord);

    // Append the event to the event store (implementation specific to the chosen event store)
    storeEventInDatabase(serializedEvent);

    // Publish the event to subscribers (optional)
    publishEventToMessageQueue(serializedEvent);
  }

  // Placeholder methods for database and message queue interaction
  private void storeEventInDatabase(String serializedEvent) {
    // Implementation to store the event in the database
    System.out.println(\"Storing event in database: \" + serializedEvent);
  }

  private void publishEventToMessageQueue(String serializedEvent) {
    // Implementation to publish the event to a message queue
    System.out.println(\"Publishing event to message queue: \" + serializedEvent);
  }

  private String toJson(Object obj) {
    // Implementation to serialize the event to JSON
    try {
      ObjectMapper mapper = new ObjectMapper();
      return mapper.writeValueAsString(obj);
    } catch (Exception e) {
      throw new RuntimeException(\"Error serializing event to JSON\", e);
    }
  }
}


class EventRecord {
  private final UUID eventId;
  private final String streamName;
  private final String entityId;
  private final String eventType;
  private final String eventData;
  private final String timestamp;
  private final String userId;

  public EventRecord(UUID eventId, String streamName, String entityId, String eventType, String eventData, String timestamp, String userId) {
    this.eventId = eventId;
    this.streamName = streamName;
    this.entityId = entityId;
    this.eventType = eventType;
    this.eventData = eventData;
    this.timestamp = timestamp;
    this.userId = userId;
  }

  // Getters

  @Override
  public String toString() {
    return \"EventRecord{\" +
        \"eventId=\" + eventId +
        \", streamName='\" + streamName + '\'\" +
        \", entityId='\" + entityId + '\'\" +
        \", eventType='\" + eventType + '\'\" +
        \", eventData='\" + eventData + '\'\" +
        \", timestamp='\" + timestamp + '\'\" +
        \", userId='\" + userId + '\'\" +
        '}';
  }
}

class OrderCreatedEvent {
    private final String orderId;
    private final String customerId;
    private final String orderDate;
    private final double totalAmount;
    private final String currency;
    private final String shippingAddress;

    public OrderCreatedEvent(String orderId, String customerId, String orderDate, double totalAmount, String currency, String shippingAddress) {
        this.orderId = orderId;
        this.customerId = customerId;
        this.orderDate = orderDate;
        this.totalAmount = totalAmount;
        this.currency = currency;
        this.shippingAddress = shippingAddress;
    }

    // Getters for all fields

    public String getOrderId() { return orderId; }
    public String getCustomerId() { return customerId; }
    public String getOrderDate() { return orderDate; }
    public double getTotalAmount() { return totalAmount; }
    public String getCurrency() { return currency; }
    public String getShippingAddress() { return shippingAddress; }

    @Override
    public String toString() {
        return \"OrderCreatedEvent{\" +
                \"orderId='\" + orderId + '\'\" +
                \", customerId='\" + customerId + '\'\" +
                \", orderDate='\" + orderDate + '\'\" +
                \", totalAmount=\" + totalAmount +
                \", currency='\" + currency + '\'\" +
                \", shippingAddress='\" + shippingAddress + '\'\" +
                '}';
    }
}

class Order {
  private final String orderId;
  private final String customerId;
  private final String orderDate;
  private final double totalAmount;
  private final String currency;
  private final String shippingAddress;

  public Order(String orderId, String customerId, String orderDate, double totalAmount, String currency, String shippingAddress) {
        this.orderId = orderId;
        this.customerId = customerId;
        this.orderDate = orderDate;
        this.totalAmount = totalAmount;
        this.currency = currency;
        this.shippingAddress = shippingAddress;
    }

    // Getters for all fields

    public String getOrderId() { return orderId; }
    public String getCustomerId() { return customerId; }
    public String getOrderDate() { return orderDate; }
    public double getTotalAmount() { return totalAmount; }
    public String getCurrency() { return currency; }
    public String getShippingAddress() { return shippingAddress; }

    @Override
    public String toString() {
        return \"Order{\" +
                \"orderId='\" + orderId + '\'\" +
                \", customerId='\" + customerId + '\'\" +
                \", orderDate='\" + orderDate + '\'\" +
                \", totalAmount=\" + totalAmount +
                \", currency='\" + currency + '\'\" +
                \", shippingAddress='\" + shippingAddress + '\'\" +
                '}';
    }
}

5. Изградете модели за четене (проекции)

Въпреки че хранилището за събития предоставя пълна история на всички промени, често не е ефективно да се прави директна заявка към него за операции по четене. Вместо това можете да изградите модели за четене, известни също като проекции, които са оптимизирани за конкретни модели на заявки. Тези модели за четене се извличат от потока от събития и се актуализират асинхронно, когато се публикуват нови събития.

Пример: Можете да създадете модел за четене, който съдържа списък с всички поръчки за конкретен клиент, или модел за четене, който обобщава данните за продажбите за конкретен продукт.

За да изградите модел за четене, вие се абонирате за потока от събития и обработвате всяко събитие. За всяко събитие актуализирате съответно модела за четене.

Пример:

public class OrderSummaryReadModelUpdater {

    private final OrderSummaryRepository orderSummaryRepository;

    public OrderSummaryReadModelUpdater(OrderSummaryRepository orderSummaryRepository) {
        this.orderSummaryRepository = orderSummaryRepository;
    }

    public void handle(OrderCreatedEvent event) {
        OrderSummary orderSummary = new OrderSummary(
                event.getOrderId(),
                event.getCustomerId(),
                event.getOrderDate(),
                event.getTotalAmount(),
                event.getCurrency()
        );

        orderSummaryRepository.save(orderSummary);
    }

    // Other event handlers for PaymentReceivedEvent, OrderShippedEvent, etc.
}

interface OrderSummaryRepository {
    void save(OrderSummary orderSummary);
}

class OrderSummary {
    private final String orderId;
    private final String customerId;
    private final String orderDate;
    private final double totalAmount;
    private final String currency;

    public OrderSummary(String orderId, String customerId, String orderDate, double totalAmount, String currency) {
        this.orderId = orderId;
        this.customerId = customerId;
        this.orderDate = orderDate;
        this.totalAmount = totalAmount;
        this.currency = currency;
    }
    //Getters
}

6. Защитете хранилището за събития

Хранилището за събития съдържа чувствителни данни, така че е от решаващо значение да го защитите правилно. Разгледайте следните мерки за сигурност:

7. Внедрете одит и отчитане

След като сте внедрили Event Sourcing, можете да използвате потока от събития за генериране на одиторски отчети и извършване на анализ на сигурността. Можете да правите заявки към хранилището за събития, за да намерите всички събития, свързани с конкретен потребител, транзакция или обект. Можете също така да използвате потока от събития, за да възстановите състоянието на системата по всяко време.

Пример: Можете да генерирате отчет, който показва всички промени, направени в конкретен потребителски профил за определен период от време, или отчет, който показва всички транзакции, инициирани от конкретен потребител.

Разгледайте следните възможности за отчитане:

Предизвикателства на Event Sourcing

Въпреки че Event Sourcing предлага много предимства, той също така представя някои предизвикателства:

Най-добри практики за Event Sourcing

За да смекчите предизвикателствата на Event Sourcing, следвайте тези най-добри практики:

Примери от реалния свят за Event Sourcing

Event Sourcing се използва в различни индустрии и приложения, включително:

Заключение

Event Sourcing е мощен архитектурен модел, който може да революционизира внедряването на вашата одиторска следа. Той осигурява несравнима проследяемост, интегритет на данните и устойчивост на системата. Въпреки че представлява някои предизвикателства, ползите от Event Sourcing често надхвърлят разходите, особено за сложни и критични системи. Като следвате най-добрите практики, очертани в това ръководство, можете успешно да внедрите Event Sourcing и да изградите надеждни и подлежащи на одит системи.

Допълнителна литература