diff --git a/collectors/README.md b/collectors/README.md index 8002ed2..24119ad 100644 --- a/collectors/README.md +++ b/collectors/README.md @@ -51,7 +51,7 @@ A collector reads data from any source, parses it to metrics and submits these m * `Name() string`: Return the name of the collector * `Init(config json.RawMessage) error`: Initializes the collector using the given collector-specific config in JSON. Check if needed files/commands exists, ... * `Initialized() bool`: Check if a collector is successfully initialized -* `Read(duration time.Duration, output chan ccMetric.CCMetric)`: Read, parse and submit data to the `output` channel as [`CCMetric`](../internal/ccMetric/README.md). If the collector has to measure anything for some duration, use the provided function argument `duration`. +* `Read(duration time.Duration, output chan ccMetric.CCMetric)`: Read, parse and submit data to the `output` channel as [`CCMetric`](../internal/ccMetric/README.md). If the collector has to measure anything for some duration, use the provided function argument `duration`. * `Close()`: Closes down the collector. It is recommanded to call `setup()` in the `Init()` function. diff --git a/collectors/sampleMetric.go b/collectors/sampleMetric.go index 056ed85..4c3ac66 100644 --- a/collectors/sampleMetric.go +++ b/collectors/sampleMetric.go @@ -17,9 +17,9 @@ type SampleCollectorConfig struct { // defined by metricCollector (name, init, ...) type SampleCollector struct { metricCollector - config SampleTimerCollectorConfig // the configuration structure - meta map[string]string // default meta information - tags map[string]string // default tags + config SampleCollectorConfig // the configuration structure + meta map[string]string // default meta information + tags map[string]string // default tags } // Functions to implement MetricCollector interface @@ -36,14 +36,14 @@ func (m *SampleCollector) Init(config json.RawMessage) error { // This is for later use, also call it early m.setup() // Tell whether the collector should be run in parallel with others (reading files, ...) - // or it should be run serially, mostly for collectors acutally doing measurements + // or it should be run serially, mostly for collectors actually doing measurements // because they should not measure the execution of the other collectors m.parallel = true // Define meta information sent with each metric // (Can also be dynamic or this is the basic set with extension through AddMeta()) m.meta = map[string]string{"source": m.name, "group": "SAMPLE"} // Define tags sent with each metric - // The 'type' tag is always needed, it defines the granulatity of the metric + // The 'type' tag is always needed, it defines the granularity of the metric // node -> whole system // socket -> CPU socket (requires socket ID as 'type-id' tag) // die -> CPU die (requires CPU die ID as 'type-id' tag) diff --git a/collectors/sampleTimerMetric.go b/collectors/sampleTimerMetric.go index 8b09bc1..dfac808 100644 --- a/collectors/sampleTimerMetric.go +++ b/collectors/sampleTimerMetric.go @@ -38,7 +38,7 @@ func (m *SampleTimerCollector) Init(name string, config json.RawMessage) error { // (Can also be dynamic or this is the basic set with extension through AddMeta()) m.meta = map[string]string{"source": m.name, "group": "SAMPLE"} // Define tags sent with each metric - // The 'type' tag is always needed, it defines the granulatity of the metric + // The 'type' tag is always needed, it defines the granularity of the metric // node -> whole system // socket -> CPU socket (requires socket ID as 'type-id' tag) // cpu -> single CPU hardware thread (requires cpu ID as 'type-id' tag) @@ -60,7 +60,7 @@ func (m *SampleTimerCollector) Init(name string, config json.RawMessage) error { // Storage for output channel m.output = nil - // Mangement channel for the timer function. + // Management channel for the timer function. m.done = make(chan bool) // Create the own ticker m.ticker = time.NewTicker(m.interval) @@ -94,7 +94,7 @@ func (m *SampleTimerCollector) ReadMetrics(timestamp time.Time) { value := 1.0 - // If you want to measure something for a specific amout of time, use interval + // If you want to measure something for a specific amount of time, use interval // start := readState() // time.Sleep(interval) // stop := readState()