- You’re new to tech tools but curious about ways to understand how your computer systems work. Maybe you’ve heard about “observability” and want to see what it’s all about, without getting lost in technical jargon.
- You’re a software developer or work in IT, and while you’re comfortable with computers, you’re new to kubernetes. You’re looking for a clear, step-by-step guide that doesn’t assume you’re already an expert.
- You’re simply interested in Odigos and want to give it a try but don’t have previous experience with CLI. This guide will walk you through the process without assuming any prior knowledge.
If you find this guide too basic for you please refer to the main Quick Start guide article.
Required Tools to Get Started
1. Install Homebrew
Homebrew is a package manager for macOS that simplifies the installation of software packages. We will use Homebrew to install Docker Desktop, KinD (Kubernetes in Docker), and the Odigos CLI. a. Locate and open the Terminal application:- Click on the magnifying glass icon (🔍) in the top right corner of your screen.
- Type “Terminal” into the search bar that appears.
- Click on the Terminal application icon (it looks like a black box with a command prompt ”>_”).
Enter
key.
f. The Terminal will display text as it runs the command. This is normal.
g. If prompted, enter your computer’s password. As you type, no characters will appear – this is a security feature. Press Enter
after typing your password.
h. The installation may take several minutes. It’s complete when you see the command prompt again.
i. After installation, you need to add Homebrew to your PATH. The Terminal will display instructions for this. It typically involves running two commands like these:
2. Install Docker Desktop
Docker Desktop creates a special environment on your computer where Odigos can run. a. In the new Terminal window, copy and paste the following command, then pressEnter
:
- Click on the magnifying glass icon (🔍) in the top right corner of your screen.
- Type “Docker” into the search bar.
- Click on the Docker application icon (it looks like a whale carrying boxes).
OK
.
e. You may see a welcome screen or tutorial from Docker.
f. Docker Desktop will ask you to login or create an account if this is the first time you use it. Follow the instruction to register an account and login to Docker Desktop once you register your account.
g. Wait until you see a green dot next to “Docker Desktop is running” in the Docker Dashboard.
3. Install KinD
Mac users: please avoid using Docker Desktop built-in Kubernetes cluster as it does not support bind propagation.
Enter
:
Setting up the cluster
Now that you have Kind installed, let’s create a Kubernetes cluster:- In the Terminal, copy and paste the following command and press
Enter
:
- Create a new cluster by running:
- Verify that the cluster is running:
Install the demo application
With our Kubernetes cluster running, we’ll now deploy a demo application consisting of 5 microservices written in Go, Java, Python, .NET, and Node.js:- Deploy the application using the following command:
- Verify that all services are running:
- Set up port forwarding to the frontend service:
- Open your web browser and navigate to http://localhost:8080
Setting Up Jaeger as a Destination in Odigos
For this demo, we’ll use Jaeger, a popular open-source tool for tracing in distributed systems. Here’s how to set it up:1. Install Jaeger
a. Open your Terminal application. b. Run the following command to install a lightweight Jaeger instance in your Kubernetes cluster:2. Access the Jaeger UI
a. To access the Jaeger UI, run this command in your terminal:Installing Odigos
1. Install the Odigos CLI tool
The Odigos CLI (Command Line Interface) tool allows you to manage Odigos from the Terminal. a. In the Terminal, copy and paste the following command and pressEnter
:
2. Install Odigos in your test environment
a. In the Terminal, copy and paste the following command and pressEnter
:
3. Open the Odigos control panel
a. In the Terminal, copy and paste the following command and pressEnter
:
Enter
.
d. The Odigos control panel should now open in your browser. It might take a few seconds to load.
4. Set up Odigos
a. In the Odigos control panel, you’ll see a page titled “Select Sources”. Sources are the things Odigos can collect data from. b. Click the checkbox next to each Source you want to monitor. If you’re not sure, you can select all of them. c. Click the blue “Next” button at the bottom right of the page. d. You’ll now see a page titled “Add Destinations”. Destinations are places where Odigos can send its information. e. Click on one of the destination options (for example, “Jaeger”). f. If you’re using “Jaeger”, fill in the following details:- Destination Name: Enter “jaeger-demo” (or any name you prefer)
- Endpoint: Enter “jaeger.tracing”
Next Steps: Building Your First Observability Pipeline
Congratulations! You’ve successfully installed Odigos and set up Jaeger as your observability destination. This is a great first step towards gaining deeper insights into your systems and applications. But the journey doesn’t stop here. Now that you have the foundation in place, it’s time to harness the full power of Odigos by building your first observability pipeline. In the next article, Building a Pipeline, you’ll learn how to:- Configure data sources for your observability pipeline
- Set up data processing and filtering
- Direct your observability data to Jaeger and other potential destinations
- Customize your pipeline to meet your specific needs