Install the vFunction OpenTelemetry Collector for a single vFunction App
Installation Steps
The steps below assume that the OpenTelemetry (OTEL) Collector will be used by multiple vFunction Applications. Alternatively, follow these steps to install the Collector to be used only one vFunction Application.
-
Install the OTEL Collector Contributor, 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-contrib
- 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
extensions:
health_check:
headers_setter:
headers:
- action: insert
key: X-VF-APP
from_context: X-VF-APP
receivers:
otlp:
protocols:
grpc:
endpoint: 0.0.0.0:4317
http:
endpoint: 0.0.0.0:4318
include_metadata: true
processors:
batch:
metadata_keys:
- X-VF-APP
exporters:
otlphttp/vf:
endpoint: $PROTOCOL://$VFSERVER/api/unauth/otlp
auth:
authenticator: headers_setter
service:
extensions: [health_check, headers_setter]
pipelines:
traces:
receivers: [otlp]
processors: [batch]
exporters: [otlphttp/vf]
- Restart the OpenTelemetry Collector Service. For example:
sudo systemctl restart otelcol-contrib
- Modify the Application’s Startup Parameters to include the vFunction Application taken from the vFunction Server UI’s Installation Instructions (Find-and-replace $VF_APP_ID)
- Java Application’s JAVA_OPTS: -Dotel.exporter.otlp.traces.headers=X-VF-APP=$VF_APP_ID
- .NET Application’s Environmental Variables: OTEL_EXPORTER_OTLP_HEADERS=X-VF-APP=$VF_APP_ID
- Restart the Application
- Use the Application to initiate traffic for the environment
- Start Learning in the vFunction Server UI and continue using the Application