Update change log for 1.13.0 (#303)

open-telemetry · Apr 20, 2022 · 412fc5a · 412fc5a
1 parent ad24968
commit 412fc5a
Show file tree

Hide file tree

Showing 5 changed files with 87 additions and 50 deletions.
diff --git a/.github/scripts/draft-change-log-entries.sh b/.github/scripts/draft-change-log-entries.sh
@@ -18,5 +18,11 @@ else
   prior_version="$major.$((minor - 1)).0"
 fi
 
-git log --reverse --pretty=format:"- %s" "v$prior_version"..HEAD \
-  | sed -r 's,\(#([0-9]+)\),\n  ([#\1](https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/\1)),'
+for component in aws-xray consistent-sampling jfr-streaming jmx-metrics maven-extension runtime-attach samplers; do
+  echo "### $component"
+  echo
+  git log --reverse --pretty=format:"- %s" "v$prior_version"..HEAD $component \
+    | sed -r 's,\(#([0-9]+)\),\n    ([#\1](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/\1)),'
+  echo
+  echo
+done
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,14 @@
 
 ## Version 1.13.0 (unreleased)
 
+All components updated to target OpenTelemetry SDK 1.13.0.
+
+### Consistent sampling - New 🌟
+
+This component adds various Sampler implementations for consistent sampling as defined by
+https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/tracestate-probability-sampling.md
+and https://github.com/open-telemetry/opentelemetry-specification/pull/2047.
+
 ## Version 1.12.0 (2022-03-14)
 
 All components updated to target OpenTelemetry SDK 1.12.0.
@@ -12,30 +20,30 @@ All components updated to target OpenTelemetry SDK 1.11.0.
 
 ### JFR streaming
 
-* Split up GC Handlers, add support for Parallel
+- Split up GC Handlers, add support for Parallel
   ([#201](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/201))
 
 ### JMX metrics
 
-* jmx-metrics: Activemq
+- jmx-metrics: Activemq
   ([#188](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/188))
-* Adds Solr metrics gathering to jmx-metrics
+- Adds Solr metrics gathering to jmx-metrics
   ([#204](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/204))
-* Add Hadoop Monitoring
+- Add Hadoop Monitoring
   ([#210](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/210))
-* Add Hbase Support
+- Add Hbase Support
   ([#211](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/211))
-* Update Kafka JMX Script
+- Update Kafka JMX Script
   ([#216](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/216))
-* Fixes solr JMX metrics to use all possible MBeans instead of only first
+- Fixes solr JMX metrics to use all possible MBeans instead of only first
   ([#223](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/223))
-* WildFly Monitoring
+- WildFly Monitoring
   ([#224](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/224))
-* Updates Solr cache size metric to point to new attribute to measure byte size
+- Updates Solr cache size metric to point to new attribute to measure byte size
   ([#225](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/225))
-* Updates jmx-metrics WildFly integration to point to integer attributes for some metrics
+- Updates jmx-metrics WildFly integration to point to integer attributes for some metrics
   ([#232](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/232))
-* Update file total metric
+- Update file total metric
   ([#234](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/234))
 
 ## Version 1.10.0 (2022-01-18)
@@ -44,35 +52,35 @@ All components updated to target OpenTelemetry SDK 1.10.0.
 
 ### JMX metrics
 
-* Add multi attribute support
+- Add multi attribute support
   ([#137](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/137))
-* Add support for Tomcat
+- Add support for Tomcat
   ([#155](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/155))
-* Change metric to Gauge
+- Change metric to Gauge
   ([#194](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/194))
-* Remove manual exporter flush
+- Remove manual exporter flush
   ([#190](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/190))
 
 ### Maven extension
 
-* Support Maven parallel builds
+- Support Maven parallel builds
   ([#161](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/161))
-* Capture details on mojo goal executions: `deploy:deploy`, `spring-boot:build-image`, `jib:build`, `snyk:test`, `snyk:monitor`
+- Capture details on mojo goal executions: `deploy:deploy`, `spring-boot:build-image`, `jib:build`, `snyk:test`, `snyk:monitor`
   ([#146](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/146))
-* Fix lifecycle to support the Maven daemon
+- Fix lifecycle to support the Maven daemon
   ([#169](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/169))
-* Fix `service.name` attribute overwrite
+- Fix `service.name` attribute overwrite
   ([#184](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/184))
-* Fix default `service.name` + simplify configuration using Otel AutoConfig SDK 1.10 ResourceProvider SPI improvements (enable specifying the classloader making it compatible with Maven Plexus)
+- Fix default `service.name` + simplify configuration using Otel AutoConfig SDK 1.10 ResourceProvider SPI improvements (enable specifying the classloader making it compatible with Maven Plexus)
   ([#187](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/187))
-* Add Tracer instrumentationVersion (ie `otel.library.version`)
+- Add Tracer instrumentationVersion (ie `otel.library.version`)
   ([#191](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/191))
-* Reduce the cardinality of mojo span names
+- Reduce the cardinality of mojo span names
   ([#192](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/192))
 
 ### Samplers
 
-* Rename contrib-samplers to samplers
+- Rename contrib-samplers to samplers
   ([#185](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/185))
 
 ## Version 1.9.0 (2021-12-03)
@@ -81,23 +89,23 @@ All components updated to target OpenTelemetry SDK 1.9.1.
 
 ### Maven extension
 
-* Use Auto Configure Otel SDK Builder
+- Use Auto Configure Otel SDK Builder
   ([#132](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/132))
 
 ### AWS X-Ray
 
-* Use OkHttp for xray sampling requests
+- Use OkHttp for xray sampling requests
   ([#135](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/135))
-* Use service.name resource attribute instead of span name for service
+- Use service.name resource attribute instead of span name for service
   ([#138](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/138))
-* X-Ray Sampler: Match rule's HTTP path against http.url attribute if t
+- X-Ray Sampler: Match rule's HTTP path against http.url attribute if t
   ([#141](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/141))
 
 ### JFR streaming
 
-* Tidy up jfr-streaming
+- Tidy up jfr-streaming
   ([#127](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/127))
-* Fix units for some metrics
+- Fix units for some metrics
   ([#140](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/140))
 
 ## Version 1.8.0 - Skipped
@@ -122,22 +130,22 @@ Allows programmatic attach of Javaagent.
 
 ### JMX metrics
 
-* Update Cassandra units for latency counters
+- Update Cassandra units for latency counters
   ([#111](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/111))
-* Update cassandra counters to be non-monotonic where appropriate
+- Update cassandra counters to be non-monotonic where appropriate
   ([#113](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/113))
-* Update cassandra jmx metrics script to combine similar metrics into labelled metric
+- Update cassandra jmx metrics script to combine similar metrics into labelled metric
   ([#118](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/118))
 
 ### Maven extension
 
-* Fix failure to load the extension declaring it in pom.xml
+- Fix failure to load the extension declaring it in pom.xml
   ([#86](https://github.com/open-telemetry/opentelemetry-java-contrib/issues/86))
-* Fix exception if OTLP exporter is not configured properly
+- Fix exception if OTLP exporter is not configured properly
   ([#93](https://github.com/open-telemetry/opentelemetry-java-contrib/issues/93)).
-* Support disabling the creation of mojo execution spans
+- Support disabling the creation of mojo execution spans
   ([#108](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/108))
-* Use the [OpenTelemetry SDK Autoconfigure extension](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure) to support more configuration setting. All the settings of the OTLP exporter are supported.
+- Use the [OpenTelemetry SDK Autoconfigure extension](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure) to support more configuration setting. All the settings of the OTLP exporter are supported.
   ([#112](https://github.com/open-telemetry/opentelemetry-java-contrib/pull/112))
 
 ## Version 1.6.0 (2021-09-22)
@@ -154,7 +162,7 @@ All components updated to target OpenTelemetry SDK 1.5.0.
 
 ### JMX metrics
 
-* Due to updating to OpenTelemetry SDK 1.5.0, many of the APIs presented for configuration have been changed so you will need to update any Groovy config scripts to match.
+- Due to updating to OpenTelemetry SDK 1.5.0, many of the APIs presented for configuration have been changed so you will need to update any Groovy config scripts to match.
   * `*ValueRecorder` has been replaced with `*Histogram`
   * `*Sum` have been replaced with `*Counter`
   * `*Observer` have been replaced with `*Callback` and do not return any object anymore
@@ -169,13 +177,13 @@ This library contains OTel extensions for use with [AWS X-Ray](https://docs.aws.
 
 ### JMX Metrics
 
-* Because of numerous backwards incompatible changes in the OpenTelemetry Metrics data model, you will want to make sure you are running the latest version of the OpenTelemetry collector. Older versions will likely not process metrics correctly.
+- Because of numerous backwards incompatible changes in the OpenTelemetry Metrics data model, you will want to make sure you are running the latest version of the OpenTelemetry collector. Older versions will likely not process metrics correctly.
 
 ## Version 1.0.0-alpha (2021-06-02)
 
 ### JMX metrics - New 🌟
 
-* Adopt OpenTelemetry 1.0.0(-alpha) dependencies (#32)
+- Adopt OpenTelemetry 1.0.0(-alpha) dependencies (#32)
   * Update JMX Metric Gatherer to use 1.0.0(-alpha) proto, API, SDK, and exporters.
   * Update JMX Metric Gatherer to use Autoconfigure SDK extension properties*
-* JMX Metric Gatherer - Handle missing MBean attributes without failing (#39) - Thanks to @dehaansa.
+- JMX Metric Gatherer - Handle missing MBean attributes without failing (#39) - Thanks to @dehaansa.
diff --git a/README.md b/README.md
@@ -10,6 +10,7 @@ feature or via instrumentation, this project is hopefully for you.
 ## Provided Libraries
 
 * [AWS X-Ray Support](./aws-xray/README.md)
+* [Consistent sampling](./consistent-sampling/README.md)
 * [JFR Streaming](./jfr-streaming/README.md)
 * [JMX Metric Gatherer](./jmx-metrics/README.md)
 * [OpenTelemetry Maven Extension](./maven-extension/README.md)

diff --git a/buildscripts/draft-change-log-entries.sh b/buildscripts/draft-change-log-entries.sh
diff --git a/consistent-sampling/README.md b/consistent-sampling/README.md
@@ -0,0 +1,30 @@
+# Consistent sampling
+
+This component adds various Sampler implementations for consistent sampling as defined by
+https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/tracestate-probability-sampling.md
+and https://github.com/open-telemetry/opentelemetry-specification/pull/2047.
+
+* **ConsistentSampler**:
+  abstract base class of all consistent sampler implementations below
+* **ConsistentAlwaysOffSampler**:
+  see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/tracestate-probability-sampling.md#always-off-sampler
+* **ConsistentAlwaysOnSampler**:
+  see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/tracestate-probability-sampling.md#always-on-consistent-probability-sampler
+* **ConsistentComposedAndSampler**:
+  allows combining two consistent samplers and samples when both samplers would sample
+* **ConsistentComposedOrSampler**:
+  allows combining two consistent sampler and samples when at least one of both samplers would sample,
+  see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/tracestate-probability-sampling.md#requirement-combine-multiple-consistent-probability-samplers-using-the-minimum-p-value
+* **ConsistentParentBasedSampler**:
+  see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/tracestate-probability-sampling.md#parentconsistentprobabilitybased-sampler
+* **ConsistentProbabilityBasedSampler**:
+  see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/tracestate-probability-sampling.md#consistentprobabilitybased-sampler
+* **ConsistentRateLimitingSampler**:
+  a rate limiting sampler based on exponential smoothing that dynamically adjusts the sampling
+  probability based on the estimated rate of spans occurring to satisfy a given rate of sampled spans
+
+## Component owners
+
+- [Otmar Ertl](https://github.com/oertl), Dynatrace
+
+Learn more about component owners in [component_owners.yml](../.github/component_owners.yml).