squakez commented on code in PR #3970:
URL: https://github.com/apache/camel-k/pull/3970#discussion_r1066715492
##########
addons/tracing/tracing.go:
##########
@@ -27,13 +27,14 @@ import (
"github.com/apache/camel-k/pkg/util"
)
-// The Tracing trait can be used to automatically publish tracing information
to an
-// OpenTracing compatible collector.
+// The Tracing trait can be used to automatically publish tracing information
to an OpenTracing compatible collector.
//
// The trait is able to automatically discover the tracing endpoint available
in the namespace (supports **Jaeger**).
//
// The Tracing trait is disabled by default.
//
+// WARNING: The Tracing trait can't be enabled at the same time as the
Telemetry trait.
Review Comment:
I'd take the opportunity and add a deprecation notice at least here,
reminding to use Telemetry trait.
##########
docs/modules/traits/pages/telemetry.adoc:
##########
@@ -0,0 +1,60 @@
+= Telemetry Trait
+
+// Start of autogenerated code - DO NOT EDIT! (description)
+The Telemetry trait can be used to automatically publish tracing information
to an OTLP compatible collector.
+
+The trait is able to automatically discover the telemetry OTLP endpoint
available in the namespace (supports **Jaerger** in version 1.35+).
+
+The Telemetry trait is disabled by default.
+
+WARNING: The Telemetry trait can't be enabled at the same time as the Tracing
trait.
+
+
+This trait is available in the following profiles: **Kubernetes, Knative,
OpenShift**.
+
+// End of autogenerated code - DO NOT EDIT! (description)
+// Start of autogenerated code - DO NOT EDIT! (configuration)
+== Configuration
+
+Trait properties can be specified when running any integration with the CLI:
+[source,console]
+----
+$ kamel run --trait telemetry.[key]=[value] --trait telemetry.[key2]=[value2]
integration.groovy
+----
+The following configuration options are available:
+
+[cols="2m,1m,5a"]
+|===
+|Property | Type | Description
+
+| telemetry.enabled
+| bool
+| Can be used to enable or disable a trait. All traits share this common
property.
+
+| telemetry.auto
+| bool
+| Enables automatic configuration of the trait, including automatic discovery
of the telemetry endpoint.
+
+| telemetry.service-name
+| string
+| The name of the service that publishes telemetry data (defaults to the
integration name)
+
+| telemetry.endpoint
+| string
+| The target endpoint of the Telemetry service (automatically discovered by
default)
+
+| telemetry.sampler
+| string
+| The sampler of the telemetry used for tracing (default "on")
+
+| telemetry.sampler-ratio
+| string
+| The sampler ratio of the telemetry used for tracing
+
+| telemetry.sampler-parent-based
+| bool
+| The sampler of the telemetry used for tracing is parent based (default
"true")
+
+|===
+
+// End of autogenerated code - DO NOT EDIT! (configuration)
Review Comment:
After this autogenerated code (or even in the trait comment section) we
could add some example how to use the trait. We did in other traits if you want
to have a look
https://camel.apache.org/camel-k/1.11.x/traits/toleration.html#_examples
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
