YAML editor

View and edit the generated Collector YAML, and apply changes back to the canvas.

The YAML tab shows the OpenTelemetry Collector configuration that Telflo generates from the canvas. It is a code editor based on Monaco, with syntax highlighting, find, and completion and hover help driven by the collector configuration schema. Line numbers, the minimap, the font size, and the indentation follow your editor preferences. When the editor finds schema errors, a YAML Validation Error banner above it counts them.

How the two views sync

The canvas and the YAML are two views of the same configuration.

  • Edit the canvas, and the YAML updates immediately.
  • Edit the YAML, and the editor enters manual edit mode. Apply the changes to update the canvas.

In manual edit mode, the Configuration tab and, when present, the Testing tab are disabled, and the canvas is frozen behind an In Manual Edit Mode overlay that shows the current validation result, Validating..., Yaml is Valid, Errors must be corrected., or, when the validation service cannot be reached, Validation unavailable — YAML not checked., until you finish:

  • Apply rebuilds the canvas from the edited YAML. It is available once the YAML passes validation: the editor's schema markers must be clear, and the collector validation that runs a couple of seconds after you stop typing must report config valid for the configuration's collector distribution and version. While that check runs, the button's tooltip reads Validating...; while errors remain, it reads Validation Errors Exist. When the validation service is unavailable, Apply stays available and its tooltip reads Validation unavailable — applying unchecked YAML.
  • Undo All discards the manual edits and leaves manual edit mode.

If a manual edit cannot be parsed or does not validate, the issue is reported in the YAML view so you can correct it before applying. If the validation service cannot be reached, the status row shows validation unavailable · config not checked with the reason beneath it, and the YAML is treated as unchecked rather than invalid: you can still apply it, but no collector has confirmed it. The check runs again on your next edit or change of collector version. See Validation.

Shortcuts

ShortcutAction
Ctrl/Cmd+ZUndo
Ctrl/Cmd+Shift+ZRedo
Ctrl/Cmd+FFind
Ctrl/Cmd+/Toggle comment

Export the configuration

  • Download YAML configuration in the YAML view's header saves the configuration as config.yaml.
  • Copy YAML to clipboard, next to it, copies the YAML.
  • From the terminal, telflo config pull <id> -o config.yaml writes a version's YAML to a file and reports the collector it is pinned to, and telflo config push <id> -f config.yaml sends edited YAML back after validating it against the pinned collector version. See Commands.

To run a configuration on collectors, use Fleet management, which keeps collectors in sync automatically instead of requiring a manual file copy.

Next steps

Last updated on

On this page