Java agent injector Manual

To use the java agent more natively, we propose the java agent injector to inject the agent sidecar into a pod.

When enabled in a pod’s namespace, the injector injects the java agent container at pod creation time using a mutating webhook admission controller. By rendering the java agent to a shared volume, containers within the pod can use the java agent.

The following sections describe how to configure the agent, if you want to try it directly, please see Usage for more details.

Install Injector

The java agent injector is a component of the operator, so you need to follow Operator installation instrument to install the operator firstly.

Active the java agent injection

We have two granularities here: namespace and pod.

The injector is configured with the following logic:

1. If either label is disabled, the pod is not injected.
2. If two labels are enabled, the pod is injected.

Follow the next steps to active java agent injection.

• Label the namespace with swck-injection=enabled

$ kubectl label namespace default(your namespace) swck-injection=enabled

• Add label swck-java-agent-injected: "true" to the pod, and get the result as below.

$ kubectl get pod -l swck-java-agent-injected=true
NAME          READY   STATUS    RESTARTS   AGE
inject-demo   1/1     Running   0          2d2h

The ways to configure the agent

The java agent injector supports a precedence order to configure the agent:

Annotations > SwAgent > Configmap (Deprecated) > Default Configmap (Deprecated)

Annotations

Annotations are described in kubernetes annotations doc.

We support annotations in agent annotations and sidecar annotations.

SwAgent

SwAgent is a Customer Resource defined by SWCK.

We support SwAgent in SwAgent usage guide

Configmap (Deprecated)

Configmap is described in kubernetes configmap doc.

We need to use configmap to set agent.config so that we can modify the agent configuration without entering the container.

If there are different configmap in the namepsace, you can choose a configmap by setting sidecar annotations; If there is no configmap, the injector will create a default configmap.

Default configmap (Deprecated)

The injector will create the default configmap to overlay the agent.config in the agent container.

The default configmap is shown as below, one is agent.service_name and the string can’t be empty; the other is collector.backend_service and it needs to be a legal IP address and port, the other fields need to be guaranteed by users themselves. Users can change it as their default configmap.

data:
  agent.config: |
    # The service name in UI
    agent.service_name=${SW_AGENT_NAME:Your_ApplicationName}

    # Backend service addresses.
    collector.backend_service=${SW_AGENT_COLLECTOR_BACKEND_SERVICES:127.0.0.1:11800}

    # Please refer to https://skywalking.apache.org/docs/skywalking-java/latest/en/setup/service-agent/java-agent/configurations/#table-of-agent-configuration-properties to get more details.

To avoid the default configmap deleting by mistake, we use a configmap controller to watch the default configmap. In addition, if the user applies an invalid configuration, such as a malformed backend_service, the controller will use the default configmap.

Configure the agent

The injector supports two methods to configure agent:

• Only use the default configuration.
• Use annotations to overlay the default configuration.

Use the default agent configuration

After activating the java agent injection, if not set the annotations, the injector will use the default agent configuration directly as below.

initContainers:
  - args:
    - -c
    - mkdir -p /sky/agent && cp -r /skywalking/agent/* /sky/agent
    command:
    - sh
    image: apache/skywalking-java-agent:8.10.0-java8
    name: inject-skywalking-agent
    volumeMounts:
    - mountPath: /sky/agent
      name: sky-agent
volumes:
  - emptyDir: {}
    name: sky-agent
  - configMap:
      name: skywalking-swck-java-agent-configmap
    name: java-agent-configmap-volume

Use SwAgent to overlay default agent configuration

The injector will read the SwAgent CR when pods creating.

SwAgent CRD basic structure is like:

apiVersion: operator.skywalking.apache.org/v1alpha1
kind: SwAgent
metadata:
  name: swagent-demo
  namespace: default
spec:
  containerMatcher: ''
  selector:
  javaSidecar:
    name: swagent-demo
    image: apache/skywalking-java-agent:8.10.0-java8
    env:
      - name: "SW_LOGGING_LEVEL"
        value: "DEBUG"
      - name: "SW_AGENT_COLLECTOR_BACKEND_SERVICES"
        value: "skywalking-system-oap:11800"
  sharedVolumeName: "sky-agent-demo"
  optionalPlugins:
    - "webflux"
    - "cloud-gateway-2.1.x"

There are three kind of configs in SwAgent CR.

1. label selector and container matcher

label selector and container matcher decides which pod and container should be injected.

2. injection configuration

injection configuration will affect on agent injection behaviour

3. skywalking agent configuration

skywalking agent configuration is for agent SDK.

Use annotations to overlay default agent configuration

The injector can recognize five kinds of annotations to configure the agent as below.

1. strategy configuration

The strategy configuration is the annotation as below.

2. agent configuration

The agent configuration is the annotation like agent.skywalking.apache.org/{option}: {value}, and the option support agent.xxx 、osinfo.xxx 、collector.xxx 、 logging.xxx 、statuscheck.xxx 、correlation.xxx 、jvm.xxx 、buffer.xxx 、 profile.xxx 、 meter.xxx 、 log.xxx in agent.config, such as agent.skywalking.apache.org/agent.namespace, agent.skywalking.apache.org/meter.max_meter_size, etc.

3. plugins configuration

The plugins configuration is the annotation like plugins.skywalking.apache.org/{option}: {value}, and the option only support plugin.xxx in the agent.config, such as plugins.skywalking.apache.org/plugin.mount, plugins.skywalking.apache.org/plugin.mongodb.trace_param, etc.

4. optional plugin configuration

The optional plugin configuration is the annotation as below.

5. optional reporter plugin configuration

The optional reporter plugin configuration is the annotation as below.

Configure sidecar

The injector can recognize the following annotations to configure the sidecar:

The ways to get the final injected agent’s configuration

Please see javaagent introduction for details.