output
    Preparing search index...

    Variable TracingConst

    Tracing: {
        Attribute: typeof Attribute;
        addEventAttribute(
            args: { attribute: Attribute.Instance; eventId: string },
        ): void;
        addEventEnd(args: { details: unknown; id: string }): void;
        addEventError(args: { details: unknown; id: string }): void;
        addEventStart(
            args: { details: unknown; id: string; kind: string; name: string },
        ): void;
    }

    Tools to interact with Tracing

    Type Declaration

    • Attribute: typeof Attribute
    • addEventAttribute: function
      • Adds an attribute to an event.

        Parameters

        • args: { attribute: Attribute.Instance; eventId: string }
          • attribute: Attribute.Instance

            The attribute to attach to the event.

          • eventId: string

            The id of the event to attach the attribute to.

        Returns void

    • addEventEnd: function
      • Concludes an event.

        Parameters

        • args: { details: unknown; id: string }
          • details: unknown

            Arbitrary data to add to this event, it will be used as the "output" field.

          • id: string

            The id of the event to conclude.

        Returns void

    • addEventError: function
      • Concludes an event with an error.

        Parameters

        • args: { details: unknown; id: string }
          • details: unknown

            Arbitrary data to add to this event, it will be used as the "error" field.

          • id: string

            The id of the event to conclude.

        Returns void

    • addEventStart: function
      • Creates a new event.

        Parameters

        • args: { details: unknown; id: string; kind: string; name: string }
          • details: unknown

            Arbitrary data to add to this event, it will be used as the "input" field.

          • id: string

            A unique id for the Event.

          • kind: string

            The kind of Event, like HTTP, DiskWrite, DBOp, etc.

          • name: string

            The human-friendly name of the Event: query, request, create.

        Returns void