Hear from Salesforce leaders on how to create and deploy Agentforce agents.
Register now
Contact Us 1-800-596-4880
  1. Homepage
  2. Runtime Fabric
  3. Using RTFCTL Tool
  4. Using RTFCTL for Runtime Fabric

  5. Troubleshooting Runtime Fabric

Troubleshooting Runtime Fabric with RTFCTL

Use these rtfctl commands to troubleshoot Runtime Fabric.

Command Description

get

Displays one or more resources

ping

Tests network connectivity

report

Generates a diagnostics report

status

Displays the status of Runtime Fabric

test

Verifies outbound network connectivity to the Runtime Fabric control plane

get

Displays one or more resources

  • Prints a list of all applications in all environments

    rtfctl get apps --namespace <rtf_namespace>

  • Prints a list of all applications in a specific environment

    rtfctl get apps --app-namespace <app_namespace> --namespace <rtf_namespace>

  • Displays an HTTP proxy configurations

    rtfctl get http-proxy --namespace <rtf_namespace>

  • Displays a monitoring proxy configuration

    rtfctl get monitoring-proxy --namespace <rtf_namespace>

  • Displays secure properties

    rtfctl get secure-properties --app-namespace <app_namespace> --namespace <rtf_namespace>

  • Displays the Mule license

    rtfctl get mule-license --namespace <rtf_namespace>

  • Displays Runtime Fabric registry credentials

    rtfctl get registry-credentials <activation_data>

ping

Tests network connectivity

  • Pings example.com from inside an application, using the first replica by default

    rtfctl ping <app_name> <host_or_ip_address> --app-namespace <app_namespace> --namespace <rtf_namespace>

  • Attempts to connect to example.com on port 12345 from inside an application, using the first replica by default

    rtfctl ping <app_name> <host_or_ip_address> --port <port> --app-namespace <app_namespace> --namespace <rtf_namespace>

report

Generates a diagnostics report at rtf-report.tar.gz

rtfctl report --namespace <rtf_namespace>

Run rtfctl report tasks in parallel by using the workers flag that controls the number of tasks to run in parallel. The default value is 10.

rtfctl report --workers <num_of_workers>

Faster compression of the tarball generated by rtfctl report with the --use-fast-compression flag. The default value is false.

rtfctl report --use-fast-compression=true

Select which application namespaces to include in the report besides the installation namespace by using the --namespaces flag. The flag controls what to include in the reports and can result in faster collection if only selected namespaces are reported.

  # Reports rtf installation default namespace (rtf)
  rtfctl report
  # Reports only <rtf_namespace>
  rtfctl report -n <rtf_namespace>
  # Reports for <app_namespace_1> and <app_namespace_2> application namespaces that belong to <rtf_namespace>
  rtfctl report -n <rtf_namespace> --app-namespaces <app_namespace_1>,<app_namespace_2>
  rtfctl report -n <rtf_namespace> --app-namespaces <app_namespace_1> --app-namespaces <app_namespace_2>
  # Report for all application namespaces that belong to <rtf_namespace>
  rtfctl report -n <rtf_namespace> --app-namespaces all

Specifies the name of the helm release to support installations using custom release names.

rtfctl report --release-name <agentReleaseName>

status

Displays the status of Runtime Fabric

  • Displays status output in JSON

    rtfctl status --output json --namespace <rtf_namespace>

  • Checks Kubernetes DNS health

    rtfctl status dns-check --node-label "<k>:<v>"

test

Verifies outbound network connectivity to the Runtime Fabric control plane.

  • Schedules a check on any nodes

    rtfctl test outbound-network --namespace <rtf_namespace>

  • Schedules a check the nodes satisfying the node-label parameter

    rtfctl test outbound-network --node-label "<k>:<v>" --namespace <rtf_namespace>

  • Schedules a check on all nodes

    rtfctl test outbound-network --all --namespace <rtf_namespace>

See Also