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

Are there docs/examples for the logging functionality? #2302

Open
Falmarri opened this issue Sep 8, 2023 · 5 comments
Open

Are there docs/examples for the logging functionality? #2302

Falmarri opened this issue Sep 8, 2023 · 5 comments
Assignees
Labels
Stale triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@Falmarri
Copy link

Falmarri commented Sep 8, 2023

The last release marks logging as public. But I don't see any docs about this. Is this intended to be a general purpose logging framework? I'm currently using spdlog, but I have structure hacked into it. If this project also is intending to support native structured logging, I'm very interested. But I'm hesitant given there seems to be 0 documentation.

@github-actions github-actions bot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Sep 8, 2023
@marcalff marcalff added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Sep 11, 2023
@marcalff
Copy link
Member

This is missing, and part of the plan ...

@ThomsonTan
Copy link
Contributor

@Falmarri , our API docs are still under progress. Our API is intended for general purpose logging, but currently we only support OpenTelemetry backend (SDK&exporter). Wondering which logging scenario you are interested in.

Copy link

This issue was marked as stale due to lack of activity.

@github-actions github-actions bot added the Stale label Nov 25, 2023
@Falmarri
Copy link
Author

@ThomsonTan Basically structured logging to files, with arbitrary key/value pairs. Specifically we log in ECS format. But also the ability to use arbitrary key values. I currently hack this using spdlog and some custom json. Ideally it would work somewhat similar to python logs (with the knowledge that python is much more flexible here), such that some form/version of

logger.info("Some message", key="value", **{"event.duration": 1000})

would result in

{"@timestamp": ..., "log": {"level": "info", "logger": "whatever"}, "message": {"Some message"}, "event": {"duration": 1000}, "key": "value"}

Or some similar syntax.

Basically, just files and/or stdout. We have a lot of logging framework built to eventually get ingested by our ELK stack.

@github-actions github-actions bot removed the Stale label Nov 27, 2023
Copy link

This issue was marked as stale due to lack of activity.

@github-actions github-actions bot added the Stale label Jan 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Stale triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

3 participants