View source for Metropolis Microservices/RidgeRun Services/Engagement Analytics

<noinclude>
{{Metropolis Microservices/Head
|previous=https://developer.ridgerun.com/wiki/index.php/Metropolis_Microservices/RidgeRun Services/Display
|next=https://developer.ridgerun.com/wiki/index.php/Metropolis_Microservices/RidgeRun Services/Media
|title=RidgeRun Engagement Analytics Microservice
|description=This page provides a general overview of the Engagement Analytics RidgeRun Service
}}
</noinclude>

RidgeRun's Engagement Analytics Service is in charge of managing people engagement statistics. It reads detection/direction messages from Redis and based on the given configuration it calculates the person engagement and then posts statistics in both Redis and InfluxDB. It also calculates a heatmap of engaged people's locations and posts it as a redis stream.

The following picture shows a basic diagram of the service

[[File:MicroservicesArchitecture-EngagementAnalytics.png|800px|thumb|center]]

The service can be configured using a configuration file or via REST API.

{{message|title='''TL;DR'''
  |content=
You can run this microservice with the following command:

<syntaxhighlight lang="bash">
docker run -it --rm \
--network host \
--volume <path to directory containing your configuration file>:/configs \
-e INFLUXDB_TOKEN=<your influx db token> \
--name engagement-analytics-service  \
ridgerun/engagement-analytics-service:latest  \
--host 0.0.0.0 \
--config-file /configs/<your configuration file name> \
--retry
</syntaxhighlight>

This will run the Engagement Analytics service in localhost using port 5053. Make the correct path to your configuration file and the proper configuration file name.
}}

{{message|type=doc
  |content=
* [https://ridgerun.github.io/engagement-analytics-service/Service Documentation]
* [https://ridgerun.github.io/engagement-analytics-service/api.html Api Documentation]
<br>
See [[Metropolis Microservices/Tools/API Usage|API Usage]] for an example of how to use the API documentation to control the service
}}