multa-metrics / multa-metrics-agent

IoT Agent for system metrics collection and exporting. Runs as a Docker Container and uses the AWS IoT Device SDK to publish results to AWS IoT Cloud.

multa-metrics-agent

• Includes agent code that will deploy in devices. Initially as a Docker container that can be deployed in any Unix-like OS, needs to provide:

Usage

Dockerfile

• Allows to build your own custom agent with the commands:

export VERSION=### && make build && make tag

docker run

• Allows to run Multa Metrics Agent using docker CLI using the command:

docker run -e DEVICE_NAME=${DEVICE_NAME} -e DEVICE_CONFIGURATION_URL=https://cvm-agent.dev.multa.io/multa-agent/ --net=host --restart always --privileged -d --name multa-agent 112646120612.dkr.ecr.us-east-1.amazonaws.com/multa-agent:0.0.1

docker-compose.yml file

• Allows to run Multa Metrics Agent using docker-compose command: docker-compose up

Other deployment methods

Development

• If the container has not been run:
  make build && make tag && {RUN COMMAND}

• After adding some code, for local testing execute if the container is running:
  docker container stop multa-agent && docker container rm multa-agent && make build && make tag && {RUN COMMAND}

• To debug code running in the container:
  docker logs --tail 100 multa-agent

• To cleanup container completely run:
  docker container stop multa-agent && docker container rm multa-agent && docker volume rm device-data

Next features

• Will be updated later to include AWS IoT Device Defender
• Can be later updated ot include AWS Greengrass and make it a truly reporting agent/gateway

multa-metrics-agent's Issues

Add CPU Architecture based Dockerfiles

Project refactor to a Facade Pattern

Add Sentry integration - Dynamic

Allow based on Environment Variables, to enable/disable Sentry Integration and also input the Sentry key

Add RestAPI Server integration

Add Flask or FastAPI integration server

Add Process Maintenance Restart - Dynamic

Allow to enable/disable based on Environment Variables. Allow to set frequency using CRON-like expression with a default every week (Sundays at 1pm)

Add Internet Connection stability handler/tests

Validate how connectivity works when there are changes to:

• Network Settings
• DNS Settings

Validate how connectivity works when there are changes to the Internet Connection when:

• Internet is down for more than 25 minutes and then resumed
• Device is suspended
• Device is rebooted
• Device runs for more than a week

Add Manager Container

Change Multa Agent from docker-compose and instead use manager container. Manager container should allow:

• Start (download) latest Multa Agent using data passed as Environment Variables.
• Add remote controls to Multa Agent Start/Stop/Restart/Remove based on MQTT (API???).
• Add default behavior to download/start Multa Agent if it's not found.
• Add default behavior to start Multa Agent if it's stopped.
• Add version control for Agent Container

Add Websocket Server

Add a WebSocket server that runs in the device localhost by default. Host and port should be customizable. Namespaces should be customizable.

Add synchronization with Multa Metrics device gateway

Add Shootback Tunnel Client/Manager

Add AWS IoT Tunnel Client/Manager

Add Device Defender - Dynamic Integration

Allow to enable/disable AWS IoT Device Defender agent by Environment Variables