Options
All
  • Public
  • Public/Protected
  • All
Menu

xray-well

This file is exported when you require("xray-well")

Index

Namespaces

Variables

Functions

Variables

Const daemon

daemon: { generateID: () => string; generateTime: (date?: Date) => number; generateTraceID: () => string; sendData: (segment: Segment) => void } = ...

Daemon function, useful to create own segments.

Type declaration

  • generateID: () => string
  • generateTime: (date?: Date) => number
      • (date?: Date): number

      • Generate time in epoch (xray service format).

        Parameters

        • date: Date = ...

          Date Object

        Returns number

  • generateTraceID: () => string
  • sendData: (segment: Segment) => void

      • Prepare segment and send segment to XRay Daemon.

        Parameters

        Returns void

Const middleware

middleware: { express: (middlewareConfig?: MiddlewareConfig) => (req: any, res: any, next: () => void) => void; koa: (middlewareConfig?: MiddlewareConfig) => (ctx: any, next: () => Promise<void>) => Promise<void> } = ...

Middlewares for Web Frameworks and others solutions.

Type declaration

  • express: (middlewareConfig?: MiddlewareConfig) => (req: any, res: any, next: () => void) => void
      • (middlewareConfig?: MiddlewareConfig): (req: any, res: any, next: () => void) => void

      • Express middleware for XRayWell usage: app.use(expressXRayMiddleware({ name: "my-application" }));

        Parameters

        • middlewareConfig: MiddlewareConfig = defaultConfig

          Setup baheavor of segments generated by express

        Returns (req: any, res: any, next: () => void) => void

          • (req: any, res: any, next: () => void): void

          • Parameters

            • req: any
            • res: any
            • next: () => void
                • (): void

                • Returns void

            Returns void

  • koa: (middlewareConfig?: MiddlewareConfig) => (ctx: any, next: () => Promise<void>) => Promise<void>
      • (middlewareConfig?: MiddlewareConfig): (ctx: any, next: () => Promise<void>) => Promise<void>

      • Koa middleware for XRayWell usage: app.use(koaXRayMiddleware({ name: "my-application" }));

        Parameters

        • middlewareConfig: MiddlewareConfig = defaultConfig

          Setup baheavor of segments generated by koa

        Returns (ctx: any, next: () => Promise<void>) => Promise<void>

          • (ctx: any, next: () => Promise<void>): Promise<void>

          • Parameters

            • ctx: any
            • next: () => Promise<void>
                • (): Promise<void>

                • Returns Promise<void>

            Returns Promise<void>

Const segment

segment: { createSegment: (segmentName: string, traceID?: string, parentSegmentID?: string) => Segment; forkSegment: (segmentName: string, segment: Segment) => Segment; submitSegment: (segment: Segment) => string; submitSegmentPart: (segment: Segment) => string } = ...

Segments functions.

Type declaration

  • createSegment: (segmentName: string, traceID?: string, parentSegmentID?: string) => Segment
      • (segmentName: string, traceID?: string, parentSegmentID?: string): Segment

      • Create a Segment Document.

        Parameters

        • segmentName: string

          Segment name

        • Optional traceID: string

          TraceID (use only on nestedSegments)

        • Optional parentSegmentID: string

          Parent Segment ID (use only on nestedSegments)

        Returns Segment

  • forkSegment: (segmentName: string, segment: Segment) => Segment

      • Fork a segment to a new one for nestedSegments.

        Another way to do that is using createSegment with traceID and parentID, this function is a shortcut.

        Parameters

        • segmentName: string

          Segment name

        • segment: Segment

          Segment

        Returns Segment

  • submitSegment: (segment: Segment) => string

      • Send to XRay Daemon Segments finalized, not in progress anymore.

        Parameters

        Returns string

  • submitSegmentPart: (segment: Segment) => string

      • Send to XRay Daemon Segments in progress yet.

        Parameters

        Returns string

Functions

activeUptime

  • activeUptime(active?: boolean, secondsUpdate?: number): void

  • Collect and send process uptime in evert segment.

    Parameters

    • active: boolean = true

      boolean

    • secondsUpdate: number = 30

      interval to read uptime in seconds

    Returns void

setConfig

  • setConfig(config: Config): void

  • Set XRayWell global configuration.

    Parameters

    Returns void