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

Stabilize kv_unstable #436

Closed
3 of 4 tasks
KodrAus opened this issue Jan 8, 2021 · 9 comments · Fixed by #613
Closed
3 of 4 tasks

Stabilize kv_unstable #436

KodrAus opened this issue Jan 8, 2021 · 9 comments · Fixed by #613

Comments

@KodrAus
Copy link
Contributor

KodrAus commented Jan 8, 2021

This is part of #328

I think we've explored enough of this design space now and the API has been in use within the tide project for some time now with their own kv-capable logging macro.

By stabilizing just the backend (non-macro-supported) kv module we can let users depend on this with confidence so that projects like tracing can also utilize it.

Migration path

The kv API will remain an opt-in optional API. All features that currently begin with kv_unstable will be changed to kv. We can keep these old unstable features around for a while if we need.

Any other changes that are needed should be included here.

Steps

  • Public API review of the kv module
  • Stabilize sval
  • Stabilize value-bag
  • Documentation and examples

cc @yoshuawuyts

@Thomasdezeeuw
Copy link
Collaborator

I don't know what the plan is for the kv_unstable_std feature, but can that be removed? Surely most users mean to enable kv_unstable_std if std and kv are enabled.

@KodrAus
Copy link
Contributor Author

KodrAus commented Jan 8, 2021

@Thomasdezeeuw unfortunately it’s a limitation of Cargo features. Since it’s not possible to activate a feature of a dependency when two unrelated features are active we need one that covers them both.

@Thomasdezeeuw
Copy link
Collaborator

@KodrAus in the code you can use #[cfg(all(feature = "kv", feature = "std"))] in stead of #[cfg(feature = "kv_unstable_std")], removing the kv_unstable_std feature.

@KodrAus
Copy link
Contributor Author

KodrAus commented Jan 8, 2021

@Thomasdezeeuw we can do that in code, but we also have dependencies that need their own std features enabled too.

@Thomasdezeeuw
Copy link
Collaborator

@KodrAus could you make another release to try the new macro syntax?

@KodrAus
Copy link
Contributor Author

KodrAus commented Dec 7, 2021

@Thomasdezeeuw Will do! I'll get the ball rolling on this now.

@Thomasdezeeuw
Copy link
Collaborator

@KodrAus any update on a release? We've been using the git version without issues for a while (including the new macro syntax).

@KodrAus
Copy link
Contributor Author

KodrAus commented Feb 22, 2022

@Thomasdezeeuw I've been waiting for some feedback from the wider project on #343 (comment), but it's been a bit quiet. I'm pretty confident in the direction we're going though and that we're not heading down a path we'll regret later so will push ahead.

@KodrAus
Copy link
Contributor Author

KodrAus commented Feb 22, 2022

I've opened #485 to get a release out the door. I'm just going to run through the diff, but if you had a chance to take a look too @Thomasdezeeuw that would be much appreciated! 🙇

EFanZh pushed a commit to EFanZh/log that referenced this issue Jul 23, 2023
Bumps [tokio](https://github.com/tokio-rs/tokio) from 1.21.1 to 1.21.2.
- [Release notes](https://github.com/tokio-rs/tokio/releases)
- [Commits](tokio-rs/tokio@tokio-1.21.1...tokio-1.21.2)

---
updated-dependencies:
- dependency-name: tokio
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants