Skip to content

Commit

Permalink
chore(exporter): fix lint warnings (#2447)
Browse files Browse the repository at this point in the history 
* chore(shim): fix lint warnings

* chore(exporter-prometheus): fix lint warnings

* chore(exporter-zipkin): fix lint warnings
  • Loading branch information
@alisabzevari
alisabzevari committed Sep 3, 2021
1 parent dc574f7 commit f810779
Show file tree
Hide file tree
Showing 9 changed files with 37 additions and 35 deletions.
4 changes: 2 additions & 2 deletions packages/opentelemetry-exporter-prometheus/src/PrometheusExporter.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ export class PrometheusExporter implements MetricExporter {
* @param records Metrics to be sent to the prometheus backend
* @param cb result callback to be called on finish
*/
export(records: MetricRecord[], cb: (result: ExportResult) => void) {
export(records: MetricRecord[], cb: (result: ExportResult) => void): void {
if (!this._server) {
// It is conceivable that the _server may not be started as it is an async startup
// However unlikely, if this happens the caller may retry the export
Expand Down Expand Up @@ -180,7 +180,7 @@ export class PrometheusExporter implements MetricExporter {
public getMetricsRequestHandler(
_request: IncomingMessage,
response: ServerResponse
) {
): void {
this._exportMetrics(response);
}

Expand Down
4 changes: 2 additions & 2 deletions packages/opentelemetry-exporter-prometheus/src/PrometheusLabelsBatcher.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ interface BatcherCheckpoint {
export class PrometheusLabelsBatcher {
private _batchMap = new Map<string, BatcherCheckpoint>();

get hasMetric() {
get hasMetric(): boolean {
return this._batchMap.size > 0;
}

process(record: MetricRecord) {
process(record: MetricRecord): void {
const name = record.descriptor.name;
let item = this._batchMap.get(name);
if (item === undefined) {
Expand Down
2 changes: 1 addition & 1 deletion packages/opentelemetry-exporter-zipkin/src/platform/browser/util.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import * as zipkinTypes from '../../types';
* @param headers - headers
* send
*/
export function prepareSend(urlStr: string, headers?: Record<string, string>) {
export function prepareSend(urlStr: string, headers?: Record<string, string>): zipkinTypes.SendFn {
let xhrHeaders: Record<string, string>;
const useBeacon = typeof navigator.sendBeacon === 'function' && !headers;
if (headers) {
Expand Down
2 changes: 1 addition & 1 deletion packages/opentelemetry-exporter-zipkin/src/platform/node/util.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import * as zipkinTypes from '../../types';
* @param headers - headers
* send
*/
export function prepareSend(urlStr: string, headers?: Record<string, string>) {
export function prepareSend(urlStr: string, headers?: Record<string, string>): zipkinTypes.SendFn {
const urlOpts = url.parse(urlStr);

const reqOpts: http.RequestOptions = Object.assign(
Expand Down
4 changes: 2 additions & 2 deletions packages/opentelemetry-exporter-zipkin/src/transform.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ const ZIPKIN_SPAN_KIND_MAPPING = {
[api.SpanKind.INTERNAL]: undefined,
};

export const statusCodeTagName = 'ot.status_code';
export const statusDescriptionTagName = 'ot.status_description';
export const defaultStatusCodeTagName = 'ot.status_code';
export const defaultStatusDescriptionTagName = 'ot.status_description';

/**
* Translate OpenTelemetry ReadableSpan to ZipkinSpan format
Expand Down
2 changes: 2 additions & 0 deletions packages/opentelemetry-exporter-zipkin/src/types.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,3 +187,5 @@ export type SendFunction = (
) => void;

export type GetHeaders = () => Record<string, string> | undefined;

export type SendFn = (zipkinSpans: Span[], done: (result: ExportResult) => void) => void;
10 changes: 5 additions & 5 deletions packages/opentelemetry-exporter-zipkin/src/zipkin.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ import { prepareSend } from './platform/index';
import * as zipkinTypes from './types';
import {
toZipkinSpan,
statusCodeTagName,
statusDescriptionTagName,
defaultStatusCodeTagName,
defaultStatusDescriptionTagName,
} from './transform';
import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
import { prepareGetHeaders } from './utils';
Expand All @@ -45,9 +45,9 @@ export class ZipkinExporter implements SpanExporter {
this._urlStr = config.url || getEnv().OTEL_EXPORTER_ZIPKIN_ENDPOINT;
this._send = prepareSend(this._urlStr, config.headers);
this._serviceName = config.serviceName;
this._statusCodeTagName = config.statusCodeTagName || statusCodeTagName;
this._statusCodeTagName = config.statusCodeTagName || defaultStatusCodeTagName;
this._statusDescriptionTagName =
config.statusDescriptionTagName || statusDescriptionTagName;
config.statusDescriptionTagName || defaultStatusDescriptionTagName;
this._isShutdown = false;
if (typeof config.getExportRequestHeaders === 'function') {
this._getHeaders = prepareGetHeaders(config.getExportRequestHeaders);
Expand All @@ -63,7 +63,7 @@ export class ZipkinExporter implements SpanExporter {
export(
spans: ReadableSpan[],
resultCallback: (result: ExportResult) => void
) {
): void {
const serviceName = String(
this._serviceName ||
spans[0].resource.attributes[SemanticResourceAttributes.SERVICE_NAME] ||
Expand Down
42 changes: 21 additions & 21 deletions packages/opentelemetry-exporter-zipkin/test/common/transform.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ import { BasicTracerProvider, Span } from '@opentelemetry/sdk-trace-base';
import * as assert from 'assert';
import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
import {
statusCodeTagName,
statusDescriptionTagName,
defaultStatusCodeTagName,
defaultStatusDescriptionTagName,
toZipkinSpan,
_toZipkinAnnotations,
_toZipkinTags,
Expand Down Expand Up @@ -78,8 +78,8 @@ describe('transform', () => {
const zipkinSpan = toZipkinSpan(
span,
'my-service',
statusCodeTagName,
statusDescriptionTagName
defaultStatusCodeTagName,
defaultStatusDescriptionTagName
);
assert.deepStrictEqual(zipkinSpan, {
kind: 'SERVER',
Expand All @@ -101,7 +101,7 @@ describe('transform', () => {
tags: {
key1: 'value1',
key2: 'value2',
[statusCodeTagName]: 'UNSET',
[defaultStatusCodeTagName]: 'UNSET',
[SemanticResourceAttributes.SERVICE_NAME]: 'zipkin-test',
'telemetry.sdk.language': language,
'telemetry.sdk.name': 'opentelemetry',
Expand All @@ -124,8 +124,8 @@ describe('transform', () => {
const zipkinSpan = toZipkinSpan(
span,
'my-service',
statusCodeTagName,
statusDescriptionTagName
defaultStatusCodeTagName,
defaultStatusDescriptionTagName
);
assert.deepStrictEqual(zipkinSpan, {
kind: 'SERVER',
Expand All @@ -140,7 +140,7 @@ describe('transform', () => {
name: span.name,
parentId: undefined,
tags: {
[statusCodeTagName]: 'UNSET',
[defaultStatusCodeTagName]: 'UNSET',
[SemanticResourceAttributes.SERVICE_NAME]: 'zipkin-test',
'telemetry.sdk.language': language,
'telemetry.sdk.name': 'opentelemetry',
Expand Down Expand Up @@ -173,8 +173,8 @@ describe('transform', () => {
const zipkinSpan = toZipkinSpan(
span,
'my-service',
statusCodeTagName,
statusDescriptionTagName
defaultStatusCodeTagName,
defaultStatusDescriptionTagName
);
assert.deepStrictEqual(zipkinSpan, {
kind: item.zipkin,
Expand All @@ -189,7 +189,7 @@ describe('transform', () => {
name: span.name,
parentId: undefined,
tags: {
[statusCodeTagName]: 'UNSET',
[defaultStatusCodeTagName]: 'UNSET',
[SemanticResourceAttributes.SERVICE_NAME]: 'zipkin-test',
'telemetry.sdk.language': language,
'telemetry.sdk.name': 'opentelemetry',
Expand Down Expand Up @@ -219,15 +219,15 @@ describe('transform', () => {
const tags: zipkinTypes.Tags = _toZipkinTags(
span.attributes,
span.status,
statusCodeTagName,
statusDescriptionTagName,
defaultStatusCodeTagName,
defaultStatusDescriptionTagName,
DUMMY_RESOURCE
);

assert.deepStrictEqual(tags, {
key1: 'value1',
key2: 'value2',
[statusCodeTagName]: 'UNSET',
[defaultStatusCodeTagName]: 'UNSET',
cost: '112.12',
service: 'ui',
version: '1',
Expand All @@ -254,8 +254,8 @@ describe('transform', () => {
const tags: zipkinTypes.Tags = _toZipkinTags(
span.attributes,
span.status,
statusCodeTagName,
statusDescriptionTagName,
defaultStatusCodeTagName,
defaultStatusDescriptionTagName,
Resource.empty().merge(
new Resource({
[SemanticResourceAttributes.SERVICE_NAME]: 'zipkin-test',
Expand All @@ -266,7 +266,7 @@ describe('transform', () => {
assert.deepStrictEqual(tags, {
key1: 'value1',
key2: 'value2',
[statusCodeTagName]: 'ERROR',
[defaultStatusCodeTagName]: 'ERROR',
[SemanticResourceAttributes.SERVICE_NAME]: 'zipkin-test',
});
});
Expand All @@ -291,8 +291,8 @@ describe('transform', () => {
const tags: zipkinTypes.Tags = _toZipkinTags(
span.attributes,
span.status,
statusCodeTagName,
statusDescriptionTagName,
defaultStatusCodeTagName,
defaultStatusDescriptionTagName,
Resource.empty().merge(
new Resource({
[SemanticResourceAttributes.SERVICE_NAME]: 'zipkin-test',
Expand All @@ -303,8 +303,8 @@ describe('transform', () => {
assert.deepStrictEqual(tags, {
key1: 'value1',
key2: 'value2',
[statusCodeTagName]: 'ERROR',
[statusDescriptionTagName]: status.message,
[defaultStatusCodeTagName]: 'ERROR',
[defaultStatusDescriptionTagName]: status.message,
[SemanticResourceAttributes.SERVICE_NAME]: 'zipkin-test',
});
});
Expand Down
2 changes: 1 addition & 1 deletion packages/opentelemetry-shim-opentracing/src/shim.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ export class SpanContextShim extends opentracing.SpanContext {
return this._baggage.getEntry(key)?.value;
}

setBaggageItem(key: string, value: string) {
setBaggageItem(key: string, value: string): void {
this._baggage = this._baggage.setEntry(key, { value });
}
}
Expand Down

0 comments on commit f810779

Please sign in to comment.