hazelcast-viewer

View the contents of a Hazelcast instance.

Tested against Hazelcast 3.8.

Run

This project is a Maven-built Spring Boot application, so can be run in many ways:

• With the Application class via an IDE or command line
• With the Maven-built jar file: java -jar target/hazelcast-viewer-<version>.jar
• With Maven: mvn spring-boot:run

Configuration

The default address for the Hazelcast instance to view is localhost:5701, this can be updated by:

• Updating the application.yml file (hazelcast.server.addresses property)
• Providing a hazelcast.server.addresses argument to the Spring Boot application when executing it

These properties support a comma separated list of addresses where a cluster of Hazelcast instances are running and you want to fall back to another node of one is not available.

Endpoints

The following endpoints are available:

• GET /maps - get a list of map names
• GET /maps/{mapName} - get the full contents of a map
• GET /maps/{mapName}/{mapKey} - get a specific entry from a map

Spring Boot actuators are also enabled, so all actuator endpoints are available, authentication for these endpoints is disabled.

Viewing serialized objects

If the Hazelcast instance is storing serialized objects, you can add support for these by adding them as Maven dependencies to this project.

This will allow you view custom Java objects from your project that are stored in Hazelcast.