| 1 | /**
|
| 2 | * Copyright 2018, OpenCensus 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 | * http://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 | import * as exportersTypes from '../exporters/types';
|
| 17 | import * as configTypes from './config/types';
|
| 18 | import * as modelTypes from './model/types';
|
| 19 | /** Main interface for tracing. */
|
| 20 | export interface Tracing {
|
| 21 | /** Object responsible for managing a trace. */
|
| 22 | readonly tracer: modelTypes.TracerBase;
|
| 23 | /** Service to send collected traces to. */
|
| 24 | readonly exporter: exportersTypes.Exporter;
|
| 25 | /** Gets active status */
|
| 26 | active: boolean;
|
| 27 | /**
|
| 28 | * Starts tracing.
|
| 29 | * @param userConfig A configuration object to start tracing.
|
| 30 | * @returns The started Tracing instance.
|
| 31 | */
|
| 32 | start(userConfig?: configTypes.Config): Tracing;
|
| 33 | /** Stops tracing. */
|
| 34 | stop(): void;
|
| 35 | /**
|
| 36 | * Registers an exporter to send the collected traces to.
|
| 37 | * @param exporter The exporter to send the traces to.
|
| 38 | * @returns The tracing object.
|
| 39 | */
|
| 40 | registerExporter(exporter: exportersTypes.Exporter): Tracing;
|
| 41 | /**
|
| 42 | * Unregisters an exporter.
|
| 43 | * @param exporter The exporter to stop sending traces to.
|
| 44 | */
|
| 45 | unregisterExporter(exporter: exportersTypes.Exporter): Tracing;
|
| 46 | }
|