Skip to content

Commit

Permalink
integration service description
Browse files Browse the repository at this point in the history
  • Loading branch information
jkralik committed Jun 14, 2024
1 parent 3115b9e commit 5eb25b8
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions content/en/docs/features/control-plane/integration-service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: 'Integration Service'
description: 'What is Integration service?'
date: '2024-06-14'
lastmod: '2024-06-14'
categories: [integration service]
keywords: [integration service, streaming events]
weight: 70
---

{{< note >}}

Planned feature.

{{< /note >}}

The Integration Service is a key component of the plgd hub, designed to streamline the flow of event data to various external services. This service enhances connectivity and interoperability by allowing users to define and manage the transmission of events based on specific content and criteria.

#### Key Features

1. **Event Stream Management:**
- Seamlessly stream events from the plgd hub to a wide range of external services.
- Utilize configurable rules to control which events are transmitted and where they are sent.

2. **Advanced Filtration Mechanism:**
- **Device ID:** Filter events based on the unique identifier of the originating device.
- **Href:** Utilize the href attribute to refine event selection.
- **Resource Types:** Specify resource types to target events relevant to particular data types.
- **Event Type:** Differentiate events based on their type to ensure precise data routing.
- **Content Filtering:** Apply jq expressions for advanced content-based filtering to fine-tune the events being sent.

3. **Supported Target Services:**
- **HTTP:** Send events to HTTP endpoints for integration with web services and APIs.
- **NATS:** Use the NATS messaging system for distributed and scalable event streaming.
- **...** (Additional services can be integrated as per requirement).

4. **Dynamic Target Parameters:**
- Define target parameters using templates.
- Incorporate placeholders within templates to dynamically populate values from the event content, ensuring accurate and contextually relevant data delivery.

#### Benefits

- **Customizable Event Routing:** Tailor the event routing rules to meet specific application needs, ensuring only relevant data reaches the target services.
- **Scalability:** Integrate with multiple external services and scale event handling as your system grows.
- **Enhanced Data Control:** Maintain granular control over data flow with robust filtering options, enhancing both security and efficiency.
- **Flexibility:** The template-based approach for target parameters ensures flexibility and adaptability to various external service requirements.

The Integration Service is an essential tool for developers and system integrators looking to enhance their event-driven architectures with precise, rule-based event streaming capabilities.

0 comments on commit 5eb25b8

Please sign in to comment.