Skip to content
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

docs: document console exporter output stability #4956

Merged
merged 4 commits into from
Aug 28, 2024
Merged

docs: document console exporter output stability #4956

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bc98339
docs: document console exporter output stability
pichlermarc Aug 26, 2024
854f4a1
Merge branch 'main' into docs/exporter-output-stability
pichlermarc Aug 26, 2024
1ae1dc9
Merge branch 'main' into docs/exporter-output-stability
pichlermarc Aug 26, 2024
e214f09
Update packages/sdk-metrics/src/export/ConsoleMetricExporter.ts
pichlermarc Aug 28, 2024
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
2 changes: 2 additions & 0 deletions experimental/packages/sdk-logs/src/export/ConsoleLogRecordExporter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ import type { LogRecordExporter } from './LogRecordExporter';
/**
* This is implementation of {@link LogRecordExporter} that prints LogRecords to the
* console. This class can be used for diagnostic purposes.
*
* NOTE: This {@link LogRecordExporter} is intended for diagnostics use only, output rendered to the console may change at any time.
*/

/* eslint-disable no-console */
Expand Down
2 changes: 2 additions & 0 deletions packages/opentelemetry-sdk-trace-base/src/export/ConsoleSpanExporter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ import {
/**
* This is implementation of {@link SpanExporter} that prints spans to the
* console. This class can be used for diagnostic purposes.
*
* NOTE: This {@link SpanExporter} is intended for diagnostics use only, output rendered to the console may change at any time.
*/

/* eslint-disable no-console */
Expand Down
7 changes: 7 additions & 0 deletions packages/sdk-metrics/src/export/ConsoleMetricExporter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ interface ConsoleMetricExporterOptions {
temporalitySelector?: AggregationTemporalitySelector;
}

/**
* This is an implementation of {@link PushMetricExporter} that prints metrics to the
* console. This class can be used for diagnostic purposes.
*
* NOTE: This {@link PushMetricExporter} is intended for diagnostics use only, output rendered to the console may change at any time.
*/

/* eslint-disable no-console */
export class ConsoleMetricExporter implements PushMetricExporter {
protected _shutdown = false;
Expand Down