Install the vFunction OpenTelemetry Collector for a single vFunction App
Prerequisites
- Install the vFunction Server
- Create the Distributed Application in the vFunction Server UI
- Log into the vFunction Server UI after the installation has completed
- Automatically, the UI should launch the Create Application dialog box. If the dialog box is not automatically launched, click the dropdown arrow in the top-left corner and select Add Application
- Toggle the Application Type to Distributed
- Add an Application Name
- Click the blue Create button
- A dialog box will display with Installation Instructions
- Find the OTEL_EXPORTER_OTLP_HEADERS Environment Variable within the dialog box. It will include the X-VF-APP and an Application UUID. This Application UUID is needed during the Collector configuration
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 Receiver to match the Agent Port
receivers:
otlp:
protocols:
grpc:
endpoint: 0.0.0.0:4317
http:
endpoint: 0.0.0.0:4318
### Configure the Exporter to match the Backend Port
exporters:
otlphttp/vf:
endpoint: $PROTOCOL://$VFSERVER/api/unauth/otlp
headers:
X-VF-APP: $VF_APP_UUID
# If the VF Server was configured to use HTTP instead of HTTPS, you will need to enable HTTP via the "tls.insecure: true" Key and Value
# tls:
# insecure: true
### Add the Exporter to the pipeline
service:
pipelines:
traces:
receivers: [otlp]
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