storagecleaner

README

storage_cleaner

This module implements an extension that allows purging the backend storage by making an HTTP POST request to it.

The storage_cleaner extension is intended to be used only in tests, providing a way to clear the storage between test runs. Making a POST request to the exposed endpoint will delete all data in storage.

flowchart LR
    Receiver --> Processor
    Processor --> Exporter
    JaegerStorageExension -->|"(1) get storage"| Exporter
    Exporter -->|"(2) write trace"| Storage

    E2E_test -->|"(1) POST /purge"| HTTP_endpoint
    JaegerStorageExension -->|"(2) getStorage()"| HTTP_endpoint
    HTTP_endpoint -.->|"(3) storage.(*storage.Purger).Purge()"| Storage

    subgraph Jaeger Collector
        Receiver
        Processor
        Exporter
        
        Storage
        StorageCleanerExtension
        HTTP_endpoint
        subgraph JaegerStorageExension
            Storage
        end
        subgraph StorageCleanerExtension
            HTTP_endpoint
        end
    end

Getting Started

The following settings are required:

• trace_storage : name of a storage backend defined in jaegerstorage extension

extensions:
  storage_cleaner:
    trace_storage: storage_name

Documentation

Index

• Constants
• Variables
• func NewFactory() extension.Factory
• type Config
  • func (cfg *Config) Validate() error

Constants

const (
	Port = "9231"
	URL  = "/purge"
)

Variables

var ID = component.NewID(componentType)

ID is the identifier of this extension.

Functions

func NewFactory

func NewFactory() extension.Factory

Types

type Config

type Config struct {
	TraceStorage string `valid:"required" mapstructure:"trace_storage"`
	Port         string `mapstructure:"port"`
}

func (*Config) Validate

func (cfg *Config) Validate() error