Choreo Connect Tracing Configuration Catalog

This document describes all the configurations related to tracing that are used in ESB Choreo Connect.

Instructions for use

Select the configuration sections, parameters, and values that are required for your use and add them to the config.toml file located in <CHOREO-CONNECT_HOME>/docker-compose/choreo-connect/conf/. See the example .toml file given below.

# This is an example .toml file.
[tracing]
  enabled = true
  type = "zipkin"

[tracing.configProperties]
    host = "zipkin"
    port = "9411"
    endpoint = "/api/v2/spans"
    instrumentationName = "CHOREO-CONNECT"
    maximumTracesPerSecond = "2"

Tracing Configurations

[enforcer.tracing]
  enabled = false
  type = "jaeger"
[tracing]

enabled

boolean Required

Default: false

Enable/Disable tracing in Choreo Connect

type

string

Default: zipkin

Type of trace exporter (e.g: azure, zipkin). Use `zipkin` for jaeger

Tracer Configuration Properties

[enforcer.tracing.configProperties]
  host = "jaeger"
  port = "9411"
  endpoint = "/api/v2/spans"
  instrumentationName = "CHOREO-CONNECT"
  maximumTracesPerSecond = "2"
  maxPathLength = "256"
  connectionTimeout = "20"
[tracing.configProperties] Required

Configurations specific to each tracer configured in `tracing.type`

endpoint

string Required

Default: /api/v2/spans

Tracing data receiver's endpoint path. Applicable only for Jaeger and Zipkin tracers

host

string Required

Default: jaeger

Tracing data receiver's host. Applicable only for Jaeger and Zipkin tracers

port

string Required

Default: 9411

Tracing data receiver host's port. Applicable only for Jaeger and Zipkin tracers

connectionString

string Required

Default: ""

Azure App Insights connection string. Applicable only for Azure Insights

instrumentationName

string

Default: CHOREO-CONNECT

Reference name for the Choreo Connect service in the tracer.

maximumTracesPerSecond

string

Default: 2

Number of trace events to publish per second

maxPathLength

string

Default: 256

Maximum length of the request path to extract and include in the HttpUrl tag.

connectionTimeout

string

Default: 20

Connection timeout for the OTLP service

Top