bootstrap documentation

Author: SylvainJuge

jmx-scraper/README.md

@@ -7,6 +7,41 @@ The JMX MBeans and their metric mappings are defined in YAML and reuse implement
 This is currently a work-in-progress component not ready to be used in production.
 The end goal is to provide an alternative to the [JMX Gatherer](../jmx-metrics/README.md) utility.
 
+## Usage
+
+The general command to invoke JMX scraper is `java -jar scraper.jar <config>`, where `scraper.jar`
+is the `build/libs/opentelemetry-jmx-scraper-<version>.jar` packaged binary when building this module.
+
+Minimal configuration required
+- `otel.jmx.service.url` for example `service:jmx:rmi:///jndi/rmi://server:9999/jmxrmi` for `server`
+  host on port `9999` with RMI JMX connector.
+- `otel.jmx.target.system` or `otel.jmx.custom.scraping.config`
+
+Configuration can be provided through:
+- command line arguments: `java -jar scraper.jar --config `
+- system properties `java -jar scraper.jar`
+- java properties file: `java -jar config.properties`
+
+TODO: update this once autoconfiguration is supported
+
+### Configuration reference
+
+TODO
+
+### Extra libraries in classpath
+
+By default, only the RMI JMX connector is provided by the JVM, so it might be required to add extra
+libraries in the classpath when connecting to remote JVMs that are not directly accessible with RMI.
+
+One known example of this is the Wildfly/Jboss HTTP management interface for which the `jboss-client.jar`
+needs to be used to support `otel.jmx.service.url` = `service:jmx:remote+http://server:9999`.
+
+When doing so, the `java -jar` command can´t be used, we have to provide the classpath with
+`-cp`/`--class-path`/`-classpath` option and provide the main class file name:
+```
+java -cp scraper.jar:jboss-client.jar io.opentelemetry.contrib.jmxscraper.JmxScraper <config>
+```
+
 ## Component owners
 
 - [Jason Plumb](https://github.com/breedx-splk), Splunk

jmx-scraper/test-app/README.md

@@ -0,0 +1,2 @@
+This is a test CLI application that is only used for integration tests.
+The goal of this application is to publish custom MBeans in JMX and then allow end-to-end testing.

jmx-scraper/test-webapp/README.md

@@ -0,0 +1,2 @@
+This is a test web application that is only used for integration tests when metrics are published
+only when an application is deployed to the container, for example with Wildfly session metrics.