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 configuring_logging_links_in_the_ui.md #5861

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

[Docs] Update configuring_logging_links_in_the_ui.md #5861

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4eb076a
Update configuring_logging_links_in_the_ui.md
pranshustuff Oct 18, 2024
0130985
Update docs/user_guide/productionizing/configuring_logging_links_in_t…
pranshustuff Oct 30, 2024
3b94438
Update configuring_logging_links_in_the_ui.md
pranshustuff Oct 30, 2024
577f570
Update configuring_logging_links_in_the_ui.md
pranshustuff Oct 30, 2024
6acbfe1
Update configuring_logging_links_in_the_ui.md
pranshustuff Oct 30, 2024
c1fb886
Update configuring_logging_links_in_the_ui.md
pranshustuff Nov 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions docs/user_guide/productionizing/configuring_logging_links_in_the_ui.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,20 @@ task_logs:
plugins:
logs:
templates:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
templates:

So the YAML structure would be:

  plugins:
    logs:
      cloudwatch-enabled: true
      cloudwatch-template-uri:

- displayName: <name-to-show>
- displayName: AWS CloudWatch Logs
templateUris:
pranshustuff marked this conversation as resolved.
Show resolved Hide resolved
- "https://console.aws.amazon.com/cloudwatch/home?region={{.region}}#logEventViewer:group={{.logGroup}};stream=var.log.containers.{{.podName}}_{{.namespace}}_{{.containerName}}-{{.containerId}}.log"
prerequisites:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please move the prerequisites to be a note outside of the code block as this is not a supported field.

- EKS Cluster enabled with CloudWatch Observability Add-on
- Ensure the pod emits logs to CloudWatch log streams
- displayName: GCP Stackdriver Logs
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"
- "https://console.cloud.google.com/logs/viewer?project={{.gcpProject}}&resource=k8s_container&advancedFilter=resource.labels.pod_name={{.podName}}&resource.labels.container_name={{.containerName}}&resource.labels.namespace_id={{.namespace}}"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't tested this one but comparing with a working environment the structure is different. Let's leave this for a different PR

- displayName: Kubernetes Dashboard Logs
templateUris:
- "{{.kubernetesUrl}}/namespace/{{.namespace}}/pods/{{.podName}}/logs/{{.containerName}}"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, haven't tried this and couldn't speak about the requirements so let's leave it out from this PR

messageFormat: 0 # Optional: 0 = "unknown", 1 = "csv", 2 = "json"

```

:::{tip}
Expand Down
Loading