Use SkyWalking for OpenFunction as an Observability Solution

Learn how to use SkyWalking for OpenFunction as an observability solution.

This document describes how to use SkyWalking for OpenFunction as an observability solution.

Overview

Although FaaS allows developers to focus on their business code without worrying about the underlying implementations, it is difficult to troubleshoot the service system. OpenFunction tries to introduce capabilities of observability to improve its usability and stability.

SkyWalking provides solutions for observing and monitoring distributed systems in many different scenarios. OpenFunction has bundled go2sky(SkyWalking’s Golang agent) in OpenFunction tracer options to provide distributed tracing, statistics of function performance, and functions dependency map.

Prerequisites

Tracing Parameters

The following table describes the tracing parameters.

NameDescriptionExample
enabledSwitch for tracing, default to false.true, false
provider.nameProvider name can be set to “skywalking”, “opentelemetry” (pending).“skywalking”
provider.oapServerThe oap server address.“skywalking-opa:11800”
tagsA collection of key-value pairs for Span custom tags in tracing.
tags.funcThe name of function. It will be automatically filled.“function-a”
tags.layerIndicates the type of service being tracked. It should be set to “faas” when you use the function.“faas”
baggageA collection of key-value pairs, exists in the tracing and also needs to be transferred across process boundaries.

The following is a JSON formatted configuration reference that guides the formatting structure of the tracing configuration.

  1. {
  2.   "enabled": true,
  3.   "provider": {
  4.     "name": "skywalking",
  5.     "oapServer": "skywalking-oap:11800"
  6.   },
  7.   "tags": {
  8.     "func": "function-a",
  9.     "layer": "faas",
  10.     "tag1": "value1",
  11.     "tag2": "value2"
  12.   },
  13.   "baggage": {
  14.     "key": "key1",
  15.     "value": "value1"
  16.   }
  17. }

Enable Tracing Configuration of OpenFunction

Option 1: global configuration

This document uses skywalking-oap.default:11800 as an example of the skywalking-oap address in the cluster.

  1. Run the following command to modify the configmap openfunction-config in the openfunction namespace.

    1. kubectl edit configmap openfunction-config -n openfunction

  2. Modify the content under data.plugins.tracing by referring to the following example and save the change.

    1. data:
    2.   plugins.tracing: |
    3.     enabled: true
    4.     provider:
    5.       name: "skywalking"
    6.       oapServer: "skywalking-oap:11800"
    7.     tags:
    8.       func: tracing-function
    9.       layer: faas
    10.       tag1: value1
    11.       tag2: value2
    12.     baggage:
    13.       key: "key1"
    14.       value: "value1"

Option 2: function-level configuration

To enable tracing configuration in the function-level, add the field plugins.tracing under metadata.annotations in the function manifest as the following example.

  1. metadata:
  2.   name: tracing-function
  3.   annotations:
  4.     plugins.tracing: |
  5.       enabled: true
  6.       provider:
  7.         name: "skywalking"
  8.         oapServer: "skywalking-oap:11800"
  9.       tags:
  10.         func: tracing-function
  11.         layer: faas
  12.         tag1: value1
  13.         tag2: value2
  14.       baggage:
  15.         key: "key1"
  16.         value: "value1"

It is recommended that you use the global tracing configuration, or you have to add function-level tracing configuration for every function you create.

Use SkyWalking as a Distributed Tracing Solution

  1. Create functions by referring to this document.

  2. Then, you can observe the flow of entire link on the SkyWalking UI.

    Use SkyWalking for OpenFunction as an Observability Solution - 图1

  3. You can also observe the comparison of the response time of the Knative runtime function (function-front) in the running state and under cold start.

    In cold start:

    Use SkyWalking for OpenFunction as an Observability Solution - 图2

    In running:

    Use SkyWalking for OpenFunction as an Observability Solution - 图3

Last modified April 13, 2022: docs(zh): add skywalking solution best practice (#57) (436cd0a)