Skip to content

Commit

Permalink
Add Propagation interface
Browse files Browse the repository at this point in the history
  • Loading branch information
mayurkale22 committed Jun 24, 2019
1 parent 9a56922 commit 7981d52
Showing 1 changed file with 42 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/**
* Copyright 2019, OpenTelemetry 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
*
* https://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 { SpanContext } from '../../trace/span_context';

export interface Propagation {
/**
* Injects the given SpanContext instance to transmit over the wire.
*
* OpenTelemetry defines a common set of format values (BinaryFormat and
* HTTPTextFormat), and each has an expected carrier type.
*
* @param spanContext the SpanContext to transmit over the wire..
* @param format the format of the carrier.
* @param carrier the carrier of propagation fields, such as an http request.
*/
inject(spanContext: SpanContext, format: string, carrier: unknown): void;

/**
* Returns a SpanContext instance extracted from carrier in the given
* format from upstream.
*
* @param format the format of the carrier.
* @param carrier the carrier of propagation fields, such as an http request.
* @returns SpanContext The extracted SpanContext, or null if no such
* SpanContext could be found in carrier.
*/
extract(format: string, carrier: unknown): SpanContext | null;
}

0 comments on commit 7981d52

Please sign in to comment.