Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Docs] Update logging links documentation for Cloudwatch #5760

Open
2 tasks done
Tracked by #5783
davidmirror-ops opened this issue Sep 18, 2024 · 4 comments · May be fixed by #5861
Open
2 tasks done
Tracked by #5783

[Docs] Update logging links documentation for Cloudwatch #5760

davidmirror-ops opened this issue Sep 18, 2024 · 4 comments · May be fixed by #5861
Assignees
@oluwatobi2001
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest

Comments

@davidmirror-ops
Copy link
Contributor

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
@davidmirror-ops davidmirror-ops added documentation Improvements or additions to documentation untriaged This issues has not yet been looked at by the Maintainers labels Sep 18, 2024
@eapolinario eapolinario removed the untriaged This issues has not yet been looked at by the Maintainers label Sep 19, 2024
@davidmirror-ops davidmirror-ops removed their assignment Sep 26, 2024
@davidmirror-ops davidmirror-ops mentioned this issue Sep 28, 2024
Open
56 tasks
@oluwatobi2001
Copy link

Hi interested

@3kis
Copy link

3kis commented Oct 6, 2024

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

@vinayJ74
Copy link

vinayJ74 commented Oct 9, 2024

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

@davidmirror-ops
Copy link
Contributor Author

@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.

pranshustuff added a commit to pranshustuff/flyte that referenced this issue Oct 18, 2024
@pranshustuff
Update configuring_logging_links_in_the_ui.md
4eb076a 
Fixes flyteorg#5760

Added log templates for AWS CloudWatch, GCP Stackdriver, and Kubernetes logs with their templateUris in new example.

Also included prerequisites for CloudWatch Observability on EKS.


Signed-off-by: Pranshu <[email protected]>
@pranshustuff pranshustuff linked a pull request Oct 18, 2024 that will close this issue
Open
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@oluwatobi2001 oluwatobi2001

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest
Projects
Flyte Issues/PRs maintenance
Status: Assigned
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Docs] Update configuring_logging_links_in_the_ui.md pranshustuff/flyte
5 participants
@eapolinario @oluwatobi2001 @3kis @davidmirror-ops @vinayJ74