Install the vFunction OpenTelemetry Collector for a single vFunction App
Installation Steps
The steps below assume that the OpenTelemetry (OTEL) Collector will be used only by one vFunction Application.
-
Install the OTEL Collector, following the Operating System-specific documentation from OpenTelemetry
-
Edit the Collector’s config.yaml based on your distribution and installation method, e.g.
/etc/otelcol
- Find-and-replace $PROTOCOL with http or https depending on how the VF Server was configured
- Find-and-replace $VF_SERVER_ADDRESS with the URL for login to your organization’s vFunction Server
- Find-and-replace $VF_APP_UUID with the one provided by the VF Server UI in the Installation Instructions
### Set the Extension to forward Headers from the Request
extensions:
health_check:
headers_setter:
headers:
- action: insert
key: X-VF-APP
from_context: X-VF-APP
### Set the Receiver to match the Agent Port
receivers:
otlp:
protocols:
grpc:
endpoint: 0.0.0.0:4317
http:
endpoint: 0.0.0.0:4318
### Set the Processor to keep specific Headers from the Request
processors:
batch:
metadata_keys:
- X-VF-APP
### Configure the Exporter to match the Backend Port
exporters:
otlphttp/vf:
endpoint: $PROTOCOL://$VFSERVER/api/unauth/otlp
headers:
X-VF-APP: $VF_APP_UUID
### Add the Exporter to the pipeline
service:
pipelines:
traces:
receivers: [otlp]
processors: [batch]
exporters: [otlphttp/vf]
- Restart the OpenTelemetry Collector Service. For example:
sudo systemctl restart otelcol
- Use the Application to initiate traffic for the environment
- Start Learning in the vFunction Server UI and continue using the Application