OpenTelemetry Best Practices #1: Naming
Blog post from Honeycomb
The text discusses the critical importance of consistent naming conventions in telemetry, particularly in the context of OpenTelemetry, which is the standard for generating and emitting telemetry in applications. It emphasizes that inconsistent naming can lead to significant issues in data pipelines, highlighting the need for standardization in naming attributes, spans, and labels to enhance data correlation and observability. The text advises focusing on local consistency within organizational boundaries while leveraging Semantic Conventions for well-known concepts to allow backend systems to make useful assumptions about the data. It also suggests using namespaces and prefixes based on organizational and application-specific contexts to improve data querying and reduce cognitive load. Furthermore, the text underscores the benefits of shared libraries and packages in standardizing naming practices and reducing confusion among developers. It concludes by promising further insights in a subsequent post about automatic and custom instrumentation.