{"id":19345922,"url":"https://github.com/tolitius/hface","last_synced_at":"2025-10-29T01:09:48.684Z","repository":{"id":25503048,"uuid":"28934425","full_name":"tolitius/hface","owner":"tolitius","description":"look your Hazelcast cluster in the face!","archived":false,"fork":false,"pushed_at":"2020-07-26T16:30:15.000Z","size":1559,"stargazers_count":72,"open_issues_count":12,"forks_count":14,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-12T11:43:16.482Z","etag":null,"topics":["clojure","dashboard","hazelcast"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"epl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tolitius.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-01-07T21:13:57.000Z","updated_at":"2025-04-06T07:13:37.000Z","dependencies_parsed_at":"2022-08-01T05:18:08.989Z","dependency_job_id":null,"html_url":"https://github.com/tolitius/hface","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tolitius%2Fhface","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tolitius%2Fhface/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tolitius%2Fhface/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tolitius%2Fhface/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tolitius","download_url":"https://codeload.github.com/tolitius/hface/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250372495,"owners_count":21419719,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clojure","dashboard","hazelcast"],"created_at":"2024-11-10T04:08:22.022Z","updated_at":"2025-10-29T01:09:48.583Z","avatar_url":"https://github.com/tolitius.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hface\n\nHazelcast cluster monitoring and debugging dashboard\n\n- [What do you mean?](#what-do-you-mean)\n- [The Gist](#the-gist)\n- [Visual](#visual)\n  - [ASCII](#ascii)\n- [Run it](#run-it)\n  - [hface config](#hface-config)\n  - [from releases](#from-releases)\n  - [from sources](#from-sources)\n  - [for pre Hazelcast 4.0](#for-pre-hazelcast-40)\n- [License](#license)\n\n## What do you mean?\n\n![hface braindump](https://github.com/tolitius/hface/blob/master/doc/hface-braindump.jpg?raw=true)\n\n## The Gist\n\n`hface` monitors a Hazelcast cluster in real time. It currently supports maps, multimaps and queues.\nSupport for other distributed data structures is coming.\n\nIn order to monitor a remote Hazelcast cluster add an `8K` jar dependency to it:\n\n```clojure\n[org.hface/hface-client \"0.1.8\"]\n```\n\nor\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003eorg.hface\u003c/groupId\u003e\n  \u003cartifactId\u003ehface-client\u003c/artifactId\u003e\n  \u003cversion\u003e0.1.8\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nit 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.\n\n## Visual\n\nThis is what hface dash currently looks like as it monitors the cluster:\n\n![hface dash](https://github.com/tolitius/hface/blob/master/doc/hface-dash.png?raw=true)\n\n### ASCII\n\nAll the stats are also available in JSON via `/stats`:\n\n\u003cimg alt=\"Hazelcast cluster stats\" width=\"35%\" src=\"https://raw.githubusercontent.com/tolitius/hface/master/doc/stats.json.png?raw=true\"/\u003e\n\n## Run it\n\n\u003e _for **pre** Hazelcast 4.0+ clusters: hface config and deps are different and to run it follow [this](#for-pre-hazelcast-40)_\n\n### hface config\n\nhface dashboard relies on a small configuraion file that can be pointed to by `-Dconf=path-to-config`. Here is a sample config:\n\n```clojure\n{:collector {:refresh-interval 4}     ;; refresh cluster stats every 4 seconds\n :hz-client {:hosts [\"127.0.0.1\"]     ;; hazelcast cluster hosts/ips\n             :cluster-name \"dev\"}}    ;; cluster name to connect to\n```\n\n### from releases\n\ndownload the hface release from [releases](https://github.com/tolitius/hface/releases) i.e. let's say the version is `0.1.1`:\n\n```\n$ wget https://github.com/tolitius/hface/releases/download/v0.1.1/hface-dash-0.1.1.jar\n```\n\nrun it:\n\n```\n$ java -jar -Dconf=/opt/app/hface/hface.conf hface-dash-0.1.1.jar\n```\n\nthen, for joy, go to [http://localhost:3000/](http://localhost:3000/)\n\n###### _`/opt/app/hface/hface.conf` is a sample path to the config file, replace it with your path_\n\n### from sources\n\n#### get ready\n\nyou 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.\n\nlein is straighforward to install: just [download the script](https://leiningen.org/#install) and run it\n\n#### build and run\n\n* clone the repo (e.g. `git clone https://github.com/tolitius/hface.git`)\n* `cd hface/dash`\n* `lein ring uberjar`\n* `java -jar -Dconf=/path-to/hface.conf target/hface-dash.jar`\n\nthen, for joy, go to [http://localhost:3000/](http://localhost:3000/)\n\n##### lein version\n\nstarting 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:\n\n```\n$ lein downgrade 2.8.3\n$ lein do clean, ring uberjar\n```\nwhich will work, and then:\n```\n$ lein upgrade\n```\nto bring you back to the latest `lein` version.\n\n### for pre Hazelcast 4.0\n\nIn case you are working with a Hazelcast `3.x.x` clusters:\n\n#### hface client\n\nbring `0.1.6` hface client instead of the latest:\n\n```\n[org.hface/hface-client \"0.1.6\"]\n```\n\n#### hface config\n\nhface dashboard relies on a small configuraion file that can be pointed to by `-Dconf=path-to-config`. Here is a sample config:\n\n```clojure\n{:collector {:refresh-interval 4}                       ;; refresh cluster stats every 4 seconds\n :hz-client {:hosts [\"127.0.0.1\" \"127.0.0.2\"]           ;; hazelcast cluster hosts/ips\n             :retry-ms 5000                             ;; retry to reconnect in 5 seconds\n             :retry-max 720000                          ;; 720000 * 5000 = one hour\n             :group-name \"dev\"                          ;; creds to the cluster (dev/dev-pass are hz defaults)\n             :group-password \"dev-pass\"}}\n```\n#### from releases\n\ndownload the hface `0.1.0` release from [releases](https://github.com/tolitius/hface/releases):\n\n```\n$ wget https://github.com/tolitius/hface/releases/download/v0.1.0/hface-dash-0.1.0.jar\n```\n\nrun it:\n\n```\n$ java -jar -Dconf=/opt/app/hface/hface.conf hface-dash-0.1.0.jar\n```\n\nthen, for joy, go to [http://localhost:3000/](http://localhost:3000/)\n\n###### _`/opt/app/hface/hface.conf` is a sample path to the config file, replace it with your path_\n\n## License\n\nCopyright © 2020 tolitius\n\nDistributed under the Eclipse Public License, the same as Clojure.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftolitius%2Fhface","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftolitius%2Fhface","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftolitius%2Fhface/lists"}