Skip to content

Commit 02f1d94

Browse files
authored
microservices: Added the arch diagram for time series analytics microservice
Added the arch diagram for time series analytics microservice with the details on the workflow Signed-off-by: Vinod K B <vinod.k.b@intel.com>
1 parent dd9f74f commit 02f1d94

3 files changed

Lines changed: 19 additions & 1 deletion

File tree

microservices/time-series-analytics/docs/user-guide/Overview.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,25 @@ For more information on creating custom UDFs, see the [Kapacitor Anomaly Detecti
1818

1919
## High-Level Architecture
2020

21-
WORK IN PROGRESS
21+
![Time Series Analytics Microservice High Level Architecture](_images/Time-Series-Analytics-Microservice-Architecture.png)
22+
23+
As seen in the architecture diagram, the `Time Series Analytics` microservice can take input data from various sources.
24+
The input data that this microservice takes can be broadly divided into two:
25+
1. **Input payload and configuration management via REST APIs**
26+
a. REST clients sending the data in JSON format
27+
b. Telegraf services sending the data in line protocol format
28+
2. **UDF deployment package** (comprises of UDF, TICKScripts, models)
29+
a. Through Volume mounts OR docker cp OR kubectl cp command
30+
b. Pulling the UDF deployment package from the Model Registry microservice
31+
32+
As a default flow, we have sample temperature simulator to ingest data in JSON format and have pre-packaged simple process based User Defined Function (UDF) in `Time Series Analytics` microservice to flag the temperature
33+
points if they don't fall under a range as anomalies. The output is seen in the logs of the microservice now.
34+
35+
For understanding the other ways of ingesting data, UDF deployment package configuration, publishing alerts and writing data back to InfluxDB via TICKScripts, please refer the following docs of Wind Turbine Sample app:
36+
- [Overview.md](https://github.com/open-edge-platform/edge-ai-suites/tree/main/manufacturing-ai-suite/wind-turbine-anomaly-detection/docs/user-guide/Overview.md)
37+
- [Getting Started](https://github.com/open-edge-platform/edge-ai-suites/tree/main/manufacturing-ai-suite/wind-turbine-anomaly-detection/docs/user-guide/get-started.md)
38+
- [How to configure alerts](https://github.com/open-edge-platform/edge-ai-suites/tree/main/manufacturing-ai-suite/wind-turbine-anomaly-detection/docs/user-guide/how-to-configure-alerts.md)
39+
- [How to configure custom UDF](https://github.com/open-edge-platform/edge-ai-suites/tree/main/manufacturing-ai-suite/wind-turbine-anomaly-detection/docs/user-guide/how-to-configure-custom-udf.md)
2240

2341
---
2442

82.6 KB
Loading
Binary file not shown.

0 commit comments

Comments
 (0)