docs(release): update docs for 0.5.2 release

Author: omarabid

CHANGELOG.md

@@ -1,3 +1,21 @@
+# v0.5.2
+## New features
+- Authentication Token support
+
+## API Changes
+- use rust-tls instead of openssl
+
+# v0.5.1
+## API Changes
+- Backend shutdown bug
+- Docs update
+
+# v0.5.0
+## API Changes
+- New API for building, starting and stopping the profiling agent.
+- Backend supports reporting multiple threads.
+- Tagging within local thread-scope
+
 # v0.4.0
 ## API Changes
 - Backend now support passing a configuration struct.

Cargo.toml

@@ -5,7 +5,7 @@ Pyroscope Profiler Agent for continuous profiling of Rust, Python and Ruby appli
 """
 keywords = ["pyroscope", "profiler", "profiling", "pprof"]
 authors = ["Abid Omar <[email protected]>"]
-version = "0.5.1"
+version = "0.5.2"
 edition = "2021"
 license = "Apache-2.0"
 homepage = "https://pyroscope.io/docs/rust"

README.md

@@ -32,7 +32,7 @@ Add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-pyroscope = "0.5.0"
+pyroscope = "0.5.2"
 pyroscope_pprofrs = "0.2"
 ```
 
@@ -83,8 +83,7 @@ The Pyroscope Agent doesn't do any profiling. The agent role is to orchasrate a
 ### Limitations
 
 - **Backend**: The Pyroscope Agent uses [pprof-rs](https://github.com/tikv/pprof-rs) as a backend. As a result, the [limitations](https://github.com/tikv/pprof-rs#why-not-) for pprof-rs also applies.
-- **Tagging**: ~~Adding or removing tags is not possible within threads. In general, the [Pyroscope Agent](https://docs.rs/pyroscope/latest/pyroscope/pyroscope/struct.PyroscopeAgent.html) is not Sync; and as a result a reference cannot be shared between threads. A multi-threaded program could be profiled but the agent is not thread-aware and a particular thread cannot be tagged.~~
-As of 0.5.0, the Pyroscope Agent support tagging within threads. Check the [Tags](examples/tags.rs) and [Multi-Thread](examples/multi-thread.rs) examples for usage.
+- **Tagging**: As of 0.5.0, the Pyroscope Agent support tagging within threads. Check the [Tags](examples/tags.rs) and [Multi-Thread](examples/multi-thread.rs) examples for usage.
 - **Timer**: epoll (for Linux) and kqueue (for macOS) are required for a more precise timer.
 - **Shutdown**: The Pyroscope Agent might take some time (usually less than 10 seconds) to shutdown properly and drop its threads. For a proper shutdown, it's recommended that you run the `shutdown` function before dropping the Agent.