Merge pull request #1 from sampathshivakumar/jaeger

Added new blog post: understanding-jaeger-a-guide-to-distributed-trac…
openobserve · Nov 6, 2024 · 7490565 · 7490565
2 parents a4a64c4 + 4721c43
commit 7490565
Showing 1 changed file with 281 additions and 0 deletions.
diff --git a/...understanding-jaeger-a-guide-to-distributed-tracing-for-beginners-to-experts.md b/...understanding-jaeger-a-guide-to-distributed-tracing-for-beginners-to-experts.md
@@ -0,0 +1,281 @@
+---
+title: 'Understanding Jaeger: A Guide to Distributed Tracing for Beginners to Experts'
+seoTitle: 'Jaeger Distributed Tracing Guide: From Beginner to Expert'
+description: Discover the essential guide to Jaeger and learn how distributed tracing can elevate your modern applications. Ideal for DevOps professionals and developers, this guide unlocks insights for better performance, troubleshooting, and system optimization.
+img: /img/blog/Jaeger_blog/1-home.gif
+alt: Home page banner for blog on Jaeger and distributed tracing insights
+slug: understanding-jaeger-a-guide-to-distributed-tracing-for-beginners-to-experts
+authors: 
+  - Sampath
+publishDate: 2024-11-06
+tags:
+  - Jaeger
+  - openobserve
+  - Distributed Tracing
+  - observability
+  - Microservices
+  - Tracing Tools
+  - HotROD
+---
+
+
+As software systems evolve, they become increasingly complex, especially with the rise of microservices and distributed architectures. Keeping track of what's happening across different services can quickly become a daunting task. Tracing tools like Jaeger have emerged as essential solutions for debugging and monitoring distributed applications, helping developers understand and optimise their systems.
+
+### In this blog, we will cover:
+1. The Pillars of Observability
+2. Background on Distributed Tracing
+3. What Is Jaeger?
+4. How Jaeger Works: Key Concepts and Components
+5. How Jaeger Collects and Visualizes Traces
+6. Getting Started with Jaeger
+7. Getting Started with OpenObserve
+8. Jaeger vs. OpenObserve
+9. Conclusion.
+10. Real-World Case Study: Jidu’s Journey to 100% Tracing Fidelity
+
+### Prerequisites:
+- A running Docker instance with admin access.
+- An OpenObserve instance or cloud account ready to receive logs.
+
+## The Pillars of Observability
+To truly understand Jaeger, it’s vital to grasp the concept of observability. Observability allows us to infer the internal states of systems through their outputs, and it primarily revolves around three pillars:
+- **Logging:** Capturing individual events or errors.
+- **Metrics:** Quantifying system performance and resource usage.
+- **Tracing:** Visualizing request paths and measuring latency across services.
+While logging and metrics provide critical insights, distributed tracing complements them by offering context on how different services interact and depend on one another.
+
+
+## Background on Distributed Tracing
+Before we dive into Jaeger, it’s essential to understand the concept of distributed tracing and why it’s crucial in microservices environments.
+
+### What is Distributed Tracing?
+Distributed tracing is a methodology used to track and analyze requests as they traverse through various services in a distributed system. It helps in visualizing the journey of a request, from the initial entry point all the way to the final response.
+
+E.g. Service A → Service B → Service C → Service D
+### Why is Distributed Tracing Important?
+In monolithic applications, tracing and debugging are straightforward. However, modern applications often depend on multiple microservices communicating over networks, complicating the identification of delays or failures.
+
+Logging alone can’t capture complex dependencies or detect bottlenecks. Distributed tracing tools like Jaeger provide end-to-end visibility of requests, capturing metadata at each step, which helps developers:
+- Trace requests across services
+- Visualise service dependencies and interactions
+- Identify performance bottlenecks
+- Quickly troubleshoot issues by pinpointing problematic services
+
+## What Is Jaeger?
+Jaeger is an open-source, end-to-end distributed tracing tool originally developed by Uber Technologies. Now part of the CNCF (Cloud Native Computing Foundation), Jaeger allows developers to trace requests as they propagate through distributed systems, providing insights into service behavior and performance bottlenecks.
+
+With Jaeger, you can:
+- Track request latency and identify services contributing to slow response times
+- Monitor errors and investigate the root cause of failures across services
+- Visualise dependency graphs for services to understand relationships and interactions
+- Optimise performance by identifying and removing bottlenecks
+
+Jaeger is widely adopted due to its powerful tracing capabilities, ease of use, and integration with other monitoring tools in the observability stack.
+
+## How Jaeger Works: Key Concepts and Components
+
+![jaeger_architecture](/img/blog/Jaeger_blog/1_arc.png)
+![jaeger_architecture](/img/blog/Jaeger_blog/2_arc.png)
+Jaeger traces requests as they travel through various services in a distributed system. It captures information about each service’s interaction, which helps in pinpointing issues. Let’s break down the primary components of Jaeger to understand its functioning:
+
+### Spans and Traces:
+- **Span:** A span represents a single unit of work within a trace, capturing details like start time, duration, and any metadata or tags. Each span represents a single service call or action in the overall trace.
+- **Trace:** A trace represents the entire journey of a request across multiple spans. For instance, when a user makes a request to an application, a trace records the entire sequence, from the front end to each microservice involved.
+![jaeger_trace](/img/blog/Jaeger_blog/trace.png)
+
+This screenshot is from the HOT Commerce project by OpenObserve, which demonstrates tracing across microservices. For more details, visit the project on [GitHub here.](https://github.com/openobserve/hotcommerce/)
+#### Trace Analysis:
+In the image above, each line represents a span—a single operation within the overall trace, showing the journey of a request across services:
+
+- **Trace:** The set of spans forms the trace, covering services like frontend, shop, product, review, and price.
+- **Longest Span:** The frontend service takes the longest time at 2.53 seconds.
+- **Shortest Span:** The request handler completes in just 27.00 microseconds (µs).
+- **Total Spans:** There are 15 spans, each representing a unit of work, such as middleware processing, database calls, and service interactions.
+
+This breakdown shows how the request interacts with multiple services and highlights areas for potential optimization.
+
+### Jaeger Client:
+- Jaeger clients are libraries that you embed in your application code to instrument services and collect tracing data. These clients generate spans and traces, sending them to a collector for storage and analysis.
+
+- Alternatively, instead of using the Jaeger-specific client, you can also use OpenTelemetry (OTel) SDKs for instrumentation. OpenTelemetry is a vendor-neutral observability framework that can work with multiple tracing backends, including Jaeger. Using OTel SDKs allows flexibility to switch or integrate with other observability tools.
+
+### Agent:
+- The Jaeger agent is a lightweight daemon running alongside the application. It receives traces emitted by the client and batches them for efficient transmission to the collector.
+
+- Alternatively, the OpenTelemetry Collector can be used as an alternative to the Jaeger Agent. The OTel Collector is a versatile tool that not only receives, processes, and exports tracing data but can also handle metrics and logs. It can send data to multiple observability backends, making it a flexible choice for distributed tracing setups.
+
+### Collector:
+- The Jaeger collector receives traces from agents and stores them in a backend. It also performs any preprocessing or filtering needed for the traces before they are stored.
+
+- In OpenTelemetry-based setups, the OTel Collector can handle this role as well, offering additional features like data transformation and routing, which make it ideal for complex or multi-backend environments.
+
+### Query Service and UI:
+- Jaeger provides a UI for querying and visualising traces. Through this UI, developers can search for traces, identify latency bottlenecks, and visualise service dependencies and call hierarchies.
+
+### Storage Backend:
+- Jaeger supports various storage backends like Cassandra, Elasticsearch, or even local files for persistence. This allows you to store traces for later analysis and comparisons.
+
+## How Jaeger Collects and Visualizes Traces
+When a user request enters a service, the Jaeger client library starts a trace, generating a unique trace ID for that request. As the request flows through different services, the trace ID propagates along, with each service generating a span representing its part of the work. These spans are sent to the Jaeger agent and ultimately stored in the backend.
+
+The Jaeger UI allows you to visualise traces in a timeline view, making it easier to observe the sequence of events and locate bottlenecks. The UI also provides a service dependency graph that shows the relationships between services, allowing you to monitor dependencies and the overall health of your system.
+
+## Getting Started with Jaeger
+Here’s a quick guide to setting up Jaeger in your environment. We'll use Docker to deploy Jaeger and assume you have Docker installed.
+For a complete setup guide, refer to the [Jaeger Getting Started Documentation.](https://www.jaegertracing.io/docs/1.62/getting-started/)
+
+### Step 1: Deploy Jaeger with Docker
+Jaeger offers an all-in-one image for testing and development purposes. To start the Jaeger all-in-one container, run the following command:
+```
+docker run --rm --name jaeger \
+  -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
+  -p 6831:6831/udp \
+  -p 6832:6832/udp \
+  -p 5778:5778 \
+  -p 16686:16686 \
+  -p 4317:4317 \
+  -p 4318:4318 \
+  -p 14250:14250 \
+  -p 14268:14268 \
+  -p 14269:14269 \
+  -p 9411:9411 \
+  jaegertracing/all-in-one:1.62.0
+```
+The above command runs the Jaeger all-in-one Docker container, which is useful for testing and development. It exposes the following ports:
+- **6831/udp & 6832/udp:** Receive trace data from Jaeger agents.
+- **5778:** Agent configuration HTTP endpoint.
+- **16686:** Jaeger Query UI for viewing and searching traces.
+- **4317:** OpenTelemetry gRPC endpoint for tracing data.
+- **4318:** OpenTelemetry HTTP endpoint for tracing data.
+- **14250:** gRPC endpoint for the Jaeger collector.
+- **14268:** HTTP endpoint for the collector to receive traces.
+- **14269:** Health check endpoint for the collector.
+- **9411:** Zipkin-compatible endpoint for receiving data.
+
+**Note:** This setup uses memory as the default backend storage, which is intended for short-term use and is not recommended for production due to the lack of persistence.
+
+You can access the Jaeger UI at **http://localhost:16686**, to visualise and interact with the traces collected.
+![jaeger_UI](/img/blog/Jaeger_blog/2-getting-started.jpg)
+
+### Step 2: Instrument the HotROD Sample Application
+Next, we'll instrument the HotROD sample application to work with Jaeger for distributed tracing.
+
+#### What is HotROD?
+HotROD is a microservices application simulating a ride-hailing service, similar to Uber or Lyft. It consists of multiple services, such as ride management and driver management, making it an ideal example for demonstrating distributed tracing in a microservices architecture.
+
+To run the HotROD application alongside Jaeger, use the following Docker command:
+```
+docker run --rm -it --link jaeger \
+  -p8080-8083:8080-8083 \
+  -e OTEL_EXPORTER_OTLP_ENDPOINT="http://jaeger:4318" \
+  jaegertracing/example-hotrod:1.62.0 \
+  all --otel-exporter=otlp
+```
+The above command will run the HotROD sample application in a Docker container, linking it to the Jaeger container. It will expose ports 8080 to 8083 on the host for accessing the HotROD services. The application is configured to send tracing data to Jaeger via the OpenTelemetry Protocol (OTLP) at the specified endpoint.
+
+You can access the HotROD UI at **http://localhost:8080**
+![hotrod_UI](/img/blog/Jaeger_blog/3-hotrod.jpg)
+
+### Step 3: View Traces in Jaeger UI
+Once your application is instrumented, run a few requests to generate some traces. 
+![hotrod_UI_clicks](/img/blog/Jaeger_blog/4-clicks.gif)
+
+Then, navigate to **http://localhost:16686**, where you can query traces, visualise the flow of requests, and see latency and dependency data.
+![jeager_UI_1](/img/blog/Jaeger_blog/5-app.gif)
+
+## Getting Started with OpenObserve
+Now, let’s guide you through the setup of OpenObserve using Docker for deployment.
+For a detailed setup guide, you can refer to the [OpenObserve Quickstart Documentation.](https://openobserve.ai/docs/quickstart/#openobserve-cloud/)
+
+### Step 1: Deploy OpenObserve with Docker
+OpenObserve provides a Docker image for easy deployment. To start using OpenObserve, run the following command:
+```
+docker run \
+    --name openobserve \
+    -v $PWD/data:/data \
+    -e ZO_DATA_DIR="/data" \
+    -p 5080:5080 \
+    -e ZO_ROOT_USER_EMAIL="[email protected]" \
+    -e ZO_ROOT_USER_PASSWORD="Complexpass#123" \
+    public.ecr.aws/zinclabs/openobserve:latest
+```
+The command will start an OpenObserve Docker container named openobserve, with the following configurations:
+- **Persistent Storage:** Maps the local directory $PWD/data to the container's /data directory.
+- **Authentication:** Sets the root user email and password for the OpenObserve interface.
+- **Port Exposure:** Exposes port 5080 for external access to the OpenObserve web application.
+
+You can access the OpenObserve UI at **http://localhost:5080** to visualise and interact with your observability data.
+![O2_login_page](/img/blog/Jaeger_blog/5-o2-login.jpg)
+
+log in with the following credentials
+- **user email:** [email protected]
+- **Password:** Complexpass#123
+![O2_login](/img/blog/Jaeger_blog/6-login.gif)
+
+### Step 2: Instrument the HotROD Sample Application
+Run the following command to configure the HotROD sample app to send tracing data to OpenObserve (O2). Replace placeholders with the correct values from your OpenObserve setup.
+```
+docker run \
+  --rm \
+  --link <O2_CONTAINER_NAME> \ 
+  --env OTEL_EXPORTER_OTLP_ENDPOINT=<O2_ENDPOINT> \ 
+  --env OTEL_EXPORTER_OTLP_HEADERS="<Authorization=Basic <BASE64_ENCODED_CREDENTIALS>>" \ 
+  -p 8080-8083:8080-8083 \
+  jaegertracing/example-hotrod:latest \
+  all
+```
+This command does the following:
+- Runs the HotROD application in a Docker container and links it to your OpenObserve container.
+- Sets the environment variable for the OpenTelemetry exporter endpoint to send tracing data to OpenObserve.
+- Configures the necessary headers for authentication.
+- Maps ports 8080 to 8083 for accessing the HotROD services externally.
+
+By running this command, you'll be able to generate trace data from the HotROD application and send it to OpenObserve for visualisation and analysis.
+You can find the HTTP endpoint and authorization details in the Data Sources section, under Traces (OpenTelemetry).
+![O2_endpoint](/img/blog/Jaeger_blog/7-endpoints.gif)
+
+This is how command looks after replacing required fields
+```
+docker run \
+  --rm \
+  --link openobserve \
+  --env OTEL_EXPORTER_OTLP_ENDPOINT=http://13.232.45.32:5080/api/default \
+  --env OTEL_EXPORTER_OTLP_HEADERS="Authorization=Basic cm9vdEBleGFtcGxlLmNvbTpTMzVHMjhaMEkxVEdxYm9q" \
+  -p 8080-8083:8080-8083 \
+  jaegertracing/example-hotrod:latest \
+  all
+
+```
+Replace **<YOUR_ENDPOINT>** and **<YOUR_AUTH_HEADERS>** with your specific values.
+
+You can access the HotROD UI at **http://localhost:8080** ,Once your application is instrumented, run a few requests to generate some traces.
+![hotrod_UI_clicks](/img/blog/Jaeger_blog/4-clicks.gif)
+
+### Step 3: View Traces in OpenObserve UI
+Once your application is instrumented, generate some telemetry data by making requests to your services. You can then explore the data in the OpenObserve UI at **http://localhost:8080**.
+![O2_traces](/img/blog/Jaeger_blog/image7.gif)
+
+![O2_traces](/img/blog/Jaeger_blog/9-screenshots1.jpg)
+
+![O2_traces](/img/blog/Jaeger_blog/10-screenshots2.jpg)
+
+## Jaeger vs. OpenObserve
+
+| **Challenge**         | **Jaeger**                             | **OpenObserve (O2)**                                         |
+|-----------------------|----------------------------------------|--------------------------------------------------------------|
+| **Scalability**       | Struggles with high traffic            | Built for high scalability and performance                    |
+| **Unified Platform**  | Separate tools for logs and metrics    | Combines metrics, logs, and traces into one platform          |
+| **Querying**          | Basic querying options                 | Advanced querying capabilities for deeper insights            |
+| **Cost Management**   | Higher storage and processing costs    | Optimized for lower resource usage                             |
+| **User Experience**   | Traditional, complex interfaces        | Modern, intuitive interface for easy navigation and analysis  |
+
+
+## Conclusion
+Jaeger is an excellent tool for getting started with distributed tracing and is widely adopted for microservices observability. However, as systems grow, Jaeger’s limitations in data handling and cross-function observability (metrics, logs, and traces) may become restrictive.
+
+OpenObserve addresses these limitations by unifying metrics, logs, and traces in a single platform, making it a more comprehensive observability solution. With its scalability, enhanced query capabilities, and cost-effectiveness, OpenObserve empowers teams to monitor, troubleshoot, and optimise complex distributed systems more efficiently.
+
+## Real-World Case Study: Jidu’s Journey to 100% Tracing Fidelity
+To see OpenObserve’s impact in action, read about Jidu's journey to achieving 100% tracing fidelity using OpenObserve. Their team’s work offers valuable insights into overcoming the challenges of tracing at scale and ensuring trace accuracy across a complex system. You can read the full case study [here.](https://openobserve.ai/blog/jidu-journey-to-100-tracing-fidelity/)
+
+This case demonstrates how OpenObserve’s unified approach to observability enables improved trace fidelity and facilitates better troubleshooting, performance optimization, and insight gathering across distributed systems.