Adding instructions to run benchmarks (#2271)
* benchmark readme for opentelemetry-sdk * benchmark instructions for all the modules * Fixing typo
This commit is contained in:
		
							parent
							
								
									59f54bdb9f
								
							
						
					
					
						commit
						f88e207f09
					
				| 
						 | 
				
			
			@ -4,3 +4,9 @@
 | 
			
		|||
 | 
			
		||||
[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
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
#### 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.
 | 
			
		||||
| 
						 | 
				
			
			@ -7,3 +7,9 @@
 | 
			
		|||
 | 
			
		||||
[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
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
#### 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.
 | 
			
		||||
| 
						 | 
				
			
			@ -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.
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -4,3 +4,9 @@
 | 
			
		|||
 | 
			
		||||
[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
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
#### 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.
 | 
			
		||||
| 
						 | 
				
			
			@ -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.
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
		Reference in New Issue