github.com/alibaba/ilogtail/pkg@v0.0.0-20250526110833-c53b480d046c/pipeline/context.go (about)

     1  // Copyright 2021 iLogtail 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 pipeline
    16  
    17  import (
    18  	"context"
    19  
    20  	"github.com/alibaba/ilogtail/pkg/config"
    21  	"github.com/alibaba/ilogtail/pkg/selfmonitor"
    22  )
    23  
    24  // Context for plugin
    25  type Context interface {
    26  	InitContext(project, logstore, configName string)
    27  
    28  	GetConfigName() string
    29  	GetProject() string
    30  	GetLogstore() string
    31  	GetRuntimeContext() context.Context
    32  	GetPipelineScopeConfig() *config.GlobalConfig
    33  	GetExtension(name string, cfg any) (Extension, error)
    34  	// RegisterCounterMetric(metric CounterMetric)
    35  	// RegisterStringMetric(metric StringMetric)
    36  	// RegisterLatencyMetric(metric LatencyMetric)
    37  
    38  	SaveCheckPoint(key string, value []byte) error
    39  	GetCheckPoint(key string) (value []byte, exist bool)
    40  	SaveCheckPointObject(key string, obj interface{}) error
    41  	GetCheckPointObject(key string, obj interface{}) (exist bool)
    42  
    43  	// APIs for self monitor
    44  	RegisterMetricRecord(labels []selfmonitor.LabelPair) *selfmonitor.MetricsRecord
    45  	GetMetricRecord() *selfmonitor.MetricsRecord
    46  	ExportMetricRecords() []map[string]string
    47  	RegisterLogstoreConfigMetricRecord(labels []selfmonitor.LabelPair) *selfmonitor.MetricsRecord
    48  	GetLogstoreConfigMetricRecord() *selfmonitor.MetricsRecord
    49  }