Skip to content

Commit

Permalink
fix comments (flyteorg#309)
Browse files Browse the repository at this point in the history
Signed-off-by: byronhsu <[email protected]>

Signed-off-by: byronhsu <[email protected]>
  • Loading branch information
ByronHsu authored Jan 19, 2023
1 parent 6297c94 commit be58134
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions flyteplugins/go/tasks/pluginmachinery/tasklog/template.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (

// A simple log plugin that supports templates in urls to build the final log link. Supported templates are:
// {{ .podName }}: Gets the pod name as it shows in k8s dashboard,
// {{ .podUID }}: Gets the pod UID,
// {{ .namespace }}: K8s namespace where the pod runs,
// {{ .containerName }}: The container name that generated the log,
// {{ .containerId }}: The container id docker/crio generated at run time,
Expand Down Expand Up @@ -153,11 +154,14 @@ func (s TemplateLogPlugin) GetTaskLogs(input Input) (Output, error) {
// NewTemplateLogPlugin creates a template-based log plugin with the provided template Uri and message format. Supported
// templates are:
// {{ .podName }}: Gets the pod name as it shows in k8s dashboard,
// {{ .podUID }}: Gets the pod UID,
// {{ .namespace }}: K8s namespace where the pod runs,
// {{ .containerName }}: The container name that generated the log,
// {{ .containerId }}: The container id docker/crio generated at run time,
// {{ .logName }}: A deployment specific name where to expect the logs to be.
// {{ .hostname }}: The hostname where the pod is running and where logs reside.
// {{ .podUnixStartTime }}: The pod creation time (in unix seconds, not millis)
// {{ .podUnixFinishTime }}: Don't have a good mechanism for this yet, but approximating with time.Now for now
func NewTemplateLogPlugin(templateUris []string, messageFormat core.TaskLog_MessageFormat) TemplateLogPlugin {
return TemplateLogPlugin{
templateUris: templateUris,
Expand Down

0 comments on commit be58134

Please sign in to comment.