-
Notifications
You must be signed in to change notification settings - Fork 4
Tutorial 1: First Steps with ChronoLog
Welcome to ChronoLog! We’re so excited to have you here. ChronoLog is a powerful open-source project, proudly funded by the NSF, that aims to make managing and processing log data simple, scalable, and high-performance. Whether you’re working with edge computing or high-performance computing (HPC) systems, ChronoLog has got your back. Let’s dive in and get you up and running in no time!
Imagine you have a flood of data coming at you from all directions: activities, events, logs — all the stuff you need to make sense of. ChronoLog steps in as your superhero, a distributed shared log store designed to:
- Scale effortlessly to handle huge volumes of data.
- Deliver blazing-fast performance.
- Adapt to a wide variety of use cases.
From edge devices to massive HPC systems, ChronoLog ensures you have a reliable and efficient way to organize and analyze your data. Sounds cool, right? Let’s get you started with your very first ChronoLog setup!
We’ve made sure to keep the setup as straightforward as possible. Just follow these steps, and you’ll be ready to roll!
Before you begin, make sure you have the following installed on your system:
- Git – Required for cloning the ChronoLog repository. Install it with:
sudo apt install git # Debian/Ubuntu - g++ – The GNU C++ compiler is needed to build ChronoLog. Install it with:
sudo apt install g++ # Debian/Ubuntu Once these are installed, you're ready to move on to setting up ChronoLog!
First, let’s grab the ChronoLog repository. Open your terminal on the desired folder and run:
git clone https://github.com/grc-iit/ChronoLog.gitThis will download the project to your local machine. Now you’ve got all the code you need!
Spack is an awesome tool for managing software builds. To get Spack, run:
git clone --branch v0.21.2 https://github.com/spack/spack.git
source /path-to-where-spack-was-cloned/spack/share/spack/setup-env.shOnce it’s installed, you’re one step closer to launching ChronoLog.
Navigate to the “deploy” folder inside the ChronoLog repository:
cd /path-to-repo/deployReplace /path-to-repo/ with the actual path to where you cloned the ChronoLog repository.
It’s time to build ChronoLog. In the deploy folder, run:
./local_single_user_deploy.sh -b -t DebugThis will compile the project in Debug mode. Don’t worry if it takes a little while; ChronoLog is getting ready to do big things!
Now, let’s install ChronoLog to your local machine. Run:
./local_single_user_deploy.sh -i -w /home/$USER/chronolog/DebugThis sets up ChronoLog in a local directory so you can use it.
You’re almost there! To deploy ChronoLog, simply run:
./local_single_user_deploy.sh -d -w /home/$USER/chronolog/DebugChronoLog is now deployed and ready for action.
Let’s make sure everything is running smoothly. Use this command to verify:
pgrep -laf "chronovisor_server|chrono_grapher|chrono_keeper|chrono_player"If you see 4 processes like the ones listed on the command, congratulations! ChronoLog is successfully installed and deployed on your system. You’re ready to start exploring its capabilities.
Now that you’ve got ChronoLog installed and deployed, it’s time to explore its capabilities with the Interactive Client Admin. This tool lets you interact with the ChronoLog system in real time, and it’s perfect for getting hands-on experience.
Let’s fire up the interactive client! Open your terminal, navigate to the /bin directory on the location where ChronoLog is installed, and run:
client_admin -i ../conf/visor_conf.jsonThis will launch the interactive interface, where you can manage Chronicles, Stories, and Events directly.
Chronicles are the core of ChronoLog’s architecture. To create a Chronicle, simply type:
-c my_chronicleThis creates a new Chronicle named my_chronicle. Feel free to replace my_chronicle with a name of your choice.
Stories are individual data streams within a Chronicle. Story needs to be acquired before being accessed. To acquire a Story, type:
-a -s my_chronicle my_storyThis creates a Story named my_story in the Chronicle my_chronicle. Now you’re ready to start logging events!
Events are the data payloads stored in a Story. To write an event, type:
-w "This is my first event in ChronoLog!"Replace the text inside the quotation marks with your own message. Each event you write is logged in real time.
Once you’ve finished working with a Story, release it. Story needs to be released for peaceful and safety close. To do so:
-q -s my_chronicle my_storyThis frees up resources while keeping the data intact.
If you no longer need a Story or Chronicle, you can delete them. You can remove them by detroying them:
- To destroy a Story:
-d -s my_chronicle my_story
- To destroy a Chronicle:
-d -c my_chronicle
Warning: This action is irreversible, so make sure you no longer need the data before proceeding!
When you’re done exploring, safely disconnect from the server by typing:
-disconnectNow that you’ve set up ChronoLog, you’re all set to explore its powerful features. Keep an eye out for our next tutorial, where we’ll guide you through running your first ChronoLog application and uncovering the magic it can bring to your data workflows.
Welcome to the ChronoLog community — we can’t wait to see what you’ll build!