Update docs for batch span processor env vars (#2485)

This commit is contained in:
Robert Pająk 2021-10-13 18:45:20 +02:00 committed by GitHub
parent 11918b5674
commit a3f0961b07
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 0 deletions

View File

@ -2,6 +2,9 @@
## Unreleased
* Changed `BatchExportActivityProcessorOptions` to throw `ArgumentException`
if it fails to parse any of the supported environment variables.
## 1.2.0-beta1
Released 2021-Oct-08

View File

@ -215,6 +215,9 @@ purposes, the SDK provides the following built-in processors:
| `OTEL_BSP_MAX_EXPORT_BATCH_SIZE` | `MaxExportBatchSizeEnvVarKey` |
<!-- markdownlint-enable MD013 -->
`ArgumentException` is thrown in case of an invalid value for any of the
supported environment variables.
* [CompositeProcessor&lt;T&gt;](../../src/OpenTelemetry/CompositeProcessor.cs)
: This is a processor which can be composed from multiple processors. This is
typically used to construct multiple processing pipelines, each ending with

View File

@ -26,6 +26,10 @@ namespace OpenTelemetry.Trace
/// OTEL_BSP_MAX_QUEUE_SIZE, OTEL_BSP_MAX_EXPORT_BATCH_SIZE, OTEL_BSP_EXPORT_TIMEOUT, OTEL_BSP_SCHEDULE_DELAY
/// environment variables are parsed during object construction.
/// </summary>
/// <remarks>
/// The constructor throws <see cref="ArgumentException"/> if it fails to parse
/// any of the supported environment variables.
/// </remarks>
public class BatchExportActivityProcessorOptions : BatchExportProcessorOptions<Activity>
{
internal const string MaxQueueSizeEnvVarKey = "OTEL_BSP_MAX_QUEUE_SIZE";