[chore] some doc changes to consumer package (#9150)
small changes to some docs.
This commit is contained in:
parent
9f0c9e17fc
commit
44fbb84a0f
|
|
@ -10,7 +10,7 @@ import (
|
|||
// Capabilities describes the capabilities of a Processor.
|
||||
type Capabilities struct {
|
||||
// MutatesData is set to true if Consume* function of the
|
||||
// processor modifies the input TraceData or MetricsData argument.
|
||||
// processor modifies the input Traces, Logs or Metrics argument.
|
||||
// Processors which modify the input data MUST set this flag to true. If the processor
|
||||
// does not modify the data it MUST set this flag to false. If the processor creates
|
||||
// a copy of the data before modifying then this flag can be safely set to false.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
// Copyright The OpenTelemetry Authors
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// Package consumer contains interfaces that receive and process consumerdata.
|
||||
// Package consumer contains interfaces that receive and process data.
|
||||
package consumer // import "go.opentelemetry.io/collector/consumer"
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ import (
|
|||
"go.opentelemetry.io/collector/pdata/pmetric"
|
||||
)
|
||||
|
||||
// Metrics is the new metrics consumer interface that receives pmetric.Metrics, processes it
|
||||
// Metrics is an interface that receives pmetric.Metrics, processes it
|
||||
// as needed, and sends it to the next processing node if any or to the destination.
|
||||
type Metrics interface {
|
||||
baseConsumer
|
||||
|
|
|
|||
Loading…
Reference in New Issue