aboutsummaryrefslogtreecommitdiff
path: root/kamon-sigar/src/test/resources/readme-test.md
diff options
context:
space:
mode:
Diffstat (limited to 'kamon-sigar/src/test/resources/readme-test.md')
-rw-r--r--kamon-sigar/src/test/resources/readme-test.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/kamon-sigar/src/test/resources/readme-test.md b/kamon-sigar/src/test/resources/readme-test.md
new file mode 100644
index 00000000..4e32c2b1
--- /dev/null
+++ b/kamon-sigar/src/test/resources/readme-test.md
@@ -0,0 +1,27 @@
+
+### Kamon Sigar 1) agent 2) extractor 3) loader.
+
+To load as JVM agent:
+```
+java -javaagent:/path/to/kamon-sigar.jar
+# OR
+java -javaagent:/path/to/kamon-sigar.jar=/path/to/sigar/extract/folder ...
+
+```
+
+To load from your code:
+```
+ import java.io.File;
+ import kamon.sigar.SigarAgent;
+ import org.hyperic.sigar.Sigar;
+
+ SigarAgent.provision();
+ final Sigar sigar = new Sigar();
+
+// OR
+
+ final File extractLocation = new File("./target/native");
+ SigarAgent.provision(extractLocation);
+ final Sigar sigar = new Sigar();
+
+```