https://github.com/tolitius/hface

look your Hazelcast cluster in the face!
https://github.com/tolitius/hface

clojure dashboard hazelcast

Last synced: 3 months ago
JSON representation

look your Hazelcast cluster in the face!

• Host: GitHub
• URL: https://github.com/tolitius/hface
• Owner: tolitius
• License: epl-1.0
• Created: 2015-01-07T21:13:57.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2020-07-26T16:30:15.000Z (over 4 years ago)
• Last Synced: 2024-10-28T13:38:49.420Z (3 months ago)
• Topics: clojure, dashboard, hazelcast
• Language: JavaScript
• Size: 1.49 MB
• Stars: 74
• Watchers: 8
• Forks: 14
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# hface

Hazelcast cluster monitoring and debugging dashboard

- [What do you mean?](#what-do-you-mean)

- [The Gist](#the-gist)

- [Visual](#visual)

  - [ASCII](#ascii)

- [Run it](#run-it)

  - [hface config](#hface-config)

  - [from releases](#from-releases)

  - [from sources](#from-sources)

  - [for pre Hazelcast 4.0](#for-pre-hazelcast-40)

- [License](#license)

## What do you mean?

![hface braindump](https://github.com/tolitius/hface/blob/master/doc/hface-braindump.jpg?raw=true)

## The Gist

`hface` monitors a Hazelcast cluster in real time. It currently supports maps, multimaps and queues.

Support for other distributed data structures is coming.

In order to monitor a remote Hazelcast cluster add an `8K` jar dependency to it:

```clojure

[org.hface/hface-client "0.1.8"]

```

or

```xml

  org.hface

  hface-client

  0.1.8

```

it will be collecting the stats from _all_ the nodes and will be sending these stats to `hface` for aggregation and visual pleasure. Here is [an example](https://github.com/tolitius/hface-server) of a simple Hazelcast server node with an hface client dependency.

## Visual

This is what hface dash currently looks like as it monitors the cluster:

![hface dash](https://github.com/tolitius/hface/blob/master/doc/hface-dash.png?raw=true)

### ASCII

All the stats are also available in JSON via `/stats`:



## Run it

> _for **pre** Hazelcast 4.0+ clusters: hface config and deps are different and to run it follow [this](#for-pre-hazelcast-40)_

### hface config

hface dashboard relies on a small configuraion file that can be pointed to by `-Dconf=path-to-config`. Here is a sample config:

```clojure

{:collector {:refresh-interval 4}     ;; refresh cluster stats every 4 seconds

 :hz-client {:hosts ["127.0.0.1"]     ;; hazelcast cluster hosts/ips

             :cluster-name "dev"}}    ;; cluster name to connect to

```

### from releases

download the hface release from [releases](https://github.com/tolitius/hface/releases) i.e. let's say the version is `0.1.1`:

```

$ wget https://github.com/tolitius/hface/releases/download/v0.1.1/hface-dash-0.1.1.jar

```

run it:

```

$ java -jar -Dconf=/opt/app/hface/hface.conf hface-dash-0.1.1.jar

```

then, for joy, go to [http://localhost:3000/](http://localhost:3000/)

###### _`/opt/app/hface/hface.conf` is a sample path to the config file, replace it with your path_

### from sources

#### get ready

you would need [lein](https://leiningen.org) (if you come from Java think maven) to compile and build a single runnable jar, a.k.a. an uberjar.

lein is straighforward to install: just [download the script](https://leiningen.org/#install) and run it

#### build and run

* clone the repo (e.g. `git clone https://github.com/tolitius/hface.git`)

* `cd hface/dash`

* `lein ring uberjar`

* `java -jar -Dconf=/path-to/hface.conf target/hface-dash.jar`

then, for joy, go to [http://localhost:3000/](http://localhost:3000/)

##### lein version

starting from 2.9.0+ lein brings newer deps that break backwards compatibility as discussed in [this](https://github.com/oakes/Nightlight/issues/53) and [this](https://github.com/tolitius/hface/issues/11) issues. If you experience a problem building hface from sources:

```

$ lein downgrade 2.8.3

$ lein do clean, ring uberjar

```

which will work, and then:

```

$ lein upgrade

```

to bring you back to the latest `lein` version.

### for pre Hazelcast 4.0

In case you are working with a Hazelcast `3.x.x` clusters:

#### hface client

bring `0.1.6` hface client instead of the latest:

```

[org.hface/hface-client "0.1.6"]

```

#### hface config

hface dashboard relies on a small configuraion file that can be pointed to by `-Dconf=path-to-config`. Here is a sample config:

```clojure

{:collector {:refresh-interval 4}                       ;; refresh cluster stats every 4 seconds

 :hz-client {:hosts ["127.0.0.1" "127.0.0.2"]           ;; hazelcast cluster hosts/ips

             :retry-ms 5000                             ;; retry to reconnect in 5 seconds

             :retry-max 720000                          ;; 720000 * 5000 = one hour

             :group-name "dev"                          ;; creds to the cluster (dev/dev-pass are hz defaults)

             :group-password "dev-pass"}}

```

#### from releases

download the hface `0.1.0` release from [releases](https://github.com/tolitius/hface/releases):

```

$ wget https://github.com/tolitius/hface/releases/download/v0.1.0/hface-dash-0.1.0.jar

```

run it:

```

$ java -jar -Dconf=/opt/app/hface/hface.conf hface-dash-0.1.0.jar

```

then, for joy, go to [http://localhost:3000/](http://localhost:3000/)

###### _`/opt/app/hface/hface.conf` is a sample path to the config file, replace it with your path_

## License

Copyright © 2020 tolitius

Distributed under the Eclipse Public License, the same as Clojure.