Digma Continuous Feedback

A frontend React app that communicates with the backend container and displays data in Docker Desktop.
A backend container that runs an Digma API gateway in Node.js.

Local development

You can use docker to build, install and push your extension. Also, there is opinionated Makefile that could be convenient for you. There isn't a strong preference of using one over the other, so just use the one you're most comfortable with.

To build the extension, use make build-extension or:

  docker buildx build -t digma-ai/digma-docker-extension:latest . --load

To install the extension, use make install-extension or:

  docker extension install digma-ai/digma-docker-extension:latest

If you want to automate this command, use the -f or --force flag to accept the warning message.

To preview the extension in Docker Desktop, open Docker Dashboard once the installation is complete. The left-hand menu displays a new tab with the name of your extension. You can also use docker extension ls to see that the extension has been installed successfully.

Frontend development

During the development of the frontend part, it's helpful to use hot reloading to test your changes without rebuilding your entire extension. To do this, you can configure Docker Desktop to load your UI from a development server. Assuming your app runs on the default port, start your UI app and then run:

  cd ui
  npm install
  npm run dev

This starts a development server that listens on port 3000.

You can now tell Docker Desktop to use this as the frontend source. In another terminal run:

  docker extension dev ui-source digma-ai/digma-docker-extension:latest http://localhost:3000

In order to open the Chrome Dev Tools for your extension when you click on the extension tab, run:

  docker extension dev debug digma-ai/digma-docker-extension:latest

Each subsequent click on the extension tab will also open Chrome Dev Tools. To stop this behaviour, run:

  docker extension dev reset digma-ai/digma-docker-extension:latest

Backend development

Digma extension defines an API in Node.js that is deployed as a backend container when the extension is installed. The extension frameworks provides connectivity from the extension UI to a socket that the backend has to connect to on the server side.

Whenever you make changes in the backend source code, you will need to compile them and re-deploy a new version of your backend container. Use the docker extension update command to remove and re-install the extension automatically:

docker extension update digma-ai/digma-docker-extension:latest

If you want to automate this command, use the -f or --force flag to accept the warning message. Extension containers are hidden from the Docker Dashboard by default. You can change this in Settings > Extensions > Show Docker Extensions system containers.

Clean up

To remove the extension:

docker extension rm digma-ai/digma-docker-extension:latest