Open topic with navigation

TIBCO BusinessEvents® Enterprise Edition 6.3.1

# Telemetry Configurations Settings

To configure the default telemetry data collection and enable the instrumentation of your application, you can modify the telemetry configuration settings in your TIBCO BusinessEvents application CDD.

For more details about the tracing in TIBCO BusinessEvents, see TIBCO BusinessEvents Application Tracing.

The following table lists the telemetry configuration settings available in the CDD editor of TIBCO BusinessEvents Studio.

Telemetry configurations
Property | Description
--- | ---
Service Name | A name to identify the application in the telemetry data store. In the visualization software, you can identify your application using the Service Name. The default service name is `default`.
Sampler | (Optional) A sampler strategy helps control the volume of telemetry data that you want to export. `always_on` - Use this strategy to send every span to the export pipeline. `always_off` - Use this strategy to ensure that no spans are sent to the export pipeline. `traceidratio` - Use this strategy to send a specified fraction of spans based on their TraceId. You can specify the fraction value in the TraceId Ratio field. `parentbased_always_on` - When the request is coming from another application or service, use this strategy to use the sampling algorithm of the parent application or service, otherwise to send every span to the export pipeline. `parentbased_always_off` - When the request is coming from another application or service, use this strategy to use the sampling algorithm of the parent application or service, otherwise not to send any span to the export pipeline. `parentbased_traceidratio` - When the request is coming from another application or service, use this strategy to use the sampling algorithm of the parent application or service otherwise to send a specified fraction of spans based on their TraceId. You can specify the fraction value in the TraceId Ratio field. The default value is `always_on`.
TraceId Ratio | Enabled only when the `traceidratio` or `parentbased_traceidratio` sampler strategy is selected. A sampling ratio must be specified to a value between `0.0` to `1.0`. The `0.0` value specifies that no spans are to be sent while the `1.0` value specifies that all spans are sent. For example, to send 50% of spans to the export pipeline, select the value as `0.5`. The default value is `1.0`.
Propagators | Enter a comma-separated list of propagators to be used to serialize and deserialize the context. Click the Browse button to open the list of available propagators. You can select one or more than one propagator for your application. The following propagators are supported exclusively in TIBCO BusinessEvents: `tracecontext` `baggage` `b3` `b3multi` `jaeger` `ottrace` The default propagator is `tracecontext`. For details about propagators, see OpenTelemetry documentation.
Enabled Tracing Resource List | (Optional) By default all resources (/) are enabled for tracing. You can specify which resources need to be traced. All Resources starting with the URI specified will be enabled for tracing. There is AND operation between Enable Resource list and Disabled Resource list. For example: If Enabled Resource List consist of URI: `/Rules/Order/CreateOrderRule` and Disabled Resource List Consist of URI: `/Rules/Order`. In this case, all rules starting with URI `/Rules/Order` are disabled for tracing. The Rule `/Rules/Order/CreateOrderRule` is also not enabled for tracing.
Disable Tracing Resource List | (Optional) Add resources here that you do not want to trace. You can use the full URI of rule, rule function, or destination, or partial paths to ignore all resources starting with that path. The list could also be updated through JMX at runtime. Note: If tracing is turned off for a destination, tracing is turned off for all rules and rule functions running for that event. If a rule function is added to this list, the tracing data is not exported for the rule function and also for any catalog function invoked during execution.
Span Exporter | (Optional) Span exporter exports the telemetry data to the specified collector. The following options are provided as span exporter: `None` `OTLP` (OpenTelemetry collector) `Jaeger` `Zipkin` The default value is `None`.
Endpoint | The endpoint URL of the selected Span Exporter. This field is not displayed when the Span Exporter value is `None`.
Timeout | The request timeout (in milliseconds) for the selected Span Exporter. This field is not displayed when the Span Exporter value is `None`.
Headers | Provide comma-separated key-value pairs as headers with the equals to symbol = separating the key and value. This field is displayed when the Span Exporter value is `OTLP`.
Security Enabled | Select the checkbox to enable the secured connection. This field is displayed when the Span Exporter value is `OTLP`.
Security Certificate | Provide the path of the security certificate for the span exporter. This field is displayed when the Span Exporter value is `OTLP` and Security Enabled checkbox is selected.

Did you find this helpful?

YesNo
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO BusinessEvents® Enterprise Edition

Copyright © 2004-2024. Cloud Software Group, Inc. All Rights Reserved.