Update documentation to point to new snapshot and release repositories
MODIFY
CONTRIBUTING.md
CONTRIBUTING.md
@@ -71,7 +71,7 @@ following "clusters" of classes:
- `auto-tooling-and-instrumentation.isolated/` - contains `agent-tooling`
module and `instrumentation` submodules, loaded and isolated inside
-`AgentClassLoader`. Including OpenTelemetry SDK.
+`AgentClassLoader`. Including OpenTelemetry SDK (and the built-in exporters when using the `-all` artifact).
- `io/opentelemetry/auto/bootstrap/` - contains `agent-bootstrap` module and
available in bootstrap classloader.
- `io/opentelemetry/auto/shaded/` - contains OpenTelemetry API and its
@@ -83,19 +83,8 @@ Gradle plugin.
#### Snapshot builds
For developers testing code changes before a release is complete, there are
-snapshot builds of the `master` branch. When a PR is merged to `master`, a
-circleci build is kicked off as a github action which shows up as a github
-check on the git commit on `master` branch, i.e. a green checkmark. Clicking
-on the green checkmark you can view the `build_test_deploy` workflow and the
-`build` job shows the artifacts hosted on circleci. The artifacts will be
-named like:
-
-```
-libs/opentelemetry-auto-<version>-SNAPSHOT.jar
-libs/opentelemetry-auto-exporter-jaeger-<version>-SNAPSHOT.jar
-libs/opentelemetry-auto-exporter-logging-<version>-SNAPSHOT.jar
-libs/opentelemetry-auto-exporter-otlp-<version>-SNAPSHOT.jar
-```
+snapshot builds of the `master` branch. They are available from
+[JFrog OSS repository](https://oss.jfrog.org/artifactory/oss-snapshot-local/io/opentelemetry/auto/)
#### Building from source
@@ -104,7 +93,7 @@ Build using Java 11:
```gradle assemble```
and then you can find the java agent artifact at
-`java-agent/build/lib/opentelemetry-auto-<version>.jar`.
+`java-agent/build/lib/opentelemetry-auto-<version>-all.jar`.
### Testing

MODIFY
README.md
README.md
This project provides a Java agent JAR that can be attached to any Java 7+
application and dynamically injects bytecode to capture telemetry from a
-number of popular libraries and frameworks. The telemetry data can exported
-in a variety of formats each provided as their own independent JAR. In
-addition, the agent and exporter can be configured via command line arguments
+number of popular libraries and frameworks.
+The telemetry data can be exported in a variety of formats.
+In addition, the agent and exporter can be configured via command line arguments
or environment variables. The net result is the ability to gather telemetry
data from a Java application without code changes.
## Getting Started
-Download the [latest
-release](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases)
-of the Java agent and available exporters.
+[ ![Download](https://api.bintray.com/packages/open-telemetry/maven/opentelemetry-java-instrumentation/images/download.svg) ](https://bintray.com/open-telemetry/maven/opentelemetry-java-instrumentation/_latestVersion)
+
+The easiest way to start is to download "all-in" package, which includes instrumentation agent,
+instrumentations for all supported libraries and all available data exporters.
+This provides completely automatic out of the box experience.
+TODO add here screenshot from Bintray download list.
The instrumentation agent is enabled using the `-javaagent` flag to the JVM.
-Configuration parameters are passed as Java system properties (`-D` flags) or
-as environment variables. Both the Java agent and exporter configuration must
-be defined before the application JAR. For example:
+```
+java -javaagent:path/to/opentelemetry-auto-<version>-all.jar \
+ -jar myapp.jar
+```
+By default OpenTelemetry Java agent uses
+[OTLP exporter](https://github.com/open-telemetry/opentelemetry-java/tree/master/exporters/otlp)
+configured to send data to
+[OpenTelemetry collector](https://github.com/open-telemetry/opentelemetry-collector/blob/master/receiver/otlpreceiver/README.md)
+at `localhost:55680`.
+Configuration parameters are passed as Java system properties (`-D` flags) or
+as environment variables (see below for full list). For example:
```
-java -javaagent:path/to/opentelemetry-auto-<version>.jar \
- -Dota.exporter.jar=path/to/opentelemetry-auto-exporter-jaeger-<version>.jar \
- -Dota.exporter.jaeger.endpoint=localhost:14250 \
- -Dota.exporter.jaeger.service.name=shopping \
+java -javaagent:path/to/opentelemetry-auto-<version>-all.jar \
+ -Dota.exporter=zipkin
-jar myapp.jar
```
@@ -48,6 +57,7 @@ only supports gRPC as its communications protocol.
| System property | Environment variable | Purpose |
|----------------------------------|----------------------------------|----------------------------------------------------------------------|
+| ota.exporter=jaeger | OTA_EXPORTER=jaeger | To select Jaeger exporter |
| ota.exporter.jaeger.endpoint | OTA_EXPORTER_JAEGER_ENDPOINT | The Jaeger endpoint to connect to. Currently only gRPC is supported. |
| ota.exporter.jaeger.service.name | OTA_EXPORTER_JAEGER_SERVICE_NAME | The service name of this JVM instance |
@@ -56,6 +66,7 @@ A simple wrapper for the Zipkin exporter of opentelemetry-java. It POSTs json in
| System property | Environment variable | Purpose |
|----------------------------------|----------------------------------|----------------------------------------------------------------------|
+| ota.exporter=zipkin | OTA_EXPORTER=zipkin | To select Zipkin exporter |
| ota.exporter.zipkin.endpoint | OTA_EXPORTER_ZIPKIN_ENDPOINT | The Zipkin endpoint to connect to. Currently only HTTP is supported. |
| ota.exporter.zipkin.service.name | OTA_EXPORTER_ZIPKIN_SERVICE_NAME | The service name of this JVM instance
@@ -65,6 +76,7 @@ A simple wrapper for the OTLP exporter of opentelemetry-java.
| System property | Environment variable | Purpose |
|----------------------------------|----------------------------------|----------------------------------------------------------------------|
+| ota.exporter=otlp (default) | OTA_EXPORTER=otlp | To select OpenTelemetry exporter (default) |
| ota.exporter.jar | OTA_EXPORTER_JAR | Path to the exporter fat-jar that you want to use |
| ota.exporter.otlp.endpoint | OTA_EXPORTER_OTLP_ENDPOINT | The OTLP endpoint to connect to. |
@@ -75,6 +87,7 @@ attributes to stdout. It is used mainly for testing and debugging.
| System property | Environment variable | Purpose |
|-----------------------------|-----------------------------|------------------------------------------------------------------------------|
+| ota.exporter=logging | OTA_EXPORTER=logging | To select logging exporter |
| ota.exporter.logging.prefix | OTA_EXPORTER_LOGGING_PREFIX | An optional string that is printed in front of the span name and attributes. |
##### Customizing the OpenTelemetry SDK
@@ -233,9 +246,6 @@ High-level roadmap:
[opentelemetry-specification#522](https://github.com/open-telemetry/opentelemetry-specification/issues/522))
* See issues with label
[specification](https://github.com/open-telemetry/opentelemetry-java-instrumentation/labels/specification)
-* Simpler exporter configuration
- * See issue
- [#370](https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/370)
* Great documentation
* See issues with label
[documentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation/labels/documentation)

MODIFY
RELEASING.md
RELEASING.md
@@ -9,7 +9,8 @@ to calculate the current version based on git tags. This plugin looks for the la
## Snapshot builds
Every successful CI build of the master branch automatically executes `./gradlew snapshot` as the last task.
-This signals Nebula plugin to build and publish to JFrog OSS repository next _minor_ release version.
+This signals Nebula plugin to build and publish to
+[JFrog OSS repository](https://oss.jfrog.org/artifactory/oss-snapshot-local/io/opentelemetry/auto/)next _minor_ release version.
This means version `vX.(Y+1).0-SNAPSHOT`.
## Public releases
@@ -23,7 +24,8 @@ On new tag creation a CI will start a new release build.
It will do the following:
- Checkout requested tag.
- Run `./gradlew -Prelease.useLastTag=true final`.
-This signals Nebula plugin to build `X.Y.0` version and to publish it to [Bintray repository](https://bintray.com/open-telemetry/maven).
+This signals Nebula plugin to build `X.Y.0` version and to publish it to
+[Bintray repository](https://bintray.com/open-telemetry/maven/opentelemetry-java-instrumentation).
## Patch releases
Whenever a fix is needed to any older branch, a PR should be made into the corresponding maintenance branch.

Update documentation to point to new snapshot and release repositories (#516)