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

Create 2023-11-28-logging.md #146

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

Conversation

StreamingDataApps
Copy link
Collaborator

first draft of logging API, where's the beef? I'm not sure what else to cover, little meat on the bone.

first draft of logging API, where's the beef?
@SirCipher
Copy link
Member

@StreamingDataApps, I'd detail how logging works at each level. I.e, you can connect to a node to listen for events logged directly to the node as well as events produced by the node's lanes, then the same for planes, hosts etc. Then detail connecting to a server to listen to the events.

@SirCipher SirCipher marked this pull request as draft January 19, 2024 18:14
Illustrating the use of logging from various contexts. Next, will move this to the reference area.
Move logging to the reference section.
@StreamingDataApps
Copy link
Collaborator Author

@StreamingDataApps, I'd detail how logging works at each level. I.e, you can connect to a node to listen for events logged directly to the node as well as events produced by the node's lanes, then the same for planes, hosts etc. Then detail connecting to a server to listen to the events.

@SirCipher @ajay-gov I've added explanatory content.

@afolson I was sure about some of the structural bits, so I've probably neglected some required ritual...

Copy link
Member

@ajay-gov ajay-gov left a comment

Choose a reason for hiding this comment

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

@StreamingDataApps the structure of the site here is quite different from the live site. Seems like you are using an older version. Can you merge main into your branch and then make the changes in the right place. That way it will be easier to review. Thanks

Copy link
Member

@ajay-gov ajay-gov left a comment

Choose a reason for hiding this comment

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

We should mention the following before going to the example

  • Calls to the logging API are non-blocking
  • Logs for an agent or a host can be streamed using the introspection API.

For the example, it ill be good to show how to stream the debug logs or the info logs for a specific agent using the introspection APIs with the swim-cli (We can link to the introspection APIs section and the swim-cli section), refer to: https://github.com/swimos/swim-cellular?tab=readme-ov-file#log-introspection

Also noticed a typo- "Objecct"

@ajay-gov ajay-gov linked an issue Mar 11, 2024 that may be closed by this pull request
Mention that the following before going to the example: 

- Calls to the logging API are non-blocking
- Logs for an agent or a host can be streamed using the introspection API.
Copy link

netlify bot commented Mar 12, 2024

Deploy Preview for scintillating-strudel-60ff56 ready!

Name Link
🔨 Latest commit 89fbb83
🔍 Latest deploy log https://app.netlify.com/sites/scintillating-strudel-60ff56/deploys/65f08600fbfc8d0008d6d9bc
😎 Deploy Preview https://deploy-preview-146--scintillating-strudel-60ff56.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 configuration.

@StreamingDataApps
Copy link
Collaborator Author

@ajay-gov @SirCipher logging has been updated and is ready for review

@ajay-gov ajay-gov marked this pull request as ready for review March 12, 2024 20:55
@ajay-gov ajay-gov self-assigned this Mar 15, 2024
@StreamingDataApps StreamingDataApps removed their assignment May 6, 2024
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.

Docs: Understanding the Swim logging API
3 participants