@microsoft/applicationinsights-common 2.8.4-nightly.2205-07 → 2.8.4-nightly.2205-10

package/types/Interfaces/ITraceParent.d.ts

@@ -1,32 +0,0 @@
-/**
- * This interface represents the components of a W3C traceparent header
- */
-export interface ITraceParent {
-    /**
-     * The version of the definition, this MUST be a string with a length of 2 and only contain lowercase
-     * hexadecimal characters. A value of 'ff' is considered to be an invalid version.
-     */
-    version: string;
-    /**
-     * This is the ID of the whole trace forest and is used to uniquely identify a distributed trace
-     * through a system. It is represented as a 32-character string of lowercase hexadecimal characters,
-     * for example, 4bf92f3577b34da6a3ce929d0e0e4736.
-     * All characters as zero (00000000000000000000000000000000) is considered an invalid value.
-     */
-    traceId: string;
-    /**
-     * This is the ID of the current request as known by the caller (in some tracing systems, this is also
-     * known as the parent-id, where a span is the execution of a client request). It is represented as an
-     * 16-character string of lowercase hexadecimal characters, for example, 00f067aa0ba902b7.
-     * All bytes as zero (0000000000000000) is considered an invalid value.
-     */
-    spanId: string;
-    /**
-     * An 8-bit value of flags that controls tracing such as sampling, trace level, etc. These flags are
-     * recommendations given by the caller rather than strict rules to follow.
-     * As this is a bit field, you cannot interpret flags by decoding the hex value and looking at the resulting
-     * number. For example, a flag 00000001 could be encoded as 01 in hex, or 09 in hex if present with the flag
-     * 00001000. A common mistake in bit fields is forgetting to mask when interpreting flags.
-     */
-    traceFlags: number;
-}

package/types/W3cTraceParent.d.ts

@@ -1,59 +0,0 @@
-import { ITraceParent } from "./Interfaces/ITraceParent";
-/**
- * Create a new ITraceParent instance using the provided values.
- * @param traceId - The traceId to use, when invalid a new random W3C id will be generated.
- * @param spanId - The parent/span id to use, a new random value will be generated if it is invalid.
- * @param flags - The traceFlags to use, defaults to zero (0) if not supplied or invalid
- * @param version - The version to used, defaults to version "01" if not supplied or invalid.
- * @returns
- */
-export declare function createTraceParent(traceId?: string, spanId?: string, flags?: number, version?: string): ITraceParent;
-/**
- * Attempt to parse the provided string as a W3C TraceParent header value (https://www.w3.org/TR/trace-context/#traceparent-header)
- *
- * @param value
- * @returns
- */
-export declare function parseTraceParent(value: string): ITraceParent;
-/**
- * Is the provided W3c Trace Id a valid string representation, it must be a 32-character string
- * of lowercase hexadecimal characters for example, 4bf92f3577b34da6a3ce929d0e0e4736.
- * If all characters as zero (00000000000000000000000000000000) it will be considered an invalid value.
- * @param value - The W3c trace Id to be validated
- * @returns true if valid otherwise false
- */
-export declare function isValidTraceId(value: string): boolean;
-/**
- * Is the provided W3c span id (aka. parent id) a valid string representation, it must be a 16-character
- * string of lowercase hexadecimal characters, for example, 00f067aa0ba902b7.
- * If all characters are zero (0000000000000000) this is considered an invalid value.
- * @param value - The W3c span id to be validated
- * @returns true if valid otherwise false
- */
-export declare function isValidSpanId(value: string): boolean;
-/**
- * Validates that the provided ITraceParent instance conforms to the currently supported specifications
- * @param value
- * @returns
- */
-export declare function isValidTraceParent(value: ITraceParent): boolean;
-/**
- * Is the parsed traceParent indicating that the trace is currently sampled.
- * @param value - The parsed traceParent value
- * @returns
- */
-export declare function isSampledFlag(value: ITraceParent): boolean;
-/**
- * Format the ITraceParent value as a string using the supported and know version formats.
- * So even if the passed traceParent is a later version the string value returned from this
- * function will convert it to only the known version formats.
- * This currently only supports version "00" and invalid "ff"
- * @param value - The parsed traceParent value
- * @returns
- */
-export declare function formatTraceParent(value: ITraceParent): string;
-/**
- * Helper function to fetch the passed traceparent from the page, looking for it as a meta-tag or a Server-Timing header.
- * @returns
- */
-export declare function findW3cTraceParent(): ITraceParent;