Summary
In this chapter, we talked about different ways to keep custom telemetry and attributes consistent across your system. We identified attribute properties to be documented and learned about attribute naming conventions.
Keeping telemetry consistent is a challenge. We explored how to make it easier by sharing common instrumentation code, including OpenTelemetry setup and utility methods that report attributes with the right names and types.
Finally, we learned about the OpenTelemetry semantic conventions schema and tooling, which may help you define, validate, and automate the documentation process for custom conventions.
Defining a common schema for telemetry during the early stages of a project is going to save your organization a lot of time down the road, and now you have the knowledge and tools to do it. In the next chapter, we’ll talk about brownfield systems, where new solutions coexist with legacy ones, and we’ll see how difficult it can be to align...