go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/common/tsmon/monitor/monitor.go (about)

     1  // Copyright 2015 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Package monitor contains the code for sending metric data to monitoring
    16  // endpoints.
    17  package monitor
    18  
    19  import (
    20  	"context"
    21  
    22  	"go.chromium.org/luci/common/tsmon/types"
    23  )
    24  
    25  // A Monitor can send a collection of metrics somewhere.
    26  type Monitor interface {
    27  	// ChunkSize returns the maximum number of metrics this Monitor can Send in
    28  	// one go.  If there are more metrics, they will be broken up into chunks and
    29  	// Send will be called multiple times.  A ChunkSize of 0 disables chunking.
    30  	ChunkSize() int
    31  
    32  	Send(ctx context.Context, cells []types.Cell) error
    33  
    34  	// Close closes any resources held by the monitor.
    35  	//
    36  	// Close need not be called at program exit.
    37  	Close() error
    38  }