Skip to content
This repository has been archived by the owner on Oct 3, 2023. It is now read-only.

Commit

Permalink
Pull in @opencensus/core types using copytypes npm script (#27)
Browse files Browse the repository at this point in the history
  • Loading branch information
draffensperger committed Mar 21, 2019
1 parent 7271b94 commit 3f40493
Show file tree
Hide file tree
Showing 14 changed files with 1,650 additions and 0 deletions.
34 changes: 34 additions & 0 deletions packages/opencensus-web-types/src/common/types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/**
* Copyright 2019, OpenCensus 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
*
* http://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.
*/

// tslint:disable:no-any
export type LogFunction = (message: any, ...args: any[]) => void;

/** Defines an logger interface. */
export interface Logger {
/** Logger verbosity level. If omitted, `debug` level is assumed. */
level?: string;

error: LogFunction;
warn: LogFunction;
info: LogFunction;
debug: LogFunction;
}

/** Defines an logger options interface. */
export interface LoggerOptions {
level?: string;
}
59 changes: 59 additions & 0 deletions packages/opencensus-web-types/src/exporters/types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
/**
* Copyright 2019, OpenCensus 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
*
* http://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 {Measurement, View} from '../stats/types';
import {TagKey, TagValue} from '../tags/types';
import * as configTypes from '../trace/config/types';
import * as modelTypes from '../trace/model/types';

/** Defines a trace exporter interface. */
export interface Exporter extends modelTypes.SpanEventListener {
/**
* Sends a list of root spans to the service.
* @param rootSpans A list of root spans to publish.
*/
publish(rootSpans: modelTypes.RootSpan[]): Promise<number|string|void>;
}

/**
* An interface that describes the possible events that will be emitted from a
* Stats instance. Stats exporters should implement this interface.
*/
export interface StatsEventListener {
/**
* Is called whenever a new view is registered
* @deprecated since version 0.0.9 - use {@link start} instead
* @param view The registered view
*/
onRegisterView(view: View): void;
/**
* Is called whenever a new measurement is recorded.
* @deprecated since version 0.0.9 - use {@link start} instead
* @param views The views related to the measurement
* @param measurement The recorded measurement
*/
onRecord(
views: View[], measurement: Measurement,
tags: Map<TagKey, TagValue>): void;

/**
* Starts the exporter that polls Metric from Metrics library and send
* batched data to backend.
*/
start(): void;
}

export type ExporterConfig = configTypes.BufferConfig;
10 changes: 10 additions & 0 deletions packages/opencensus-web-types/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,13 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/

export * from './common/types';
export * from './exporters/types';
export * from './node/types';
export * from './trace/config/types';
export * from './trace/instrumentation/types';
export * from './trace/model/types';
export * from './trace/propagation/types';
export * from './trace/sampler/types';
export * from './trace/types';

0 comments on commit 3f40493

Please sign in to comment.