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

mark heatmap crate as deprecated #110

Merged
merged 1 commit into from
Apr 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 2 additions & 13 deletions heatmap/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,22 +1,11 @@
[package]
name = "heatmap"
version = "0.7.8"
version = "0.8.0"
authors = ["Brian Martin <brian@pelikan.io>"]
edition = "2021"
license = "Apache-2.0"
description = "Heatmap datastructure for tracking distributions across a time window"
description = "Deprecated. Use histogram crate directly"
homepage = "https://github.com/pelikan-io/rustcommon/heatmap"
repository = "https://github.com/pelikan-io/rustcommon"

[dependencies]
clocksource = { version = "0.6.0" }
histogram = { version = "0.7.4" }
parking_lot = "0.12.1"
thiserror = "1.0.34"

[dev-dependencies]
criterion = "0.4.0"

[[bench]]
name = "heatmap"
harness = false
32 changes: 4 additions & 28 deletions heatmap/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,6 @@
# histogram
# heatmap

A simple histogram implementation inspired by HDRHistogram and our base-2
implementation from [ccommon]. It uses atomic counters to record increments for
each value.
This crate is deprecated. We instead recommend that the [histogram] crate is
used directly.

## Getting Started

### Building

rustcommon is built with the standard Rust toolchain which can be installed and
managed via [rustup](https://rustup.rs) or by following the directions on the
Rust [website](https://www.rust-lang.org/).

#### View library documentation
```bash
cargo doc --open
```

## Support

Create a [new issue](https://github.com/pelikan-io/rustcommon/issues/new) on GitHub.

## Authors

* Brian Martin <brayniac@gmail.com>

A full list of [contributors] can be found on GitHub.

[contributors]: https://github.com/pelikan-io/rustcommon/graphs/contributors?type=a
[histogram]: https://crates.io/crates/histogram
31 changes: 0 additions & 31 deletions heatmap/benches/heatmap.rs

This file was deleted.

46 changes: 0 additions & 46 deletions heatmap/src/error.rs

This file was deleted.

Loading
Loading