integration

README

Integration

The Jaeger v2 integration test is an extension of the existing integration.StorageIntegration designed to test the Jaeger-v2 OtelCol binary; currently, it only tests the span store. The existing tests at plugin/storage/integration (also called "unit mode") test by writing and reading span data directly to the storage API. In contrast, these tests (or "e2e mode") read and write span data through the RPC client to the Jaeger-v2 OtelCol binary. E2E mode tests read from the jaeger_query extension and write to the receiver in OTLP formats. For details, see the Architecture section below.

Architecture

flowchart LR
    Test -->|writeSpan| SpanWriter
    SpanWriter --> RPCW[RPC_client]
    RPCW --> Receiver
    Receiver --> Exporter
    Exporter --> B(StorageBackend)
    Test -->|readSpan| SpanReader
    SpanReader --> RPCR[RPC_client]
    RPCR --> jaeger_query
    jaeger_query --> B

    subgraph Integration Test Executable
        Test
        SpanWriter
        SpanReader
        RPCW
        RPCR
    end

    subgraph jaeger-v2
        Receiver
        Exporter
        jaeger_query
    end

gRPC Integration Test

To conduct the tests, run the following command:

STORAGE=grpc \
  SPAN_STORAGE_TYPE=memory \
  make jaeger-v2-storage-integration-test

Documentation

Index

• type E2EStorageIntegration

Types

type E2EStorageIntegration

type E2EStorageIntegration struct {
	integration.StorageIntegration
	ConfigFile string
}

E2EStorageIntegration holds components for e2e mode of Jaeger-v2 storage integration test. The intended usage is as follows:

• Initialize a specific storage implementation declares its own test functions (e.g. starts remote-storage).
• Then, instantiates with e2eInitialize() to run the Jaeger-v2 collector and also the SpanWriter and SpanReader.
• After that, calls RunSpanStoreTests().
• Clean up with e2eCleanup() to close the SpanReader and SpanWriter connections.
• At last, clean up anything declared in its own test functions. (e.g. close remote-storage)