influxdata / influxdata/influxdb

UI Telegrafs: Extract and display required ENV options for the telegraf config as part of the install instructions

Open
#19,301 0 comments 0 reactions 0 assignees View on GitHub
team/ui
Dominant language
Rust
Stars
31.7k
Forks
3.7k
Avg merge
13h 37m
Merged PRs (30d)
8

Description

in many telegraf configs, the user uses environment variables to do substitution when telegraf starts. you can use these for INFLUX_TOKEN or INFLUX_ORG in many templates. https://github.com/influxdata/telegraf/blob/master/docs/CONFIGURATION.md#environment-variables

We should be able to extract that information and display it to the user when we show them the install instructions for a telegraf.

If there are environment variables in the configuration, then we should change step 2 to include those after setting the influx token.

![image](https://user-images.githubusercontent.com/4805997/90043578-25b91580-dc81-11ea-9ed7-8e6d71ccefa2.png)

Contributor guide

Open the contributing guide

Research direction

Start by locating the UI code that renders Telegraf install instructions and the configuration extraction path, then review how environment-variable references are represented. Done means the displayed step 2 includes the configuration’s required environment variables when any are present, while preserving the existing instructions when none are found.

Written by the indexing model from the issue text.

Assessment

Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.