Options
All
  • Public
  • Public/Protected
  • All
Menu

malabi

Index

Namespaces

Classes

Functions Main Functions

Functions Other

Main Functions Functions

  • instrument(InstrumentationConfig: InstrumentationConfig): void
  • Enables OpenTelemetry instrumentation for Malabi. Used in both test runner and service under test

    Parameters

    • InstrumentationConfig: InstrumentationConfig

      Config for creating the instrumentation

    Returns void

  • A wrapper that handles creating a span per test run. returns the spans that were created inside the callback function ready for assertion.

    Parameters

    • callback: any

      an async function containing all of the current test's span generating operations(API calls etc)

    Returns Promise<TelemetryRepository>

Other Functions

  • serveMalabiFromHttpApp(port: number, instrumentationConfig: InstrumentationConfig): any
  • Exposes an endpoint that returns spans created during the test run

    Parameters

    • port: number

      the port on which to expose the malabi endpoint

    • instrumentationConfig: InstrumentationConfig

      contains the service name being tested. example: { serviceName: 'some-service' }

    Returns any

Generated using TypeDoc