collector.go

/*
 *
 * k6 - a next-generation load testing tool
 * Copyright (C) 2016 Load Impact
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package dummy

import (
	"context"
	"sync"

	"github.com/loadimpact/k6/lib"
	"github.com/loadimpact/k6/stats"
)

type Collector struct {
	Samples []stats.Sample
	running bool

	lock sync.Mutex
}

func (c *Collector) Init() error { return nil }

func (c *Collector) MakeConfig() interface{} { return nil }

func (c *Collector) Run(ctx context.Context) {
	c.lock.Lock()
	c.running = true
	c.lock.Unlock()

	<-ctx.Done()

	c.lock.Lock()
	c.running = false
	c.lock.Unlock()
}

func (c *Collector) Collect(samples []stats.Sample) {
	c.lock.Lock()
	defer c.lock.Unlock()

	if !c.running {
		panic("attempted to collect while not running")
	}
	c.Samples = append(c.Samples, samples...)
}

func (c *Collector) Link() string {
	return "http://example.com/"
}

// GetRequiredSystemTags returns which sample tags are needed by this collector
func (c *Collector) GetRequiredSystemTags() lib.TagSet {
	return lib.TagSet{} // There are no required tags for this collector
}