@opencensus/propagation-stackdriver
Version:
Opencensus propagation package for Stackdriver format.
36 lines (35 loc) • 1.42 kB
TypeScript
/**
* 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 { HeaderGetter, HeaderSetter, Propagation, SpanContext } from './index';
/** Header that carries span context across Google infrastructure. */
export declare const TRACE_CONTEXT_HEADER_NAME = "x-cloud-trace-context";
/** Propagates span context through Stackdriver Format propagation. */
export declare class StackdriverFormat implements Propagation {
/**
* Gets the span context from a request headers. If there is no span context
* in the headers, null is returned.
* @param getter
*/
extract(getter: HeaderGetter): SpanContext | null;
/**
* Adds a span context in a request headers.
* @param setter
* @param spanContext
*/
inject(setter: HeaderSetter, spanContext: SpanContext): void;
/** Generate SpanContexts */
generate(): SpanContext;
}