Skip to content

Commit

Permalink
docs: document console exporter output stability (#4956)
Browse files Browse the repository at this point in the history
Co-authored-by: Jackson Weber <47067795+JacksonWeber@users.noreply.github.com>
  • Loading branch information
pichlermarc and JacksonWeber authored Aug 28, 2024
1 parent 948496d commit bd25230
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 0 deletions.
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
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
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

0 comments on commit bd25230

Please sign in to comment.