-
Notifications
You must be signed in to change notification settings - Fork 3
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
base: main
Are you sure you want to change the base?
Conversation
first draft of logging API, where's the beef?
@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. |
Illustrating the use of logging from various contexts. Next, will move this to the reference area.
Move logging to the reference section.
@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... |
There was a problem hiding this 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
There was a problem hiding this 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"
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.
✅ Deploy Preview for scintillating-strudel-60ff56 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
@ajay-gov @SirCipher logging has been updated and is ready for review |
first draft of logging API, where's the beef? I'm not sure what else to cover, little meat on the bone.