Input

This class contains all available information about a task's execution that a log plugin can use to construct task's log links. It provides details such as host and pod names, container information, log names, and various timestamps related to the pod's lifecycle. The class also includes task execution identifiers and extra template variables for flexible log link generation.

Attributes

Attribute	Type	Description
HostName	`string`	Stores the hostname where the task execution occurred, used for identifying the machine associated with the logs.
PodName	`string`	Stores the name of the Kubernetes pod where the task execution ran, used for locating pod-specific logs.
Namespace	`string`	Stores the Kubernetes namespace of the pod, used for scoping log queries to a specific environment.
ContainerName	`string`	Stores the name of the container within the pod, used for pinpointing logs from a specific process.
ContainerID	`string`	Stores the unique identifier of the container, used for direct access to container-specific log streams.
LogName	`string`	Stores the name of the log stream or file, used for distinguishing different log outputs from a single container.
PodRFC3339StartTime	`string`	Stores the start time of the pod in RFC3339 format, used for time-based filtering of logs.
PodRFC3339FinishTime	`string`	Stores the finish time of the pod in RFC3339 format, used for defining the end boundary for log retrieval.
PodUnixStartTime	`int64`	Stores the start time of the pod as a Unix timestamp, used for time-based filtering of logs.
PodUnixFinishTime	`int64`	Stores the finish time of the pod as a Unix timestamp, used for defining the end boundary for log retrieval.
PodUID	`string`	Stores the unique identifier of the pod, used for unambiguous identification of the pod across systems.
TaskExecutionID	`pluginsCore.TaskExecutionID`	Stores the identifier for the task execution, used to link logs to a specific task instance.
ExtraTemplateVars	`[][TemplateVar](templatevar.md?sid=flyteplugins_go_tasks_pluginmachinery_tasklog_templatevar)`	Stores additional variables that can be used in log link templates, allowing for flexible log URL construction.
TaskTemplate	`*core.TaskTemplate`	Stores the template definition for the task, providing structural information that might be relevant for log generation or linking.
EnableVscode	`bool`	Indicates whether VS Code integration is enabled, which might affect the generation of log links or access methods.
AgentID	`string`	Stores the identifier of the agent responsible for the task execution, used for routing or identifying the source of logs.
ConnectorID	`string`	Stores the identifier of the connector used, which can influence how logs are accessed or where they are stored.

Constructor

Signature

def Input(
    HostName: string = null,
    PodName: string = null,
    Namespace: string = null,
    ContainerName: string = null,
    ContainerID: string = null,
    LogName: string = null,
    PodRFC3339StartTime: string = null,
    PodRFC3339FinishTime: string = null,
    PodUnixStartTime: int64 = null,
    PodUnixFinishTime: int64 = null,
    PodUID: string = null,
    TaskExecutionID: pluginsCore.TaskExecutionID = null,
    ExtraTemplateVars: [][TemplateVar](templatevar.md?sid=flyteplugins_go_tasks_pluginmachinery_tasklog_templatevar) = null,
    TaskTemplate: *core.TaskTemplate = null,
    EnableVscode: boolean = null,
    AgentID: string = null,
    ConnectorID: string = null
) - > null

Parameters

Name	Type	Description
HostName	`string` = null	The hostname where the task is executed.
PodName	`string` = null	The name of the Kubernetes pod.
Namespace	`string` = null	The Kubernetes namespace of the pod.
ContainerName	`string` = null	The name of the container within the pod.
ContainerID	`string` = null	The ID of the container.
LogName	`string` = null	The name of the log.
PodRFC3339StartTime	`string` = null	The start time of the pod in RFC3339 format.
PodRFC3339FinishTime	`string` = null	The finish time of the pod in RFC3339 format.
PodUnixStartTime	`int64` = null	The start time of the pod in Unix timestamp format.
PodUnixFinishTime	`int64` = null	The finish time of the pod in Unix timestamp format.
PodUID	`string` = null	The unique identifier of the pod.
TaskExecutionID	`pluginsCore.TaskExecutionID` = null	The ID of the task execution.
ExtraTemplateVars	`[][TemplateVar](templatevar.md?sid=flyteplugins_go_tasks_pluginmachinery_tasklog_templatevar)` = null	Additional template variables.
TaskTemplate	`*core.TaskTemplate` = null	The task template.
EnableVscode	`boolean` = null	Indicates if VSCode is enabled.
AgentID	`string` = null	The ID of the agent.
ConnectorID	`string` = null	The ID of the connector.

Methods

`templateVars()`

@classmethod
def templateVars() - > [][TemplateVar](templatevar.md?sid=flyteplugins_go_tasks_pluginmachinery_tasklog_templatevar)

Retrieves a list of template variables that can be used to construct log links. This method provides access to dynamic values relevant to the task's execution.

Returns

Type	Description
`[][TemplateVar](templatevar.md?sid=flyteplugins_go_tasks_pluginmachinery_tasklog_templatevar)`	A list of TemplateVar objects, each containing a key-value pair for template substitution.

Attributes​

Constructor​

Signature​

Parameters​

Methods​

templateVars()​

Returns​