Skip to content

Commit

Permalink
feat: bootstrap views api
Browse files Browse the repository at this point in the history
  • Loading branch information
@legendecas
legendecas committed Nov 16, 2021
1 parent d128f0f commit 2cdfc4a
Show file tree
Hide file tree
Showing 14 changed files with 754 additions and 225 deletions.
10 changes: 9 additions & 1 deletion experimental/packages/opentelemetry-sdk-metrics-base/src/Instruments.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,22 @@ export enum InstrumentType {
OBSERVABLE_UP_DOWN_COUNTER = 'OBSERVABLE_UP_DOWN_COUNTER',
}

export interface InstrumentDescriptor {
readonly name: string;
readonly description: string;
readonly unit: string;
readonly type: InstrumentType;
readonly valueType: metrics.ValueType;
}

export class SyncInstrument {
constructor(private _meter: Meter, private _name: string) { }

getName(): string {
return this._name;
}


aggregate(value: number, attributes: metrics.Attributes = {}, ctx: api.Context = api.context.active()) {
this._meter.aggregate(this, {
value,
Expand Down
211 changes: 107 additions & 104 deletions experimental/packages/opentelemetry-sdk-metrics-base/src/MeterProvider.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,128 +21,131 @@ import { Measurement } from './Measurement';
import { Meter } from './Meter';
import { MetricExporter } from './MetricExporter';
import { MetricReader } from './MetricReader';
import { View } from './View';
import { InstrumentSelector } from './view/InstrumentSelector';
import { MeterSelector } from './view/MeterSelector';
import { View } from './view/View';
import { ViewRegistry } from './view/ViewRegistry';

// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#meterprovider

export type MeterProviderOptions = {
resource?: Resource;
resource?: Resource;
}

export class MeterProvider {
private _resource: Resource;
private _shutdown = false;
private _metricReaders: MetricReader[] = [];
private _metricExporters: MetricExporter[] = [];
private _views: View[] = [];

constructor(options: MeterProviderOptions) {
this._resource = options.resource ?? Resource.empty();
private _resource: Resource;
private _shutdown = false;
private _metricReaders: MetricReader[] = [];
private _metricExporters: MetricExporter[] = [];
private readonly _viewRegistry = new ViewRegistry();

constructor(options: MeterProviderOptions) {
this._resource = options.resource ?? Resource.empty();
}

/**
* **Unstable**
*
* This method is only here to prevent typescript from complaining and may be removed.
*/
getResource() {
return this._resource;
}

getMeter(name: string, version = '', options: metrics.MeterOptions = {}): metrics.Meter {
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#meter-creation
if (this._shutdown) {
api.diag.warn('A shutdown MeterProvider cannot provide a Meter')
return metrics.NOOP_METER;
}

/**
* **Unstable**
*
* This method is only here to prevent typescript from complaining and may be removed.
*/
getResource() {
return this._resource;
// Spec leaves it unspecified if creating a meter with duplicate
// name/version returns the same meter. We create a new one here
// for simplicity. This may change in the future.
// TODO: consider returning the same meter if the same name/version is used
return new Meter(this, { name, version }, options.schemaUrl);
}

addMetricReader(metricReader: MetricReader) {
this._metricReaders.push(metricReader);
}

addView(view: View, instrumentSelector: InstrumentSelector, meterSelector: MeterSelector) {
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#view
this._viewRegistry.addView(view, instrumentSelector, meterSelector);
}

/**
* Flush all buffered data and shut down the MeterProvider and all exporters and metric readers.
* Returns a promise which is resolved when all flushes are complete.
*
* TODO: return errors to caller somehow?
*/
async shutdown(): Promise<void> {
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#shutdown

if (this._shutdown) {
api.diag.warn('shutdown may only be called once per MeterProvider');
return;
}

getMeter(name: string, version = '', options: metrics.MeterOptions = {}): metrics.Meter {
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#meter-creation
if (this._shutdown) {
api.diag.warn('A shutdown MeterProvider cannot provide a Meter')
return metrics.NOOP_METER;
// TODO add a timeout - spec leaves it up the the SDK if this is configurable
this._shutdown = true;

// Shut down all exporters and readers.
// Log all Errors.
for (const exporter of this._metricExporters) {
try {
await exporter.shutdown();
} catch (e) {
if (e instanceof Error) {
api.diag.error(`Error shutting down: ${e.message}`)
}

// Spec leaves it unspecified if creating a meter with duplicate
// name/version returns the same meter. We create a new one here
// for simplicity. This may change in the future.
// TODO: consider returning the same meter if the same name/version is used
return new Meter(this, { name, version }, options.schemaUrl);
}

addMetricReader(metricReader: MetricReader) {
this._metricReaders.push(metricReader);
}
}

addView(view: View) {
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#view
this._views.push(view);
}

/**
* Notifies all exporters and metric readers to flush any buffered data.
* Returns a promise which is resolved when all flushes are complete.
*
* TODO: return errors to caller somehow?
*/
async forceFlush(): Promise<void> {
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#forceflush

// TODO add a timeout - spec leaves it up the the SDK if this is configurable

// do not flush after shutdown
if (this._shutdown) {
api.diag.warn('invalid attempt to force flush after shutdown')
return;
}

/**
* Flush all buffered data and shut down the MeterProvider and all exporters and metric readers.
* Returns a promise which is resolved when all flushes are complete.
*
* TODO: return errors to caller somehow?
*/
async shutdown(): Promise<void> {
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#shutdown

if (this._shutdown) {
api.diag.warn('shutdown may only be called once per MeterProvider');
return;
}

// TODO add a timeout - spec leaves it up the the SDK if this is configurable
this._shutdown = true;

// Shut down all exporters and readers.
// Log all Errors.
for (const exporter of this._metricExporters) {
try {
await exporter.shutdown();
} catch (e) {
if (e instanceof Error) {
api.diag.error(`Error shutting down: ${e.message}`)
}
}
for (const exporter of [...this._metricExporters, ...this._metricReaders]) {
try {
await exporter.forceFlush();
} catch (e) {
if (e instanceof Error) {
api.diag.error(`Error flushing: ${e.message}`)
}
}
}
}

public aggregate(_meter: Meter, _metric: unknown, _measurement: Measurement) {
// TODO actually aggregate

/**
* Notifies all exporters and metric readers to flush any buffered data.
* Returns a promise which is resolved when all flushes are complete.
*
* TODO: return errors to caller somehow?
* if there are no views:
* apply the default configuration
* else:
* for each view:
* if view matches:
* apply view configuration
* if no view matched:
* if user has not disabled default fallback:
* apply default configuration
*/
async forceFlush(): Promise<void> {
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#forceflush

// TODO add a timeout - spec leaves it up the the SDK if this is configurable

// do not flush after shutdown
if (this._shutdown) {
api.diag.warn('invalid attempt to force flush after shutdown')
return;
}

for (const exporter of [...this._metricExporters, ...this._metricReaders]) {
try {
await exporter.forceFlush();
} catch (e) {
if (e instanceof Error) {
api.diag.error(`Error flushing: ${e.message}`)
}
}
}
}

public aggregate(_meter: Meter, _metric: unknown, _measurement: Measurement) {
// TODO actually aggregate

/**
* if there are no views:
* apply the default configuration
* else:
* for each view:
* if view matches:
* apply view configuration
* if no view matched:
* if user has not disabled default fallback:
* apply default configuration
*/
}
}
}
113 changes: 0 additions & 113 deletions experimental/packages/opentelemetry-sdk-metrics-base/src/View.ts
View file

This file was deleted.

Loading

0 comments on commit 2cdfc4a

Please sign in to comment.