Skip to content

[sdk-logs] Update the XML comments on BatchExportLogRecordProcessorOptions #4463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 4, 2023
Merged

[sdk-logs] Update the XML comments on BatchExportLogRecordProcessorOptions #4463

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions src/OpenTelemetry/Logs/BatchExportLogRecordProcessorOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,6 @@ namespace OpenTelemetry.Logs;
/// OTEL_BLRP_SCHEDULE_DELAY environment variables are parsed during object
/// construction.
/// </summary>
/// <remarks>
/// Notes:
/// <list type="bullet">
/// <item>The constructor throws <see cref="FormatException"/> if it fails to
Copy link
Member Author

@CodeBlanch CodeBlanch May 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For anyone curious the FormatException logic was changed a while back so this comment was lying: #4095

/// parse any of the supported environment variables.</item>
/// <item>The environment variable keys are currently experimental and subject
/// to change. See: <see
/// href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#batch-logrecord-processor">OpenTelemetry
/// Environment Variable Specification - Batch LogRecord Processor</see>.
/// </item>
/// </list>
/// </remarks>
internal class BatchExportLogRecordProcessorOptions : BatchExportProcessorOptions<LogRecord>
{
internal const string MaxQueueSizeEnvVarKey = "OTEL_BLRP_MAX_QUEUE_SIZE";
Expand Down