forked from open-telemetry/opentelemetry-js
/
OTLPExporterBase.ts
142 lines (129 loc) · 3.75 KB
/
OTLPExporterBase.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/*
* Copyright The OpenTelemetry Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { SpanAttributes, diag } from '@opentelemetry/api';
import { ExportResult, ExportResultCode } from '@opentelemetry/core';
import {
OTLPExporterError,
OTLPExporterConfigBase,
ExportServiceError,
} from './types';
/**
* Collector Exporter abstract base class
*/
export abstract class OTLPExporterBase<
T extends OTLPExporterConfigBase,
ExportItem,
ServiceRequest
> {
public readonly url: string;
public readonly hostname: string | undefined;
public readonly attributes?: SpanAttributes;
protected _concurrencyLimit: number;
protected _isShutdown: boolean = false;
private _shuttingDownPromise: Promise<void> = Promise.resolve();
protected _sendingPromises: Promise<unknown>[] = [];
/**
* @param config
*/
constructor(config: T = {} as T) {
this.url = this.getDefaultUrl(config);
if (typeof config.hostname === 'string') {
this.hostname = config.hostname;
}
this.attributes = config.attributes;
this.shutdown = this.shutdown.bind(this);
this._concurrencyLimit =
typeof config.concurrencyLimit === 'number'
? config.concurrencyLimit
: Infinity;
// platform dependent
this.onInit(config);
}
/**
* Export items.
* @param items
* @param resultCallback
*/
export(items: ExportItem[], resultCallback: (result: ExportResult) => void): void {
if (this._isShutdown) {
resultCallback({
code: ExportResultCode.FAILED,
error: new Error('Exporter has been shutdown'),
});
return;
}
if (this._sendingPromises.length >= this._concurrencyLimit) {
resultCallback({
code: ExportResultCode.FAILED,
error: new Error('Concurrent export limit reached'),
});
return;
}
this._export(items)
.then(() => {
resultCallback({ code: ExportResultCode.SUCCESS });
})
.catch((error: ExportServiceError) => {
resultCallback({ code: ExportResultCode.FAILED, error });
});
}
private _export(items: ExportItem[]): Promise<unknown> {
return new Promise<void>((resolve, reject) => {
try {
diag.debug('items to be sent', items);
this.send(items, resolve, reject);
} catch (e) {
reject(e);
}
});
}
/**
* Shutdown the exporter.
*/
shutdown(): Promise<void> {
if (this._isShutdown) {
diag.debug('shutdown already started');
return this._shuttingDownPromise;
}
this._isShutdown = true;
diag.debug('shutdown started');
this._shuttingDownPromise = new Promise((resolve, reject) => {
Promise.resolve()
.then(() => {
return this.onShutdown();
})
.then(() => {
return Promise.all(this._sendingPromises);
})
.then(() => {
resolve();
})
.catch(e => {
reject(e);
});
});
return this._shuttingDownPromise;
}
abstract onShutdown(): void;
abstract onInit(config: T): void;
abstract send(
items: ExportItem[],
onSuccess: () => void,
onError: (error: OTLPExporterError) => void
): void;
abstract getDefaultUrl(config: T): string;
abstract convert(objects: ExportItem[]): ServiceRequest;
}