Install eBPF using script

-s SERVICE

Yes

The service name for the mirrored traffic.

-e ENVIRONMENT

Yes

Environment name for the mirrored traffic.

-r REMOTE_ENDPOINT

No

Remote endpoint for Traceable Platform agent.

-P PORTS

No

Comma-separated list of ports that you wish to track.

-S SSL_DIRS

No

Comma-separated list of SSL directories.

-E EXCLUDE_PROCESSES

No

Comma-separated list of process names that you wish to exclude from tracking.

--mode MODE

No

Traffic type to be captured. MODE can take the following values:

• ingress: capture all ingress traffic for given PORTS.

• egress: capture all egress traffic for the given PORTS.

• ingress_and_egress: capture all ingress as well as egress traffic for given PORTS.

The default value is ingress.

-R MAX_RETURN_PROBES

No

Maximum number of return probes.

-t | --token

No

Prompt for Traceable Token for authentication. Check token for more details.

--remote-cert-path PATH

No

Root CA used to sign certificate for the Traceable Platform.

--tpa-loglevel TAP_LOGLEVEL

No

Logging level for the Traceable service. The allowed values are info, warn, error, and debug. The default value is info.

--tpa-log-max-size-mb TPA_LOGSIZE

No

The maximum log file size in MB created by the Traceable service. The default value is 10 MB.

--tpa-log-max-backups TPA_LOGCOUNT

No

Maximum number of backup log files created by the Traceable service. The default value is 10.

--ebpf-loglevel EBPF_LOGLEVEL

No

Logging level for the eBPF service. The allowed values are info, warn, error, debug and trace. The default value is info.

--ebpf-log-max-size-mb EBPF_LOGSIZE

No

Maximum log file size in MB created by the eBPF service. The default value is 10 MB.

--ebpf-log-max-backups EBPF_LOGCOUNT

No

Maximum number of backup log files created by the eBPF service. The default value is 10.

--no-download

No

Use local packages to install Traceable and its components. For more information, see Airgapped installation.

--enable-java-tls-capture

No

Set it to true, if you wish to capture Java TLS traffic. The default value is false.

--ebpf-max-memory EBPF_MAX_MEM

No

Maximum memory limit for the eBPF service. Takes a memory size in bytes. If the value is suffixed with K, M, G, or T, the specified memory size is parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. Alternatively, a percentage value may be specified, which is taken relative to the installed physical memory on the system.

--tpa-max-memory TPA_MAX_MEM

No

Maximum memory limit for the Traceable service. Takes memory size in bytes. If the value is suffixed with K, M, G, or T, the specified memory size is parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. Alternatively, you can select the value as a percentage, which is taken relative to the installed physical memory on the system.

--set-memory-accounting

No

Set MemoryAccounting to true for the services. This is required on VMs where DefaultMemoryAccounting property is not enabled.

--ebpf-request-per-second-limit

No

Sets the maximum number of requests the eBPF tracer would capture in a second.

--ebpf-max-connection

No

Sets the maximum number of connections the eBPF tracer tracks at any given time.

--ebpf-go-memory-limit

No

This is the substitute for the GOMEMLIMIT environment variable. The argument expects input in k8 units. The default value is 0, which translates to no limit being set.

Examples: 128974848, 129e6, 129M, 128974848000m, 123Mi

--otlp-max-connection-age

No

Sets the keepalive duration for the OTLP server in the Traceable Platform agent. The duration can be expressed as a string. The acceptable units are ns, us, s, m, and h.

Example: 100ms = 100 milliseconds, 120s = 120 seconds,
120m = 120 minutes, 2h = 2 hours. The default value is infinity.

--http-proxy

No

Used for setting proxy URL for HTTP requests until overwritten by --no-proxy.

--https-proxy

No

Used for setting proxy URL for HTTPS requests until overwritten by --no-proxy.

--no-proxy

No

