redpanda-data / redpanda-data/connect

Verbose mode for echo to expand templates used.

Open
#1,074 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

configuration enhancement ux
Dominant language
Go
Stars
8.8k
Forks
969
Avg merge
1d 13h
Merged PRs (30d)
64

Description

Right now echo is treating used templates as first-class components.

This means that the output of:

benthos -t "./templates/*.yaml" -c ./config.yaml echo

does not show the values that where used from the template. So when following the example on the templating page the output of:

benthos -t "./templates/*.yaml" -c ./config.yaml echo

is:

input:
  label: ""
  aws_sqs_list:
    urls:
      - https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue1
      - https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue2

It would help with writing complex templates to add echo_verbose or another method so that the output of the above command would be:

input:
  broker:
    inputs:
      - aws_sqs:
          url: https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue1
          region: us-east-1
      - aws_sqs:
          url: https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue2
          region: us-east-1

Currently the only way to see if your template is working is by running the config, that is not always desirable.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the benthos ... echo command and the templating page linked in the issue. Determine how an expanded-template display mode should be exposed, then verify that running the command shows the resolved input structure without running the configuration. No source files or tests are named, so locating the CLI and its existing echo behavior is required.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.