cli

Documentation

Index

• Variables

Variables

var Backfill = &subcommands.Command{
	UsageLine: `backfill`,
	ShortDesc: `backfill a swarming task`,
	LongDesc:  `Take a swarming task ID and backfill its device health profile.`,
	CommandRun: func() subcommands.CommandRun {
		r := &backfillRun{}
		r.authFlags.Register(&r.Flags, site.DefaultAuthOptions)

		return r
	},
}

Backfill backfills a single swarming task to Karte.

var CheckServer = &subcommands.Command{
	UsageLine: `check-server`,
	ShortDesc: `health check for server`,
	LongDesc:  `Check the health of the Karte server.`,
	CommandRun: func() subcommands.CommandRun {
		r := &checkServerRun{}
		r.authFlags.Register(&r.Flags, site.DefaultAuthOptions)

		return r
	},
}

CheckServer checks the status of the Karte server.

var CreateAction = &subcommands.Command{
	UsageLine: `create-action`,
	ShortDesc: "create action",
	LongDesc:  "Create an action on the karte server.",
	CommandRun: func() subcommands.CommandRun {
		r := &createActionRun{}
		r.authFlags.Register(&r.Flags, site.DefaultAuthOptions)

		r.Flags.StringVar(&r.kind, "kind", "", "The action kind")
		r.Flags.StringVar(&r.swarmingTaskID, "task-id", "", "The ID of the swarming task")
		r.Flags.StringVar(&r.assetTag, "asset-tag", "", "The asset tag")
		r.Flags.StringVar(&r.failReason, "fail-reason", "", "The fail reason")
		r.Flags.StringVar(&r.model, "model", "", "The model of the DUT")
		r.Flags.StringVar(&r.board, "board", "", "The board of the DUT")
		r.Flags.StringVar(&r.recoveredBy, "recovered-by", "", "The action that recovered this action")
		r.Flags.IntVar(&r.restarts, "restarts", 0, "The number of times we restarted the plan")
		r.Flags.StringVar(&r.planName, "plan-name", "", "The name of the current plan")
		r.Flags.StringVar(&r.allowFail, "allow-fail", "", `whether the current action is allow to fail or not {"", "f", "u", "t"}`)
		r.Flags.StringVar(&r.actionType, "action-type", "", `what the action type is {"", "u", "v", "c", "r"}`)
		return r
	},
}

CreateAction is a CLI command that creates an action on the Karte server.

var CreateObservation = &subcommands.Command{
	UsageLine: `create-observation`,
	ShortDesc: "create observation",
	LongDesc:  "Create an observation on the karte server.",
	CommandRun: func() subcommands.CommandRun {
		r := &createObservationRun{}
		r.authFlags.Register(&r.Flags, site.DefaultAuthOptions)
		r.Flags.StringVar(&r.actionName, "action-name", "", "the action name")
		r.Flags.StringVar(&r.metricKind, "metric-kind", "", "the metric kind")
		r.Flags.StringVar(&r.value, "value", "", "value")
		return r
	},
}

CreateObservation is a CLI command that creates an observation on the Karte server.

var CronPersistToBigquery = &subcommands.Command{
	UsageLine: `cron-persist-to-bigquery`,
	ShortDesc: `Call the cron-persist-to-bigquery cron job`,
	LongDesc:  `Call the cron-persist-to-bigquery cron job`,
	CommandRun: func() subcommands.CommandRun {
		r := &cronPersistToBigqueryRun{}
		r.commonFlags.Register(&r.Flags)
		r.authFlags.Register(&r.Flags, site.DefaultAuthOptions)
		return r
	},
}

CronPersistToBigquery calls the persist-to-bigquery RPC on the karte cron service. This command is very similar to persist-action-range.

var ListActions = &subcommands.Command{
	UsageLine: `list-actions`,
	ShortDesc: "list actions",
	LongDesc:  "List all actions on the karte server.",
	CommandRun: func() subcommands.CommandRun {
		r := &listActionsRun{}
		r.commonFlags.Register(&r.Flags)
		r.authFlags.Register(&r.Flags, site.DefaultAuthOptions)
		r.Flags.StringVar(&r.filter, "filter", "", "Karte query command")

		return r
	},
}

ListActions command lists all actions in Karte.

var ListSwarmingTasks = &subcommands.Command{
	UsageLine: `list-swarming-tasks`,
	ShortDesc: `list recent swarming tasks`,
	LongDesc:  `Take the most recent 1000 actions and show which swarming tasks executed them.`,
	CommandRun: func() subcommands.CommandRun {
		r := &listSwarmingTasksRun{}
		r.authFlags.Register(&r.Flags, site.DefaultAuthOptions)
		return r
	},
}

ListSwarmingTasks lists the swarming tasks in the recent past.

var PersistActionRange = &subcommands.Command{
	UsageLine: `persist-action-range -hour`,
	ShortDesc: `Persist a single action to BigQuery in an ad hoc way`,
	LongDesc:  ``,
	CommandRun: func() subcommands.CommandRun {
		r := &persistActionRangeRun{}
		r.authFlags.Register(&r.Flags, site.DefaultAuthOptions)
		r.Flags.IntVar(&r.hours, "hours", 1, "hours before present that the query window begins")
		return r
	},
}

PersistActionRange is a command that persists a range of actions to BigQuery. Since this command is destructive, it only affects the dev instance of Karte.

var PersistSingleAction = &subcommands.Command{
	UsageLine: `persist-single-action [id]`,
	ShortDesc: `Persist a single action to BigQuery in an ad hoc way`,
	LongDesc:  ``,
	CommandRun: func() subcommands.CommandRun {
		r := &persistSingleActionRun{}
		r.commonFlags.Register(&r.Flags)
		r.authFlags.Register(&r.Flags, site.DefaultAuthOptions)
		return r
	},
}

PersistSingleAction is a command that persists a single action to BigQuery. Since this command is destructive, it only affects the dev instance of Karte.