Configuring components
Set component properties in the configuration panel.
Select a node on the canvas to open its configuration panel on the right. Each component type has a form with the fields that component supports, such as endpoints, protocols, intervals, and attribute rules.
Edit a component
- Select the node on the canvas.
- Edit the fields in the configuration panel. Changes are reflected in the generated YAML immediately.
- Telflo validates the configuration as you edit and reports problems in the validation status. See Validation.
Forms are specific to each component. For example, an OTLP exporter has endpoint and TLS fields, a batch processor has size and timeout fields, and a transform processor has its OTTL statements. To parse-check the OTTL statements and conditions in a configuration outside the editor, download the YAML and run telflo ottl lint config.yaml; routing rules in the request context and legacy route statements are reported as skipped. See OTTL expressions.
The OTLP/HTTP exporter's form includes a Quick Setup dropdown that pre-fills the endpoint and authentication header for a chosen destination, with a placeholder credential to replace. Every component has an Instance Name field that creates a named instance in the YAML, such as otlphttp/staging, so the same component type can appear more than once.
For the routing connector, the form is also where its targets are set: choose each route's Target Pipelines and the Default Pipelines from dropdowns instead of drawing an outgoing connection. See Route with the routing connector.
Each component's panel also has a Raw YAML editor under Advanced: Instance & YAML for settings the form does not expose; edits there sync with the form fields. A component without a form shows the Raw YAML editor in place of the form, with the Instance Name field under Advanced. Anything else can be edited in the YAML view. The canvas and the YAML stay in sync.
Reference a variable
Reference a value stored in the vault instead of typing the same value into many fields.
- Type
@to reference an organization variable. Selecting one inserts a$orgvar:token, such as$orgvar:PROD_API_URL, which stays in the YAML and is resolved for each collector when it checks in. Update the value in the vault, and collectors receive it on their next check-in. - Type
#to insert a user variable. Selecting one inserts the variable's value into the field, so the generated YAML contains the literal value.
For credentials such as API keys and tokens, reference an environment variable with ${env:NAME} so the value comes from the host environment and is not stored in the configuration. When you install collectors for a configuration on OpenTelemetry Collector Contrib, the install dialog lists each such variable under Configuration environment variables (optional), except the variables the install already sets, such as OPAMP_TOKEN; you can include a value in the command or bundle, or leave it unchecked and provide it on the host or in the cluster. From the terminal, telflo fleet install ... --env NAME=value supplies a value the same way, and a variable the configuration reads but you did not supply appears in the printed Docker or Kubernetes command as a <value> placeholder to replace; for a Linux install, an unsupplied variable is left out of the bundle's start script and a note lists what to set on the host. A reference with a default, ${env:NAME:-default}, is not listed. See Install collectors.
Next steps
- Review the generated configuration. See YAML editor.
- Resolve issues reported by validation. See Validation.
Last updated on