Search…
Annotations and labels
The topic describes the various annotations that are available for traceable-agent
The following tables describe annotations and labels for namespace and pod for:

Traceable module extension (tme)

The following tables describe labels and annotations for namespace and pod.

Namespace

The following table describes annotations and labels for the namespace.

Label

Label
Description
traceableai-inject-tme
Set this value to enabled on the namespace where you want to inject the Traceable agent.

Annotations

Annotation
Description
tme.traceable.ai/defaultInject
This annotation defines the default injection behavior on pods in a namespace, that is, whether you want to inject or do not want to inject.
  • Value set to true - When you set the value to true, then by default injection is enabled. If you do not want injection at the pod level, set agent.traceable.ai/inject: false.
  • Value set to false - When you set the value to false, then by default injection is disabled. In this case, if you want injection at the pod level, set agent.traceable.ai/inject: true
When this annotation is not set, the default behavior is similar to when the value is set to false.

Pod

Labels

There are no labels for the pod for Traceable platform agent.

Annotations

Annotations
Description
tme.traceable.ai/inject
Set the value to true to enable injection and false to disable injection. The default behavior, when this annotation is not specified, depends on the behavior of the namespace. See, tme.traceable.ai/defaultInject annotation in the namespace section above.
tme.traceable.ai/port
Defines the port to be used fortme sidecar GRPC endpoint. The default value is 5441.
tme.traceable.ai/restPort
Defines the port to be used for tme REST endpoint. The default value is 5442.
tme.traceable.ai/blocking
The annotation is used to define request blocking in the injected tme. Set the value to true to enable blocking andfalse to disable blocking. The default behavior is to enable blocking.

Proxy

The following tables describe labels and annotations for namespace and pod.

Namespace

The following table describes annotations and labels for the namespace.

Label

Label
Description
traceableai-inject-proxy
Set the value of this label to enabled for the namespace where you want to inject proxy.

Annotation

Annotation
Description
proxy.traceable.ai/defaultInject
This annotation defines the default injection behavior on pods in a namespace, that is, whether you want to inject or do not want to inject.
  • Value set to true - When you set the value to true, then by default injection is enabled. If you do not want injection at the pod level, set proxy.traceable.ai/inject: false.
  • Value set to false - When you set the value to false, then by default injection is disabled. In this case, if you want injection at the pod level, set proxy.traceable.ai/inject: true
When this annotation is not set, the default behavior is similar to when the value is set to true.

Pod

The following table describes annotations and labels for the pod.

Labels

There are no labels for the pod for Proxy.

Annotation

Annotation
Description
proxy.traceable.ai/inboundPortmaps
The annotation is used to define the port mapping between service and Envoy. For example, 8080:8081, 9090:9091
proxy.traceable.ai/inject
Set the value to true to enable injection and false to disable injection. The default behavior, when this annotation is not specified, depends on the behavior of the namespace. See, proxy.traceable.ai/defaultInject annotation above.
proxy.traceable.ai/blocking
The annotation is used to define request blocking in the injected proxy. Set the value to true to enable blocking andfalse to disable blocking. The default behavior is to enable blocking.
proxy.traceable.ai/ignoreMatcher
A JSON array formatted string used to configure URLs to ignore. Used for --ignore-url-regex proxy argument. For example, [{"url_path":"\/login"},{"url_path":"\/logout"}].

Java agent

The following tables describe labels and annotations for namespace and pod.

Namespace

The following table describes annotations and labels for the namespace.

Label

Label
Description
traceableai-inject-java
Set the value to enabled for the namespace where you would like to inject the Java agent.

Annotation

Annotation
Description
java.traceable.ai/defaultInject
This annotation defines the default injection behavior on pods in a namespace, that is, whether you want to inject or do not want to inject.
  • Value set to true - When you set the value to true, then by default injection is enabled. If you do not want injection at the pod level, set java.traceable.ai/inject: false.
  • Value set to false - When you set the value to false, then by default injection is disabled. In this case, if you want injection at the pod level, set java.traceable.ai/inject: true
When this annotation is not set, the default behavior is similar to when the value is set to false.

Pod

The following table describes annotations and labels for the pod.

Labels

There are no labels for the pod for Java agent.

Annotation

Annotation
Description
java.traceable.ai/inject
Set the value to true to enable injection and false to disable injection. The default behavior, when this annotation is not specified, depends on the behavior of the namespace. See, java.traceable.ai/defaultInject annotation above.
java.traceable.ai/configmap
Defines the configmap that contains the Java agent configuration. The default value when this annotation is not specified is an empty string.
java.traceable.ai/configmapNamespace
Defines the namespace that contains the configmap defined above. The default value when this annotation is not specified is an empty string.
java.traceable.ai/blocking
The annotation is used to define request blocking in the injected Java agent. Set the value to true to enable blocking andfalse to disable blocking. The default behavior is to enable blocking.
Last modified 3mo ago