SkyWalking Configuration

Configuration reference for the SkyWalking plugin (`skywalking`): the static configurations and parameters, each attribute with its type, whether it is required, its default and its accepted values.

Static Configurations

By default, service names and endpoint address for the plugin are pre-configured in the default configuration.

The file to update depends on how the gateway is deployed:

For host or Docker deployments, configure the following settings:

config.yaml

plugin_attr:
  skywalking:
    report_interval: 3      # Reporting interval time in seconds.
    service_name: APISIX    # Service name for SkyWalking reporter.
    service_instance_name: "APISIX Instance Name"   # Service instance name for SkyWalking reporter.
                                                    # Set to $hostname to get the local hostname.
    endpoint_addr: http://127.0.0.1:12800           # SkyWalking HTTP endpoint.

Then reload the gateway for changes to take effect.

For Helm deployments, update the chart values that render plugin_attr.skywalking. For APISIX, also confirm that the plugin is loaded in the gateway plugin list before applying them. Keep the rest of your values file unchanged.

For the APISIX Helm chart, set the following values:

values.yaml

apisix:
  pluginAttrs:
    skywalking:
      report_interval: 3
      service_name: APISIX
      service_instance_name: "APISIX Instance Name"
      endpoint_addr: http://127.0.0.1:12800

For the API7 Gateway Helm chart, set the following values:

values.yaml

pluginAttrs:
  skywalking:
    report_interval: 3
    service_name: APISIX
    service_instance_name: "APISIX Instance Name"
    endpoint_addr: http://127.0.0.1:12800

Then apply the values file with the chart used for this gateway release:

helm upgrade <release-name> <chart-name> -n <namespace> -f values.yaml

Parameters

See plugin common configurations (opens in Apache APISIX docs) for configuration options available to all plugins.

sample_ratio — number · optional · default: 1 · since APISIX 1.4 · API7 Gateway 3.2.16.3

Valid values: between 0.00001 and 1 inclusive

Frequency of request sampling. Setting the sample ratio to 1 means to sample all requests.