https://github.com/ouven/akka-visualmailbox

A visualizer for your Akka message flows
https://github.com/ouven/akka-visualmailbox

Last synced: 2 months ago
JSON representation

A visualizer for your Akka message flows

• Host: GitHub
• URL: https://github.com/ouven/akka-visualmailbox
• Owner: ouven
• License: apache-2.0
• Created: 2016-05-21T12:26:58.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-01-16T10:51:59.000Z (about 6 years ago)
• Last Synced: 2024-08-02T05:05:43.988Z (6 months ago)
• Language: Scala
• Homepage:
• Size: 322 KB
• Stars: 150
• Watchers: 6
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# akka-visualmailbox

[![Build Status](https://travis-ci.org/ouven/akka-visualmailbox.svg?branch=master)](https://travis-ci.org/ouven/akka-visualmailbox)

[![Project Score](https://img.shields.io/badge/Project%20Score-%F0%9F%92%A9-brightgreen.svg)](https://img.shields.io)

[![Project Mood](https://img.shields.io/badge/Project%20Mood-%F0%9F%98%84-brightgreen.svg)](https://img.shields.io)

Current version: 1.1.0

This project wants to help you finding hotspots in your Akka application by visualizing your message flows

like it is shown on the next picture. Actors are displayed as nodes, message flows are displayed as arrows.

The thicker an arrow is displayed, the more messages have been sent this way. You can get the actor path by

clicking the nodes. The number shown on a node represents the mailbox size of this actor.   

![sample flow](./sample.png)

## collector

The collector is the component that collects the mailbox data and sends it to the visualization server.

To integrate the collector into your project you just have to add the dependency to your build file 

and set the collector mailbox for the akka default dispatcher.

build.sbt

```sbt

libraryDependencies += "de.aktey.akka.visualmailbox" %% "collector" % "1.1.0"

``` 

application.conf:

```

akka.actor.default-mailbox.mailbox-type = "de.aktey.akka.visualmailbox.VisualMailboxType"

```

It will collect your mailbox data and send it in chunks of 40 data sets or at least every second to the visualization server. 

## visualization

The visualisation component receives the mailbox data at `udp://0.0.0.0:60009`, which can be changed in the application.conf by overriding

```

de.aktey.akka.visualmailbox {

  server {

    address {

      host: "localhost"

      port: 60009

    }

  }

}

```

It servers a web surface at [http://localhost:8080](http://localhost:8080), that renders the messages with vis.js

The web server can be changed to listen at a different interface by overriding in the application.conf

```

de.aktey.akka.visualmailbox {

  web.server {

    address {

      host: "0.0.0.0"

      port: 8080

    }

  }

}

```

It uses the JavaScript keyword "class" and the "EventSource" API, so it is viewable with Chrome

42+ or Firefox 45+. Other browsers I did not try.

### run visualization with sbt

To run the server, you have to have `node.js` and `bower` installed.

To prepare the web part you need to do

```bash

bower install

```

in the project root directory, then

```bash

sbt "project visualization" run

```

to run the server.

### run visualization with docker

There is docker image on [https://hub.docker.com](https://hub.docker.com/r/ouven/akka-visual-mailbox-visualization/).

You can run it with 

```bash

docker run -ti --rm -p 8080:8080 -p 60009:60009/udp ouven/akka-visual-mailbox-visualization

```

## sample-project

The sample project puts it all together, to show the usage and to play arround with pictures. You can run it with

```bash

sbt "project sample-project" run

```

  

## common

The common project contains the protocol and common config stuff.