Skip to main content

SkyWalking Configuration

The skywalking plugin sends APISIX and API7 Gateway request traces to Apache SkyWalking for distributed tracing, request analysis, and trace-log correlation. Configuration covers static settings and plugin parameters.

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.

Parameters​

See plugin common configurations for configuration options available to all plugins.

  • sample_ratio

    number

    default: 1

    valid value:

    between 0.00001 and 1 inclusive

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