|
| 1 | +/* |
| 2 | + * Copyright The OpenTelemetry Authors |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * https://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +import { MetricExporter, MetricRecord } from '@opentelemetry/metrics'; |
| 18 | +import { Attributes, Logger } from '@opentelemetry/api'; |
| 19 | +import { CollectorExporterConfigBase } from './types'; |
| 20 | +import { NoopLogger, ExportResult } from '@opentelemetry/core'; |
| 21 | +import * as collectorTypes from './types'; |
| 22 | + |
| 23 | +const DEFAULT_SERVICE_NAME = 'collector-metric-exporter'; |
| 24 | + |
| 25 | +/** |
| 26 | + * Collector Metric Exporter abstract base class |
| 27 | + */ |
| 28 | +export abstract class CollectorMetricExporterBase< |
| 29 | + T extends CollectorExporterConfigBase |
| 30 | +> implements MetricExporter { |
| 31 | + public readonly serviceName: string; |
| 32 | + public readonly url: string; |
| 33 | + public readonly logger: Logger; |
| 34 | + public readonly hostname: string | undefined; |
| 35 | + public readonly attributes?: Attributes; |
| 36 | + protected readonly _startTime = new Date().getTime() * 1000000; |
| 37 | + private _isShutdown: boolean = false; |
| 38 | + |
| 39 | + /** |
| 40 | + * @param config |
| 41 | + */ |
| 42 | + constructor(config: T = {} as T) { |
| 43 | + this.logger = config.logger || new NoopLogger(); |
| 44 | + this.serviceName = config.serviceName || DEFAULT_SERVICE_NAME; |
| 45 | + this.url = this.getDefaultUrl(config.url); |
| 46 | + this.attributes = config.attributes; |
| 47 | + if (typeof config.hostname === 'string') { |
| 48 | + this.hostname = config.hostname; |
| 49 | + } |
| 50 | + this.onInit(); |
| 51 | + } |
| 52 | + |
| 53 | + /** |
| 54 | + * Export metrics |
| 55 | + * @param metrics |
| 56 | + * @param resultCallback |
| 57 | + */ |
| 58 | + export( |
| 59 | + metrics: MetricRecord[], |
| 60 | + resultCallback: (result: ExportResult) => void |
| 61 | + ) { |
| 62 | + if (this._isShutdown) { |
| 63 | + resultCallback(ExportResult.FAILED_NOT_RETRYABLE); |
| 64 | + return; |
| 65 | + } |
| 66 | + |
| 67 | + this._exportMetrics(metrics) |
| 68 | + .then(() => { |
| 69 | + resultCallback(ExportResult.SUCCESS); |
| 70 | + }) |
| 71 | + .catch((error: collectorTypes.ExportServiceError) => { |
| 72 | + if (error.message) { |
| 73 | + this.logger.error(error.message); |
| 74 | + } |
| 75 | + if (error.code && error.code < 500) { |
| 76 | + resultCallback(ExportResult.FAILED_NOT_RETRYABLE); |
| 77 | + } else { |
| 78 | + resultCallback(ExportResult.FAILED_RETRYABLE); |
| 79 | + } |
| 80 | + }); |
| 81 | + } |
| 82 | + |
| 83 | + private _exportMetrics(metrics: MetricRecord[]): Promise<unknown> { |
| 84 | + return new Promise((resolve, reject) => { |
| 85 | + try { |
| 86 | + this.logger.debug('metrics to be sent', metrics); |
| 87 | + // Send metrics to [opentelemetry collector]{@link https://github.com/open-telemetry/opentelemetry-collector} |
| 88 | + // it will use the appropriate transport layer automatically depends on platform |
| 89 | + this.sendMetrics(metrics, resolve, reject); |
| 90 | + } catch (e) { |
| 91 | + reject(e); |
| 92 | + } |
| 93 | + }); |
| 94 | + } |
| 95 | + |
| 96 | + /** |
| 97 | + * Shutdown the exporter. |
| 98 | + */ |
| 99 | + shutdown(): void { |
| 100 | + if (this._isShutdown) { |
| 101 | + this.logger.debug('shutdown already started'); |
| 102 | + return; |
| 103 | + } |
| 104 | + this._isShutdown = true; |
| 105 | + this.logger.debug('shutdown started'); |
| 106 | + |
| 107 | + // platform dependent |
| 108 | + this.onShutdown(); |
| 109 | + } |
| 110 | + |
| 111 | + abstract getDefaultUrl(url: string | undefined): string; |
| 112 | + abstract onInit(): void; |
| 113 | + abstract onShutdown(): void; |
| 114 | + abstract sendMetrics( |
| 115 | + metrics: MetricRecord[], |
| 116 | + onSuccess: () => void, |
| 117 | + onError: (error: collectorTypes.CollectorExporterError) => void |
| 118 | + ): void; |
| 119 | +} |
0 commit comments