Instana AutoTrace webhook
The Instana AutoTrace webhook is a Kubernetes and Red Hat OpenShift-compatible admission controller mutating webhook. The webhook automatically configures Instana tracing on Node.js, .NET Core, Ruby, and Python applications that run across the entire Kubernetes or Red Hat OpenShift cluster. In addition, you can enable Instana tracing for IBM MQ and App Connect deployments that run in IBM Cloud Pak for Integration.
Before you install
Before you install the Instana AutoTrace webhook, make sure to check the limitations, supported runtimes, and prerequisites.
Limitations
- Instana AutoTrace webhook works only on new Kubernetes resources. After the webhook is installed, you must create new resources for the transformation to take effect. Delete your existing Pods, ReplicaSets, StatefulStes, Deployments, and
DeploymentConfigs, and then re-create them for the Instana AutoTrace webhook to complete its configuration (for example, by using
kubectl apply
). - Instana AutoTrace webhook supports only the
linux/amd64
Kubernetes nodes. - Instana AutoTrace webhook does not automatically update the instrumentation that it installs. Therefore, the Instana AutoTrace webhook is not enabled by default.
- When you uninstall Instana AutoTrace webhook, the transformation and instrumentation are not automatically removed. For more information, see Removing the instrumentation.
- If Instana AutoTrace webhook is installed on IBM Cloud Paks (Cloud Pak for Business Automation and Cloud Pak for Integration), you must exclude Zen from instrumentation. For more information, see Installing on IBM Cloud Paks.
Supported runtimes
The Instana AutoTrace webhook supports the following technologies:
The Instana AutoTrace webhook supports automatic instrumentation only on NGINX 1.19 or later. Currently, the Instana AutoTrace webhook does not support OpenResty.
Prerequisites
Before you install the Instana AutoTrace webhook on a Kubernetes-based cluster, make sure that the following prerequisites are met:
- Kubernetes 1.16 or later is installed.
- Red Hat OpenShift 4.5 or later is installed.
kubectl
1.16 or later is installed.- Helm 3.2 or later is installed. (Some automation relies on Helm
lookup
functions) - Sufficient memory limits in the target pod for instrumenting the application. The AutoTrace webhook loads the instrumentation libraries at runtime, which introduces extra memory overhead. Make sure that you allot sufficient memory to load
the instrumentation files in the
spec.template.spec.containers[x].resources.limits.memory
attribute of the target deployment. For more information, see Insufficient memory.
After you check all the prerequisite conditions, you can proceed to install the Instana AutoTrace webhook.
See the following topics for more information:
- Installing AutoTrace webhook
- Configuring AutoTrace webhook
- Updating AutoTrace webhook and instrumentation
- Uninstalling AutoTrace webhook
- Troubleshooting AutoTrace webhook
Instana AutoTrace webhook uses the libinstana_init
package to monitor a technology. For more information on libinstana_init
package releases, see libinstana_init
package releases