Skip to content

Latest commit

 

History

History
172 lines (124 loc) · 5.64 KB

README.md

File metadata and controls

172 lines (124 loc) · 5.64 KB
Raw

Pillarbox Monitoring Transfer

Pillarbox logo

Pillarbox Monitoring Transfer is a Kotlin-based Spring Boot service that connects to the Pillarbox Monitoring Event Dispatcher SSE (Server-Sent Events) endpoint and publishes the received events to an OpenSearch storage. This facilitates the collection and analysis of monitoring events from clients, enabling data visualization and insights through tools like Grafana.

Quick Guide

Prerequisites and Requirements

  • JDK 22 or higher
  • Docker (optional)

Setup

  1. Build the Application:

    ./gradlew clean build -x test

  2. Run the Application:

  • Using Gradle: 
    ./gradlew bootRun
  • Or, using the built JAR: 
    java -jar build/libs/pillarbox-monitoring-transfer.jar
  1. Configuration: The application can be configured using environment variables: 
    export PILLARBOX_MONITORING_OPENSEARCH_URI=http://opensearch:9200
export PILLARBOX_MONITORING_DISPATCH_URI=http://event-dispatcher:8080/events

Running with Docker

Alternatively, you can build and run the application using Docker:

  1. Build the Docker Image:

    docker build -t pillarbox-monitoring-transfer .

  2. Run the Docker Container:

    docker run -p 8081:8081 \
           -e PILLARBOX_MONITORING_OPENSEARCH_URI=http://opensearch:9200 \
           -e PILLARBOX_MONITORING_DISPATCH_URI=http://event-dispatcher:8080/events \
           pillarbox-monitoring-transfer

Documentation

This project is a Kotlin-based Spring Boot application designed to connect to a Server-Sent Events ( SSE) endpoint, process incoming events, and store data in an OpenSearch index.

It leverages Spring Boot's reactive WebFlux framework and integrates custom health indicators using Spring Boot Actuator to provide insights into application performance.

System Flow Overview

The main loop of this service is illustrated in the following diagram:

sequenceDiagram
  participant DataTransfer
  participant SSEEndpoint
  participant LockManager
  participant OpenSearch
  DataTransfer ->> OpenSearch: Initialize index
  DataTransfer ->> SSEEndpoint: Connects and listens to events
  loop Listen for events
    SSEEndpoint --) DataTransfer: Send Event
    DataTransfer ->> LockManager: Acquire session lock
    DataTransfer ->> OpenSearch: Store event
    DataTransfer -->> LockManager: Release session lock
  end
Loading

Key Components

Below is an overview of the most important classes that handle the core responsibilities of the system:

  • PillarboxDataTransferApplication.kt: The main entry point of the application that bootstraps and configures the service.
  • BenchmarkHealthIndicator.kt: Monitors the performance of key operations, providing real-time health metrics for the application.
  • LockManager.kt: Ensures concurrency control by managing locks for different sessions, enabling thread-safe operations.
  • SetupService.kt: Manages the initial setup of the OpenSearch index and the application’s configuration for SSE processing.
  • SseClient.kt: Listens to the SSE endpoint, handling incoming events and managing retries in case of connection failures.

Here’s a more concise description of the GitHub Actions setup without listing the steps:

Continuous Integration

This project automates its own development workflow using GitHub Actions:

  1. Quality Check for Pull Requests Triggered on every pull request to the main branch, this workflow ensures the code passes static analysis and unit tests.

  2. Release Workflow When changes are pushed to main, this workflow handles versioning and releases with semantic-release. It automatically bumps the version, generates release notes, creates a tag, and publishes a Docker image to Amazon ECR. This new version is automatically deployed to the development environment.

  3. Production deployment To deploy a specific version to production, manually trigger the Promote Version to Stable workflow from the Actions tab, inputting the desired version number (e.g., 1.0.0). This workflow tags the selected version as stable in the ECR, and forces a new deployment on ECS.

Contributing

Contributions are welcome! If you'd like to contribute, please follow the project's code style and linting rules. Here are some commands to help you get started:

Check your code style:

./gradlew ktlintCheck

You can try an automatically apply the style by running:

./gradlew ktlintFormat

Detect potential issues:

./gradlew detekt

All commits must follow the Conventional Commits format to ensure compatibility with our automated release system. A pre-commit hook is available to validate commit messages.

You can set up hook to automate these checks before commiting and pushing your changes, to do so update the Git hooks path:

git config core.hooksPath .githooks/

Refer to our Contribution Guide for more detailed information.

License

This project is licensed under the MIT License.