telegraf/migrations/inputs_procstat/migration.go

package inputs_procstat

import (
	"fmt"

	"github.com/influxdata/toml"
	"github.com/influxdata/toml/ast"

	"github.com/influxdata/telegraf/internal/choice"
	"github.com/influxdata/telegraf/migrations"
)

// Migration function
func migrate(tbl *ast.Table) ([]byte, string, error) {
	// Decode the old data structure
	var plugin map[string]interface{}
	if err := toml.UnmarshalTable(tbl, &plugin); err != nil {
		return nil, "", err
	}

	// Check for deprecated option(s) and migrate them
	var applied bool
	if oldUnits, found := plugin["supervisor_unit"]; found {
		applied = true

		// Check if the new option already exists and merge the two
		var units []string
		if newUnits, found := plugin["supervisor_units"]; found {
			nu, ok := newUnits.([]interface{})
			if !ok {
				return nil, "", fmt.Errorf("setting 'supervisor_units' has wrong type %T", newUnits)
			}
			for _, raw := range nu {
				u, ok := raw.(string)
				if !ok {
					return nil, "", fmt.Errorf("setting 'supervisor_units' contains wrong type %T", raw)
				}
				units = append(units, u)
			}
		}
		ou, ok := oldUnits.([]interface{})
		if !ok {
			return nil, "", fmt.Errorf("setting 'supervisor_unit' has wrong type %T", oldUnits)
		}
		for _, raw := range ou {
			u, ok := raw.(string)
			if !ok {
				return nil, "", fmt.Errorf("setting 'supervisor_unit' contains wrong type %T", raw)
			}
			if !choice.Contains(u, units) {
				units = append(units, u)
			}
		}
		plugin["supervisor_units"] = units

		// Remove deprecated setting
		delete(plugin, "supervisor_unit")
	}

	// The tagging options both need the 'tag_with' setting
	var tagwith []string
	newTagWith, found := plugin["tag_with"]
	if found {
		ntw, ok := newTagWith.([]interface{})
		if !ok {
			return nil, "", fmt.Errorf("setting 'tag_with' has wrong type %T", newTagWith)
		}
		for _, raw := range ntw {
			s, ok := raw.(string)
			if !ok {
				return nil, "", fmt.Errorf("setting 'tag_with' contains wrong type %T", raw)
			}
			if !choice.Contains(s, tagwith) {
				tagwith = append(tagwith, s)
			}
		}
	}

	// Tagging with PID
	if oldPidTag, found := plugin["pid_tag"]; found {
		applied = true

		pt, ok := oldPidTag.(bool)
		if !ok {
			return nil, "", fmt.Errorf("setting 'pid_tag' has wrong type %T", oldPidTag)
		}

		// Add the pid-tagging to 'tag_with' if requested
		if pt && !choice.Contains("pid", tagwith) {
			tagwith = append(tagwith, "pid")
			plugin["tag_with"] = tagwith
		}

		// Remove deprecated setting
		delete(plugin, "pid_tag")
	}

	// Tagging with command-line
	if oldCmdlinedTag, found := plugin["cmdline_tag"]; found {
		applied = true

		ct, ok := oldCmdlinedTag.(bool)
		if !ok {
			return nil, "", fmt.Errorf("setting 'cmdline_tag' has wrong type %T", oldCmdlinedTag)
		}

		// Add the pid-tagging to 'tag_with' if requested
		if ct && !choice.Contains("cmdline", tagwith) {
			tagwith = append(tagwith, "cmdline")
			plugin["tag_with"] = tagwith
		}

		// Remove deprecated setting
		delete(plugin, "cmdline_tag")
	}

	// No options migrated so we can exit early
	if !applied {
		return nil, "", migrations.ErrNotApplicable
	}

	// Create the corresponding plugin configurations
	cfg := migrations.CreateTOMLStruct("inputs", "procstat")
	cfg.Add("inputs", "procstat", plugin)

	output, err := toml.Marshal(cfg)
	return output, "", err
}

// Register the migration function for the plugin type
func init() {
	migrations.AddPluginOptionMigration("inputs.procstat", migrate)
}