From a92c697e2451f32ce47da22b601d73059ad48ad8 Mon Sep 17 00:00:00 2001
From: Tolya Korniltsev <korniltsev.anatoly@gmail.com>
Date: Tue, 14 Feb 2023 15:13:33 +0700
Subject: [PATCH] docs: doc link (#82)

---
 README.md | 62 +------------------------------------------------------
 1 file changed, 1 insertion(+), 61 deletions(-)

diff --git a/README.md b/README.md
index b994716..ec93d90 100644
--- a/README.md
+++ b/README.md
@@ -16,67 +16,7 @@ Visit [releases](https://github.com/pyroscope-io/pyroscope-java/releases) page t
 
 ## Usage
 
-To run a Java application with the agent:
-```shell
-java -javaagent:pyroscope.jar -jar app.jar
-```
-
-On the startup, the agent deploys the native corresponding library into `/tmp/${username}-pyroscope/`.
-
-## Configuration
-
-The agent is configured using environment variables.
-
-- `PYROSCOPE_APPLICATION_NAME`: The application name used when uploading profiling data. Generated if not provided.
-- `PYROSCOPE_PROFILING_INTERVAL`: Sets the profiling interval in nanoseconds or in other units, if N is followed by `ms` (for milliseconds), `us` (for microseconds), or `s` (for seconds). See [async-profiler documentation](https://github.com/jvm-profiling-tools/async-profiler) for details. The default is `10ms`.
-- `PYROSCOPE_UPLOAD_INTERVAL`: Sets the profiling interval for uploading snapshots. The default is `10s`.
-- `PYROSCOPE_PROFILER_EVENT`: Sets the profiling event. See [async-profiler documentation](https://github.com/jvm-profiling-tools/async-profiler) for details. The supported values are `cpu`, `alloc`, `lock`, `wall`, and `itimer`. The defaults is `itimer`.
-- `PYROSCOPE_LOG_LEVEL`: The log level: `debug`, `info`, `warn`, `error`. The default is `info`.
-- `PYROSCOPE_SERVER_ADDRESS`: The address of the Pyroscope server. The default is `http://localhost:4040`.
-- `PYROSCOPE_AUTH_TOKEN`: The authorization token used to upload profiling data.
-
-### JFR format and multiple event support
-
-Starting with version v0.5.0 JFR format is supported to be able to support multiple events (JFR is the only output format that supports [multiple events in `async-profiler`](https://github.com/jvm-profiling-tools/async-profiler#multiple-events)).
-It currently supports the following events:
-- jdk.ExecutionSample (supported in `pyroscope-java >= 0.5.0` and `pyroscope >= 0.13.0`), used for CPU sampling events (`itimer`, `cpu`, `wall`).
-- jdk.ObjectAllocationInNewTLAB (supported in `pyroscope-java >= 0.5.0` and `pyroscope >= 0.14.0`), used for alloc sampling.
-- jdk.ObjectAllocationOutsideTLAB (supported in `pyroscope-java >= 0.5.0` and `pyroscope >= 0.14.0`), used for alloc sampling.
-- jdk.JavaMonitorEnter (supported in `pyroscope-java >= 0.6.0` and `pyroscope >= 0.15.0`), used for lock profiling.
-- jdk.ThreadPark (supported in `pyroscope-java >= 0.6.0` and `pyroscope >= 0.15.0`), used for lock profiling.
-
-There are several environment variables that define how multiple event configuration works:
-
-- `PYROSCOPE_FORMAT` sets the profiler output format. The default is `collapsed`, but in order to support multiple formats it must be set to `jfr`.
-- `PYROSCOPE_PROFILER_EVENT` sets the profiler event. With JFR format enabled, this event refers to one of the possible CPU profiling events: `itimer`, `cpu`, `wall`. The default is `itimer`.
-- `PYROSCOPE_PROFILER_ALLOC` sets the allocation threshold to register the events, in bytes (equivalent to `--alloc=` in `async-profiler`). The default value is "" - empty string, which means that allocation profiling is disabled. Setting it to `0` will register all the events.
-- `PYROSCOPE_PROFILER_LOCK` sets the lock threshold to register the events, in nanoseconds (equivalent to `--lock=` in `async-profiler`). The default value is "" - empty string, which means that lock profiling is disabled. Setting it to `0` will register all the events.
-
-### Labels
-
-It is possible to add dynamic tags (labels) to the profiling data. These tags can be used to filter the data in the UI.
-
-Add pyroscope dependency to your `build.gradle`:
-```kotlin
-implementation("io.pyroscope:agent:${pyroscope_version}")
-```
-Add labels dynamically:
-```java
-import io.pyroscope.labels.LabelsSet;
-import io.pyroscope.labels.Pyroscope;
-
-Pyroscope.LabelsWrapper.run(new LabelsSet("controller", "slow_controller"), () -> {
-    slowCode();
-});
-```
-
-It is also possible to possible to add static tags (labels) to the profiling data:
-
-```java
-import io.pyroscope.labels.Pyroscope;
-
-Pyroscope.setStaticLabels(Map.of("REGION", System.getenv("REGION")));
-```
+Visit [docs](https://pyroscope.io/docs/java/) page for usage and configuration documentation.
 
 ## Building