flyte icon indicating copy to clipboard operation
flyte copied to clipboard

[Docs] Update configuring_logging_links_in_the_ui.md

Open pranshustuff opened this issue 1 year ago • 2 comments

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

  • [x] I updated the documentation accordingly.
  • [x] All new and existing tests passed.
  • [x] All commits are signed-off.

Docs link

https://docs.flyte.org/en/latest/user_guide/productionizing/configuring_logging_links_in_the_ui.html#configure-logging

pranshustuff avatar Oct 18 '24 12:10 pranshustuff

Thank you for opening this pull request! 🙌

These tips will help get your PR across the finish line:

  • Most of the repos have a PR template; if not, fill it out to the best of your knowledge.
  • Sign off your commits (Reference: DCO Guide).

welcome[bot] avatar Oct 18 '24 12:10 welcome[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 34.96%. Comparing base (38af4ec) to head (c1fb886). Report is 245 commits behind head on master.

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     
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 54.02% <ø> (-0.42%) :arrow_down:
unittests-flytecopilot 11.73% <ø> (ø)
unittests-flytectl ?
unittests-flyteidl 6.92% <ø> (+0.03%) :arrow_up:
unittests-flyteplugins 53.64% <ø> (+0.01%) :arrow_up:
unittests-flytepropeller 42.90% <ø> (+0.05%) :arrow_up:
unittests-flytestdlib 55.41% <ø> (+0.62%) :arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar Oct 18 '24 18:10 codecov[bot]

I have made the required changed.

pranshustuff avatar Oct 30 '24 12:10 pranshustuff

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

davidmirror-ops avatar Nov 05 '24 20:11 davidmirror-ops

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.

pranshustuff avatar Nov 05 '24 20:11 pranshustuff

This is using the old pattern. We should switch log links to use Templates everywhere.

eapolinario avatar Dec 19 '24 18:12 eapolinario