Telegraf Controller release notes

v1.0.1

Download Telegraf Controller v1.0.1

Features

• Serve the web UI on a separate port from the API using the UI_PORT option, for deployments that run the web UI behind a reverse proxy.
• When serving the web UI on a separate port, configure the API URL and the allowed CORS origins with the PUBLIC_API_URL, PUBLIC_API_PORT, PUBLIC_UI_URL, and PUBLIC_UI_PORT options for reverse-proxy and remapped-port deployments.
• Sort the agent list by column (Agent Details, Status, Last Reported), backed by sortBy and sortOrder query parameters on GET /api/agents.
• Accept both postgresql:// and postgres:// connection string schemes and tolerate quoted DATABASE_URL values.
• Accept command-line flags in both --flag value and --flag=value forms and validate port options at startup.

Bug fixes

• Sync the agents quota counter with manual refresh and polling.
• Fix an environment-variable example typo on the add-configuration page.

v1.0.0

Features

• Telegraf Enterprise features
  • Add enterprise license management with entitlement validation.
  • Add LDAP authentication with configurable directory connection settings.
  • Add OpenID Connect (OIDC) single sign-on with identity provider configuration.
  • Add per-provider authentication settings for LDAP and OIDC.
  • Add role mapping and automatic user provisioning from your identity provider.
  • Add an identity provider info endpoint for client auth discovery.
  • Enhance invite management with authentication provider support and an updated invite user form.
  • Add audit logging with configurable settings and retention.
• Add auth configuration, license, and entitlements in the token permissions grid when creating an API token.
• Replace Swagger UI with the Scalar API reference at /api/docs.
• Configure Telegraf Controller public URLs to use in generated commands and configurations.
• Add the TELEGRAF_CONTROLLER_TOKEN environment variable as the preferred way to set the Telegraf Controller API token. INFLUX_TOKEN continues to work for backward compatibility.
• Track configuration links during heartbeat batch processing.

Security

• Add TLS support for the heartbeat server.
• Add SSL/TLS support for PostgreSQL connections.
• Sign release artifacts during the release build.

Bug fixes

• Eliminate input lag on the configuration add page name and description fields.
• Fix a crash on the agent detail page caused by a numeric status value.
• Replace the humantime formatter with a custom formatter for consistent time formatting.
• Limit the length of reporting rule descriptions.
• Fix agent auto-deletion.
• Fix login screen flickering and improve the authentication flow.

v0.0.7-beta

Features

• Preserve in raw TOML in code editor mode. TOML is no longer reformatted on save when using the code editor.
• Redesign the configuration detail page to be more compact and make Use this configuration more prominent.
• Add plugin support to the Telegraf Builder UI:
  • Libvirt (inputs.libvirt)
  • Linux CPU (inputs.linux_cpu)
  • Linux Sysctl FS (inputs.linux_sysctl_fs)
  • LogQL (inputs.logql)
  • Logstash (inputs.logstash)
  • Lustre2 (inputs.lustre2)
  • LVM (inputs.lvm)
  • Mailchimp (inputs.mailchimp)
  • MarkLogic (inputs.marklogic)
  • MAVLink (inputs.mavlink)
  • Mcrouter (inputs.mcrouter)
  • Mdstat (inputs.mdstat)
  • Memcached (inputs.memcached)
  • Mesos (inputs.mesos)
  • Minecraft (inputs.minecraft)
  • Mock (inputs.mock)
  • Modbus (inputs.modbus)
  • MongoDB (inputs.mongodb)
  • Monit (inputs.monit)

Security

• Only allow endpoint authorization control on startup using the DISABLED_AUTH_ENDPOINTS environment variable or --disable-auth-endpoints command flag. For more information, see the breaking change.

Bug fixes

• Add missing permission resources to the token creation UI.

v0.0.6-beta

Features

