[Docs] Update configuring_logging_links_in_the_ui.md #5861
Conversation
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]>
|
Thank you for opening this pull request! 🙌 These tips will help get your PR across the finish line:
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5861 +/- ##
==========================================
- Coverage 36.72% 34.96% -1.76%
==========================================
Files 1304 1144 -160
Lines 130072 122240 -7832
==========================================
- Hits 47764 42744 -5020
+ Misses 78138 75803 -2335
+ Partials 4170 3693 -477
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
pranshustuff
changed the title
| - displayName: AWS CloudWatch Logs | ||
| templateUris: | ||
| - "https://console.aws.amazon.com/cloudwatch/home?region={{.region}}#logEventViewer:group={{.logGroup}};stream=var.log.containers.{{.podName}}_{{.namespace}}_{{.containerName}}-{{.containerId}}.log" | ||
| prerequisites: |
There was a problem hiding this comment.
Please move the prerequisites to be a note outside of the code block as this is not a supported field.
docs/user_guide/productionizing/configuring_logging_links_in_the_ui.md
Outdated
Show resolved
Hide resolved
| @@ -58,11 +58,20 @@ task_logs: | |||
| plugins: | |||
| logs: | |||
| templates: | |||
There was a problem hiding this comment.
| templates: |
So the YAML structure would be:
plugins:
logs:
cloudwatch-enabled: true
cloudwatch-template-uri:
| - "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}}" |
There was a problem hiding this comment.
I haven't tested this one but comparing with a working environment the structure is different. Let's leave this for a different PR
| - "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}}" | ||
| - displayName: Kubernetes Dashboard Logs | ||
| templateUris: | ||
| - "{{.kubernetesUrl}}/namespace/{{.namespace}}/pods/{{.podName}}/logs/{{.containerName}}" |
There was a problem hiding this comment.
Again, haven't tried this and couldn't speak about the requirements so let's leave it out from this PR
…he_ui.md Co-authored-by: David Espejo <[email protected]> Signed-off-by: Pranshu <[email protected]>
Signed-off-by: Pranshu <[email protected]>
Signed-off-by: Pranshu <[email protected]>
Signed-off-by: Pranshu <[email protected]>
|
I have made the required changed. |
Signed-off-by: Pranshu <[email protected]>
|
@pranshustuff we'd still like to see this contribution land, and would still count towards hacktoberfest. Could you take a look at the comments I left? |
|
Yes please, if you can count it towards Hacktober fest that would be great, I'll figure out why it's not passing the unit test and send a few commits by tomorrow. |
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.
Tracking issue
Closes #5760
Why are the changes needed?
The current example is generic and uses outdated configuration:
What changes were proposed in this pull request?
I am just changing the example to be more flexible, up to date and with more specific templateUris.
Check all the applicable boxes
Docs link
https://docs.flyte.org/en/latest/user_guide/productionizing/configuring_logging_links_in_the_ui.html#configure-logging