From 3003aa70aecec492c6ef6cb4495a895877a2d4c1 Mon Sep 17 00:00:00 2001 From: Tigran Najaryan Date: Mon, 30 Sep 2019 20:17:24 -0400 Subject: [PATCH] Clarify placement of exporter implementation There was unnecessarily suggestive wording that implied that vendor exporters should be part of language libraries. Added a clarification regarding vendor-specific exporters, OpenTelemetry protocol exporter and standard output exporter. --- specification/library-guidelines.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/library-guidelines.md b/specification/library-guidelines.md index 1a56695f5de..8110a32570f 100644 --- a/specification/library-guidelines.md +++ b/specification/library-guidelines.md @@ -16,8 +16,9 @@ _Note to Language Library Authors:_ OpenTelemetry specification, API and SDK imp 3. The developers of the final application normally decide how to configure OpenTelemetry SDK and what extensions to use. They should be also free to choose to not use any OpenTelemetry implementation at all, even though the application and/or its libraries are already instrumented. The rationale is that third-party libraries and frameworks which are instrumented with OpenTelemetry must still be fully usable in the applications which do not want to use OpenTelemetry (so this removes the need for framework developers to have "instrumented" and "non-instrumented" versions of their framework). -4. Language library implementation must be clearly separated into wire protocol-independent parts that implement common logic (e.g. batching, tag enrichment by process information, etc.) and protocol-dependent telemetry exporters. Telemetry exporters must contain minimal functionality, thus enabling vendors to easily add support for their specific protocol to the language library. +4. Language library implementation must be clearly separated into wire protocol-independent parts that implement common logic (e.g. batching, tag enrichment by process information, etc.) and protocol-dependent telemetry exporters. Telemetry exporters must contain minimal functionality, thus enabling vendors to easily add support for their specific protocol. +5. Language library implementation should include an exporter for OpenTelemetry Protocol (when the protocol is specified and approved) and may include an exporter that writes to standard output (to use for debugging and testing). Vendor-specific exporters (exporters that implement vendor protocols) should not be included in language libraries and should be placed elsewhere (the exact approach for storing and maintaining vendor-specific exporters will be defined in the future). # Language Library Generic Design