Book Image

Modern Distributed Tracing in .NET

By : Liudmila Molkova
Book Image

Modern Distributed Tracing in .NET

By: Liudmila Molkova

Overview of this book

As distributed systems become more complex and dynamic, their observability needs to grow to aid the development of holistic solutions for performance or usage analysis and debugging. Distributed tracing brings structure, correlation, causation, and consistency to your telemetry, thus allowing you to answer arbitrary questions about your system and creating a foundation for observability vendors to build visualizations and analytics. Modern Distributed Tracing in .NET is your comprehensive guide to observability that focuses on tracing and performance analysis using a combination of telemetry signals and diagnostic tools. You'll begin by learning how to instrument your apps automatically as well as manually in a vendor-neutral way. Next, you’ll explore how to produce useful traces and metrics for typical cloud patterns and get insights into your system and investigate functional, configurational, and performance issues. The book is filled with instrumentation examples that help you grasp how to enrich auto-generated telemetry or produce your own to get the level of detail your system needs, along with controlling your costs with sampling, aggregation, and verbosity. By the end of this book, you'll be ready to adopt and leverage tracing and other observability signals and tools and tailor them to your needs as your system evolves.
Table of Contents (23 chapters)
1
Part 1: Introducing Distributed Tracing
6
Part 2: Instrumenting .NET Applications
11
Part 3: Observability for Common Cloud Scenarios
16
Part 4: Implementing Distributed Tracing in Your Organization

Chapter 8 – Writing Structured and Correlated Logs

  1. The code uses string interpolation instead of semantic logging. A log message is formatted right away, so the ILogger.Log method is called underneath with the "hello world: 43, bar" string, without any indication that there are two arguments with specific names and values.

If the Information level is disabled, string interpolation happens anyway, serializing all arguments and calculating just the message to be dropped.

This code should be changed to logger.LogInformation("hello world: {foo}, {bar}", 42, "bar").

  1. We need to make sure that the usage report is built using log record properties that don’t change:
    • A log message would change a lot when new arguments are added or code is refactored.
    • The logging category is usually based on a namespace, which might change during refactoring. We can consider passing categories explicitly as strings instead of a generic type parameter...