forked from grafana/k6
-
Notifications
You must be signed in to change notification settings - Fork 0
/
collector.go
54 lines (45 loc) · 1.79 KB
/
collector.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
/*
*
* 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 lib
import (
"context"
"io"
"github.com/loadimpact/k6/stats"
)
// A Collector abstracts away the details of a storage backend from the application.
type Collector interface {
// Init is called between the collector's creation and the call to Run().
// You should do any lenghty setup here rather than in New.
Init() error
// Run is called in a goroutine and starts the collector. Should commit samples to the backend
// at regular intervals and when the context is terminated.
Run(ctx context.Context)
// Collect receives a set of samples. This method is never called concurrently, and only while
// the context for Run() is valid, but should defer as much work as possible to Run().
Collect(samples []stats.Sample)
// Optionally return a link that is shown to the user.
Link() string
}
// An AuthenticatedCollector is a collector that can store persistent authentication.
type AuthenticatedCollector interface {
Collector
// Present a login form to the user.
Login(conf interface{}, in io.Reader, out io.Writer) (interface{}, error)
}