Specifies a string that contains comma-separated values specifying hosts that should be excluded from proxying.

--tpa-max-cpu TPA_MAX_CPU

No

Sets the maximum percentage of CPU that the Traceable Platform Agent (TPA) process is allowed to use. For example, --tpa-max-cpu 100% would limit the TPA process to one full CPU core. Setting --tpa-max-cpu 200% would allow it to use up to two cores.

--ebpf-max-cpu EBPF_MAX_CPU

No

Sets the maximum CPU percentage for the eBPF process. For example, --ebpf-max-cpu 100% allows the process to use up to one CPU core. With --ebpf-max-cpu 200%, two cores can be used.

-s SERVICE_NAME

Yes

The service name for the mirrored traffic.

--tpa-endpoint ENDPOINT

Yes

Endpoint of Traceable Platform Agent.

-P PORTS

No

Comma-separated list of ports that you wish to track.

-S SSL_DIRS

No

Comma-separated list of SSL directories.

-E EXCLUDE_PROCESSES

No

Comma-separated list of process names to be excluded from tracking.

-R MAX_RETURN_PROBES

No

Maximum number of return probes. The default value is 1.

--mode MODE

No

Traffic type to be captured. MODE can take the following values:

• ingress: capture all ingress traffic for given PORTS.

• egress: capture all egress traffic for the given PORTS.

• ingress_and_egress: capture all ingress as well as egress traffic for given PORTS.

The default value is ingress.

--tls-root-cert ROOT_CA_CERT

No

Root CA used to sign certificate for Traceable Platform Agent. eBPF uses this to validate the Traceable Platform Agent's certificate. If this value is provided, eBPF uses TLS encryption for data sent to the Traceable Platform Agent.

--reporting-port REPORTING_PORT

No

Reporting endpoint port of Traceable Platform Agent. If --tls-root-cert is provided, the default value is 5443. Otherwise, the default value is 4317.

--remote-port REMOTE_PORT

No

Remote endpoint port of Traceable Platform Agent. If --tls-root-cert is provided, the default value is 5443. Otherwise, the default value is 5441.

--exporter EXPORTER

No

eBPF span exporter. Allowed values are ZIPKIN and OTLP. The default exporter is OTLP.

--loglevel LOGLEVEL

No

Logging level for the eBPF service. The allowed values are info, warn, error, debug and trace. The default value is info.

--log-max-size-mb SIZE

No

Maximum log file size in MB created by the eBPF service. The default value is 10 MB.

--log-max-backups COUNT

No

Maximum number of backup log files created by the eBPF service. The default value is 10.

--no-download

No

Use local packages to install Traceable and its components. For more information, see Airgapped installation.

--enable-java-tls-capture

No

Set it to true, if you wish to capture Java TLS traffic. The default value is false.

--max-memory MAX_MEMORY

No

Maximum memory limit for the Traceable service. Takes memory size in bytes. If the value is suffixed with K, M, G, or T, the specified memory size is parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. Alternatively, you can select the value as a percentage, which is taken relative to the installed physical memory on the system.

--set-memory-accounting

No

set MemoryAccounting to true for the eBPF service. This is required on VMs where the DefaultMemoryAccounting property is not enabled.

--request-per-second-limit

No

Sets the maximum number of requests the eBPF tracer would capture in a second.

--max-connection

No

Sets the maximum number of connections the eBPF tracer tracks at any given time.

--go-memory-limit

No

This is the substitute for the GOMEMLIMIT environment variable. The argument expects input in k8 units. The default value is 0, which translates to no limit being set.

Examples: 128974848, 129e6, 129M, 128974848000m, 123Mi.

--max-cpu MAX_CPU

No

Specifies the maximum CPU percentage for the eBPF. For instance, --max-cpu 100% limits the process to one core and --max-cpu 200% would use two cores. This parameter ensures that the eBPF process doesn't exceed your set CPU limit.