• Separate managed and external configurations on the agent detail page.
• Enhance Heartbeat plugin with HTTP client configuration options for transport, TLS, OAuth2, and Cookie Auth.
• Add plugin support to the Telegraf Builder UI:
  • Intel PMU (inputs.intel_pmu)
  • Intel PowerStat (inputs.intel_powerstat)
  • Intel RDT (inputs.intel_rdt)
  • Internal (inputs.internal)
  • Internet Speed (inputs.internet_speed)
  • Interrupts (inputs.interrupts)
  • IPMI Sensor (inputs.ipmi_sensor)
  • Ipset (inputs.ipset)
  • Iptables (inputs.iptables)
  • Jenkins (inputs.jenkins)
  • Jolokia2 Agent (inputs.jolokia2_agent)
  • JTI OpenConfig Telemetry (inputs.jti_openconfig_telemetry)
  • Kafka Consumer (inputs.kafka_consumer)
  • Kapacitor (inputs.kapacitor)
  • Kernel Vmstat (inputs.kernel_vmstat)
  • IPVS (inputs.ipvs)
  • Kibana (inputs.kibana)
  • Kinesis Consumer (inputs.kinesis_consumer)
  • KNX Listener (inputs.knx_listener)
  • Kubernetes (inputs.kubernetes)
  • Kubernetes Inventory (inputs.kube_inventory)
  • Lanz (inputs.lanz)
  • LDAP (inputs.ldap)
  • LeoFS (inputs.leofs)

Bug fixes

• Fix typo in TOML parsing rename configuration.

v0.0.5-beta

Important changes

This release introduces user and account management, API token authentication, and configurable authentication options. By default, authentication is required to interact with all API endpoints. If you have agents reading configurations from and reporting heartbeats to Telegraf Controller, they will begin to fail with authorization errors.

To avoid agent authorization errors:

1. Temporarily disable authentication on the Heartbeat and Configs APIs. You can use either the --disable-auth-endpoints command flag or the DISABLED_AUTH_ENDPOINTS environment variable when starting Telegraf Controller.

   Command flags Environment Variables

   telegraf_controller --disable-auth-endpoints=configs,heartbeat

   export DISABLED_AUTH_ENDPOINTS="configs,heartbeat"
   
   telegraf_controller --disable-auth-endpoints=configs,heartbeat

2. Create an API token with read permissions on the Configs API and write permissions on the Heartbeat API.

3. Use the INFLUX_TOKEN environment variable to define the token option in your heartbeat output plugin configuration:

   [[outputs.heartbeat]]
   # ...
   token = "${INFLUX_TOKEN}"

4. Define the INFLUX_TOKEN environment variable in your Telegraf environment:

   export INFLUX_TOKEN=
   YOUR_TELEGRAF_CONTROLLER_TOKEN
   
   telegraf --config "https://localhost:8888/api/configs/..."

   Replace YOUR_TELEGRAF_CONTROLLER_TOKEN with your Telegraf Controller API token.

   It’s important to use the INFLUX_TOKEN environment variable. When present, Telegraf uses this specific variable to set the token used in the Authorization header when requesting the configuration.

5. Navigate to the Settings page in Telegraf Controller and reenable authentication on the Configs and Heartbeat APIs. Save your changes.

Features

