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.

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

docs: logging configuration guide #6648

Merged
merged 12 commits into from Aug 22, 2022
Merged

docs: logging configuration guide #6648

merged 12 commits into from Aug 22, 2022

Conversation

pandemicsyn
Copy link
Contributor

@pandemicsyn pandemicsyn commented Aug 18, 2022

Includes:

  • A primer on how logging works
  • The different parts of the logging yaml (with lots of links for folks to go explore and RTFM the python docs)
  • A example local config
  • Configs for GCP and Datadog (including a very basic Datadog Agent example config)
  • A list of some common fields and their description
  • A quick jq tip to get folks 🤔 about how all they can slice and dice locally

closes: #3398

@netlify
Copy link

netlify bot commented Aug 18, 2022

Deploy Preview for meltano ready!

Name Link
🔨 Latest commit dcd48a7
🔍 Latest deploy log https://app.netlify.com/sites/meltano/deploys/6303a9b777348f00089ab043
😎 Deploy Preview https://deploy-preview-6648--meltano.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@pandemicsyn
Copy link
Contributor Author

@tayloramurphy we've chatted about doing this for users a bunch and I really wanted to finally get this documented, so did this outside of an official iteration - hope thats cool 🙏

@pandemicsyn
Copy link
Contributor Author

@pnadolny13 are you using cloudwatch to capture logs for squared or anything?

/cc @aaronsteers you mentioned you've used cloudwatch a lot in the past - any specific recipe we should include for CloudWatch alongside the Datadog and GCP ones or does the generic version cover it ?

@pandemicsyn pandemicsyn changed the title docs: Logging guide docs: logging configuration guide Aug 18, 2022
@pandemicsyn pandemicsyn marked this pull request as ready for review August 18, 2022 23:56
@codecov
Copy link

codecov bot commented Aug 19, 2022

Codecov Report

Merging #6648 (dcd48a7) into main (4cbeb8a) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #6648   +/-   ##
=======================================
  Coverage   82.53%   82.53%           
=======================================
  Files         178      178           
  Lines       11333    11333           
  Branches     1549     1549           
=======================================
  Hits         9354     9354           
  Misses       1719     1719           
  Partials      260      260           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Collaborator

@tayloramurphy tayloramurphy left a comment

Choose a reason for hiding this comment

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

Love this @pandemicsyn ! Just a few questions and suggestions.

docs/src/_tutorials/logging.md Outdated Show resolved Hide resolved
docs/src/_tutorials/logging.md Outdated Show resolved Hide resolved
docs/src/_tutorials/logging.md Outdated Show resolved Hide resolved
docs/src/_tutorials/logging.md Outdated Show resolved Hide resolved
docs/src/_tutorials/logging.md Outdated Show resolved Hide resolved
docs/src/_tutorials/logging.md Outdated Show resolved Hide resolved
@aaronsteers
Copy link
Contributor

@pandemicsyn

any specific recipe we should include for CloudWatch alongside the Datadog and GCP ones or does the generic version cover it ?

I think the generic covers it! 👍

Thanks for creating this. I think it will be a big help.

Copy link
Contributor

@aaronsteers aaronsteers left a comment

Choose a reason for hiding this comment

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

Nothing blocking from my side. I like the comments/suggestions from @tayloramurphy, and I think a demo and walkthrough/talkthrough of these options could be super helpful sometime in the future.

Copy link
Collaborator

@edgarrmondragon edgarrmondragon left a comment

Choose a reason for hiding this comment

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

🎉 This looks great!

I wonder if this would feel more at home in /concepts or /guide. This document doesn't feel directed towards a learning experience or the user developing confidence with a tool or concept, in contrast to something like Create a Custom Extractor.

This all from what I grasped at the Diátaxis workshop:

A tutorial serves the needs of the user who is at study. Its obligation is to provide a successful learning experience. A how-to guide serves the needs of the user who is at work. Its obligation is to help the user accomplish a task. These are completely different needs and obligations, and they are why the distinction between tutorials and how-guides matters: tutorials are learning-oriented, and how-to guides are task-oriented.

https://diataxis.fr/tutorials-how-to/

Florian Hines and others added 3 commits August 20, 2022 12:46
Co-authored-by: Taylor A. Murphy <taylor@meltano.com>
Co-authored-by: Taylor A. Murphy <taylor@meltano.com>
Co-authored-by: Taylor A. Murphy <taylor@meltano.com>
@pandemicsyn
Copy link
Contributor Author

pandemicsyn commented Aug 20, 2022

🎉 This looks great!

I wonder if this would feel more at home in /concepts or /guide.

@edgarrmondragon I'd be ok with any of those. Guide especially makes a lot of sense I think.

@pandemicsyn pandemicsyn merged commit 749b2f9 into main Aug 22, 2022
@pandemicsyn pandemicsyn deleted the docs-logging-cookbook branch August 22, 2022 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document various useful logging.yaml config examples
4 participants