b3-format.d.ts 1.2 KB

1234567891011121314151617181920212223242526272829303132333435
  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 { HeaderGetter, HeaderSetter, Propagation, SpanContext } from '@opencensus/core';
  17. /** Propagates span context through B3 Format propagation. */
  18. export declare class B3Format implements Propagation {
  19. /**
  20. * Gets the trace context from a request headers. If there is no trace context
  21. * in the headers, null is returned.
  22. * @param getter
  23. */
  24. extract(getter: HeaderGetter): SpanContext;
  25. /**
  26. * Adds a trace context in a request headers.
  27. * @param setter
  28. * @param spanContext
  29. */
  30. inject(setter: HeaderSetter, spanContext: SpanContext): void;
  31. /**
  32. * Generate SpanContexts
  33. */
  34. generate(): SpanContext;
  35. }