Open Telemetry instrumentation

Products

• CA API Gateway

Issue/Introduction

Questions with OTel Instrumentation in API Gateway.

• Can we instrument services hosted on SFTP protocol(services as SFTP server) and scheduled jobs as well. Even after including the service name in the include list of "otel.traceConfig" properties.

 

• Where to check whether Gateway has dispatched the metrics and traces to the Otel Collector. 

 

• Open Telemetry for Gateway in 11.1 is under preview release, when would it be considered for a GA release. 

Environment

Gateway 11.1.1

Resolution

Summary:

• We don't have a specific date/release for OTel to go from Preview to GA.

 

• Tracing is currently limited to HTTP services. We will track adding support for non-HTTP services (e.g. SFTP services, scheduled services, etc.) in the feature that will advance it from Preview to GA.

 

• For HTTP services, you can include them in the trace filter by specifying their resolution URI or their GOID s int the following example. We will update our techdocs to include GOID shortly.

 

• OTel specific logging is currently limited. We have minimal FINE level logging when creating trace spans. We will add additional OTel specific logging when we advance the feature from Preview to GA. In the meantime, and in any case, customers should enable debug logging in their Collector config to see what the gateway is sending to their Collector, https://opentelemetry.io/docs/collector/troubleshooting/