[Docs] Update logging links documentation for Cloudwatch

[davidmirror-ops]

Description

The current docs page includes an example that is generic and uses outdated configuration:

task_logs:
  plugins:
    logs:
      templates:
        - displayName: <name-to-show>
          templateUris:
            - "https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logEventViewer:group=/flyte-production/kubernetes;stream=var.log.containers.{{.podName}}_{{.namespace}}_{{.containerName}}-{{.containerId}}.log"
            - "https://some-other-source/home?region=us-east-1#logEventViewer:group=/flyte-production/kubernetes;stream=var.log.containers.{{.podName}}_{{.namespace}}_{{.containerName}}-{{.containerId}}.log"
          messageFormat: 0 # this parameter is optional, but use 0 for "unknown", 1 for "csv", or 2 for "json

Considering the notes and fields on the current struct:

flyte/flyteplugins/go/tasks/logs/config.go

Lines 11 to 34 in 0eaa20e

	type LogConfig struct {
	IsCloudwatchEnabled bool `json:"cloudwatch-enabled" pflag:",Enable Cloudwatch Logging"`
	// Deprecated: Please use CloudwatchTemplateURI
	CloudwatchRegion string `json:"cloudwatch-region" pflag:",AWS region in which Cloudwatch logs are stored."`
	// Deprecated: Please use CloudwatchTemplateURI
	CloudwatchLogGroup string `json:"cloudwatch-log-group" pflag:",Log group to which streams are associated."`
	CloudwatchTemplateURI tasklog.TemplateURI `json:"cloudwatch-template-uri" pflag:",Template Uri to use when building cloudwatch log links"`
	IsKubernetesEnabled bool `json:"kubernetes-enabled" pflag:",Enable Kubernetes Logging"`
	// Deprecated: Please use KubernetesTemplateURI
	KubernetesURL string `json:"kubernetes-url" pflag:",Console URL for Kubernetes logs"`
	KubernetesTemplateURI tasklog.TemplateURI `json:"kubernetes-template-uri" pflag:",Template Uri to use when building kubernetes log links"`
	IsStackDriverEnabled bool `json:"stackdriver-enabled" pflag:",Enable Log-links to stackdriver"`
	// Deprecated: Please use StackDriverTemplateURI
	GCPProjectName string `json:"gcp-project" pflag:",Name of the project in GCP"`
	// Deprecated: Please use StackDriverTemplateURI
	StackdriverLogResourceName string `json:"stackdriver-logresourcename" pflag:",Name of the logresource in stackdriver"`
	StackDriverTemplateURI tasklog.TemplateURI `json:"stackdriver-template-uri" pflag:",Template Uri to use when building stackdriver log links"`
	DynamicLogLinks map[string]tasklog.TemplateLogPlugin `json:"dynamic-log-links" pflag:"-,Map of dynamic log links"`
	Templates []tasklog.TemplateLogPlugin `json:"templates" pflag:"-,"`
	}

The Cloudwatch example should use the supported fields and a baselinetemplateUri structure, indicating the prerequisites for log links to work on EKS ( Cloudwatch Observability for EKS add-on).

Also the base Helm values should include the config structure, with logging disabled by default.

---

Are you sure this issue hasn't been raised already?

• Yes

Have you read the Code of Conduct?

• Yes

[oluwatobi2001]

Hi interested

[3kis]

hi! i'm interested in this issue, can you assign me ?

[vinayJ74]

can you assign me this i would love to contribute in this issue

[davidmirror-ops]

@vinayJ74 @3kis @oluwatobi2001 thanks for your interest in contributing. Remember that the hacktoberfest-accepted label is granted to the first merged PR, regardless if it came from the issue assignee or from someone else. Let us know any questions.