• Add user authentication and session management with login and setup pages.
• Add user management with invite system, password reset, and password complexity validation.
• Add token management with create workflow and management pages.
• Add account management page with ownership transfer flow.
• Add settings page.
• Add application version retrieval and display.
• Enhance Heartbeat plugin with logs, status configurations, and agent status checks.
• Add dynamic parsing component support for Exec and Google Cloud PubSub Push plugins.
• Add plugin support to the Telegraf Builder UI:
  • Aerospike (inputs.aerospike)
  • Alibaba Cloud Monitor Service (Aliyun) (inputs.aliyuncms)
  • Amazon Elastic Container Service (inputs.ecs)
  • AMD ROCm System Management Interface (SMI) (inputs.amd_rocm_smi)
  • AMQP Consumer (inputs.amqp_consumer)
  • Apache (inputs.apache)
  • APC UPSD (inputs.apcupsd)
  • Apache Aurora (inputs.aurora)
  • Azure Queue Storage (inputs.azure_storage_queue)
  • Bcache (inputs.bcache)
  • Beanstalkd (inputs.beanstalkd)
  • Beat (inputs.beat)
  • BIND 9 Nameserver (inputs.bind)
  • Bond (inputs.bond)
  • Burrow (inputs.burrow)
  • Ceph Storage (inputs.ceph)
  • chrony (inputs.chrony)
  • Cisco Model-Driven Telemetry (MDT) (inputs.cisco_telemetry_mdt)
  • ClickHouse (inputs.clickhouse)
  • Google Cloud PubSub Push (inputs.cloud_pubsub_push)
  • Amazon CloudWatch Metric Streams (inputs.cloudwatch_metric_streams)
  • Netfilter Conntrack (inputs.conntrack)
  • Hashicorp Consul (inputs.consul)
  • Hashicorp Consul Agent (inputs.consul_agent)
  • Bosch Rexroth ctrlX Data Layer (inputs.ctrlx_datalayer)
  • Mesosphere Distributed Cloud OS (inputs.dcos)
  • Device Mapper Cache (inputs.dmcache)
  • Data Plane Development Kit (DPDK) (inputs.dpdk)
  • Elasticsearch (inputs.elasticsearch)
  • Ethtool (inputs.ethtool)
  • Exec (inputs.exec)
  • Fibaro (inputs.fibaro)
  • File (inputs.file)
  • Filecount (inputs.filecount)
  • File statistics (inputs.filestat)
  • Fireboard (inputs.fireboard)
  • AWS Data Firehose (inputs.firehose)
  • Fluentd (inputs.fluentd)
  • Fritzbox (inputs.fritzbox)
  • GitHub (inputs.github)
  • gNMI (gRPC Network Management Interface) (inputs.gnmi)
  • Google Cloud Storage (inputs.google_cloud_storage)
  • GrayLog (inputs.graylog)
  • HAProxy (inputs.haproxy)
  • HDDtemp (inputs.hddtemp)
  • HTTP (inputs.http)
  • HTTP Listener v2 (inputs.http_listener_v2)
  • HueBridge (inputs.huebridge)
  • Hugepages (inputs.hugepages)
  • Icinga2 (inputs.icinga2)
  • InfiniBand (inputs.infiniband)
  • InfluxDB (inputs.influxdb)
  • InfluxDB Listener (inputs.influxdb_listener)
  • InfluxDB V2 Listener (inputs.influxdb_v2_listener)
  • Intel Baseband Accelerator (inputs.intel_baseband)
  • Intel® Dynamic Load Balancer (inputs.intel_dlb)
  • Intel® Platform Monitoring Technology (inputs.intel_pmt)

Bug fixes

• Fix default Heartbeat plugin configuration and environment variable exports.

v0.0.4-alpha

Features

• Require InfluxData EULA acceptance before starting the server.
• Add plugin support to the Telegraf Builder UI and TOML parser:
  • ActiveMQ (inputs.activemq)
  • Vault (secretstores.vault)
  • All parsers
  • All serializers
• Add support for custom logs directory.
• Reduce binary size.

Bug fixes

• Fix question mark position in deletion popup.

v0.0.3-alpha

Features

• Add linux-arm64 binary support.
• Add build validation for missing plugins.
• Add local file handling for configurations.

v0.0.2-alpha

Features

• Identify external configurations for Telegraf agents.
• Add SSL support for backend connections.
• Add health check status API endpoint.
• Add Last-Modified header to GET TOML API response and remove duplicate protocol handling.
• Compile native Rust NAPI server for heartbeat service.

Bug fixes

• Fix default parsing unit to use seconds.
• Fix command line string generation.

v0.0.1-alpha

Initial alpha build of Telegraf Controller.