Add config documentation

smithy-lang · Jul 17, 2024 · e515726 · e515726
1 parent 0fc7a55
commit e515726
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/...degen/src/main/java/software/amazon/smithy/ruby/codegen/middleware/MiddlewareBuilder.java b/...degen/src/main/java/software/amazon/smithy/ruby/codegen/middleware/MiddlewareBuilder.java
@@ -241,7 +241,11 @@ private Collection<? extends ClientConfig> getDefaultClientConfig() {
                 .build();
 
         String telemetryProviderDocumentation = """
-                TODO
+                A telemetry provider is used to emit telemetry data. By default, this
+                functionality is disabled. The SDK currently supports OpenTelemetry (OTel)
+                as a provider. To use the OTel provider, load the `opentelemetry-sdk` gem
+                and then, pass in an instance of a `Hearth::Telemetry::OTelProvider`
+                for telemetry provider.
                 """;
         ClientConfig telemetryProvider = ClientConfig.builder()
                 .name("telemetry_provider")