open-telemetry
/
opentelemetry-java
mirror of https://github.com/open-telemetry/opentelemetry-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adding instructions to run benchmarks (#2271) 

* benchmark readme for opentelemetry-sdk

* benchmark instructions for all the modules

* Fixing typo
This commit is contained in:
Prashant Srivastava 2020-12-10 21:40:16 -08:00 committed by GitHub
parent 59f54bdb9f
commit f88e207f09
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 35 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
api/baggage/README.md
View File

@ -3,4 +3,10 @@
[![Javadocs][javadoc-image]][javadoc-url]
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-api-baggage.svg
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-api-baggage
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-api-baggage
---
#### Running micro-benchmarks
From the root of the repo run `./gradlew clean :opentelemetry-api-baggage:jmh` to run all the benchmarks
or run `./gradlew clean :opentelemetry-api-baggage:jmh -PjmhIncludeSingleClass=<ClassNameHere>`
to run a specific benchmark class.

8
api/trace/README.md
View File

@ -6,4 +6,10 @@
implementations of the OpenTelemetry library.
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-api-trace.svg
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-api-trace
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-api-trace
---
#### Running micro-benchmarks
From the root of the repo run `./gradlew clean :opentelemetry-api-trace:jmh` to run all the benchmarks
or run `./gradlew clean :opentelemetry-api-trace:jmh -PjmhIncludeSingleClass=<ClassNameHere>`
to run a specific benchmark class.

7
extensions/trace-propagators/README.md
View File

@ -26,3 +26,10 @@ bugs should be filed with the respective vendors themselves.
Extension providers that do not receive adequate support/maintenance by their respective vendors
will become candidates for future removal.
---
#### Running micro-benchmarks
From the root of the repo run `./gradlew clean :opentelemetry-extension-trace-propagators:jmh`
to run all the benchmarks
or run `./gradlew clean :opentelemetry-extension-trace-propagators:jmh -PjmhIncludeSingleClass=<ClassNameHere>`
to run a specific benchmark class.

8
sdk-extensions/aws/README.md
View File

@ -3,4 +3,10 @@
[![Javadocs][javadoc-image]][javadoc-url]
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-aws.svg
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-aws
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-aws
---
#### Running micro-benchmarks
From the root of the repo run `./gradlew clean :opentelemetry-sdk-extension-aws:jmh` to run all the benchmarks
or run `./gradlew clean :opentelemetry-sdk-extension-aws:jmh -PjmhIncludeSingleClass=<ClassNameHere>`
to run a specific benchmark class.

7
sdk/all/README.md
View File

@ -5,3 +5,10 @@ OpenTelemetry SDK
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk.svg
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk
---
#### Running micro-benchmarks
From the root of the repo run `./gradlew clean :opentelemetry-sdk:jmh` to run all the benchmarks
or run `./gradlew clean :opentelemetry-sdk:jmh -PjmhIncludeSingleClass=<ClassNameHere>`
to run a specific benchmark class.