Skip to content

Commit

Permalink
add ContextManager interface open-telemetry#46
Browse files Browse the repository at this point in the history
  • Loading branch information
vmarchaud committed Jul 4, 2019
1 parent 5557c29 commit 4c08972
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
2 changes: 2 additions & 0 deletions packages/opentelemetry-context-base/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/

export * from './types';
51 changes: 51 additions & 0 deletions packages/opentelemetry-context-base/src/types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
/**
* 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
*
* 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.
*/

export interface BaseContext {
/**
* Get the current state of the context propagation
*/
active: boolean;

/**
* Wrap an object in the current context (or optionally in a specific context)
* @param object Object to which a context need to be set
* @param [context] Optionaly specify the context which you want to assign
*/
wrap<T>(object: T, context?: unknown): T;

/**
* Get the current value of a given key from the current context.
* There are specific case where the context is not propagated by specific
* code (ex: user space queueing) so expect it to be undefined sometimes.
*/
get(key: string): unknown;

/**
* Set the value of a given key in the current context.
*/
set(key: string, value: unknown): void;

/**
* Enable context propagation
*/
enable(): void;

/**
* Disable context propagation
*/
disable(): void;
}

0 comments on commit 4c08972

Please sign in to comment.