plugins

Documentation

Index

• Constants
• Variables
• func GetAll() map[string]Plugin
• func GetDefaultValues(name string) (map[string]string, error)
• func GetTemplate(name string) (string, error)
• func RegisterPlugin(name string, template string, values map[string]string)
• type Plugin
• type Reconciler
  • func New(client client.Client, pluginList *loggingv1alpha1.PluginList, namespace string) *Reconciler
  • func (r *Reconciler) Reconcile(log logr.Logger) error

Constants

const AlibabaOutput = "alibaba"

AlibabaOutput CRD name

const AlibabaTemplate = `` /* 401-byte string literal not displayed */

AlibabaTemplate for Alibaba OSS output plugin

const AzureOutput = "azure"

AzureOutput CRD name

const AzureTemplate = `` /* 814-byte string literal not displayed */

AzureTemplate for Azure ObjectStore output plugin

const ElasticsearchOutput = "elasticsearch"

ElasticsearchOutput CRD name

const ElasticsearchTemplate = `` /* 1065-byte string literal not displayed */

ElasticsearchTemplate for Elasticsearch output plugin

const GCSOutput = "gcs"

GCSOutput CRD name

const GCSTemplate = `` /* 656-byte string literal not displayed */

GCSTemplate for Google Cloud Storage output plugin

const LokiOutput = "loki"

LokiOutput CRD name

const LokiTemplate = `` /* 315-byte string literal not displayed */

LokiTemplate for Loki output plugin

const ParserFilter = "parser"

ParserFilter CRD name

const ParserFilterTemplate = `` /* 169-byte string literal not displayed */

ParserFilterTemplate for parser plugin

const S3Output = "s3"

S3Output CRD name

const S3Template = `` /* 1242-byte string literal not displayed */

S3Template for Amazaon S3 output plugin

Variables

var AlibabaDefaultValues = map[string]string{
	"buffer_chunk_limit":    "1m",
	"buffer_path":           "/buffers/ali",
	"time_slice_format":     "%Y%m%d",
	"time_slice_wait":       "10m",
	"oss_object_key_format": "%{time_slice}/%{host}-%{uuid}.%{file_ext}",
}

AlibabaDefaultValues for Alibaba OSS output plugin

var AzureDefaultValues = map[string]string{
	"bufferTimeKey":           "3600",
	"bufferTimeWait":          "10m",
	"bufferPath":              "/buffers/azure",
	"format":                  "json",
	"timekey":                 "1h",
	"timekey_wait":            "10m",
	"timekey_use_utc":         "true",
	"time_slice_format":       "%Y%m%d-%H",
	"azure_object_key_format": "%{path}%{time_slice}_%{index}.%{file_extension}",
	"path":                    "logs/${tag}/%Y/%m/%d/",
}

AzureDefaultValues for Azure ObjectStore output plugin

var ElasticsearchDefaultValues = map[string]string{
	"bufferPath":         "/buffers/elasticsearch",
	"logLevel":           "info",
	"logstashFormat":     "true",
	"logstashPrefix":     "logstash",
	"scheme":             "scheme",
	"sslVerify":          "true",
	"sslVersion":         "TLSv1_2",
	"chunkLimit":         "2M",
	"queueLimit":         "8",
	"timekey":            "1h",
	"timekey_wait":       "10m",
	"timekey_use_utc":    "true",
	"retry_max_interval": "30",
	"flush_interval":     "5s",
	"flush_thread_count": "2",
	"retry_forever":      "true",
	"user":               "",
	"password":           "",
}

ElasticsearchDefaultValues for Elasticsearch output plugin

var GCSDefaultValues = map[string]string{
	"bufferTimeKey":     "3600",
	"bufferTimeWait":    "10m",
	"bufferPath":        "/buffers/gcs",
	"object_key_format": "%{path}%{time_slice}_%{index}.%{file_extension}",
	"path":              "logs/${tag}/%Y/%m/%d/",
	"timekey":           "1h",
	"timekey_wait":      "10m",
	"timekey_use_utc":   "true",
	"format":            "json",
}

GCSDefaultValues for Google Cloud Storage output plugin

var LokiDefaultValues = map[string]string{
	"url":             "",
	"username":        "",
	"password":        "",
	"extraLabels":     "",
	"flushInterval":   "10s",
	"chunkLimitSize":  "1m",
	"flushAtShutdown": "true",
}

LokiDefaultValues for Loki output plugin

var ParserFilterDefaultValues = map[string]string{
	"keyName":     "log",
	"reserveData": "false",
}

ParserFilterDefaultValues for parser plugin

var S3DefaultValues = map[string]string{
	"bufferTimeKey":        "3600",
	"bufferTimeWait":       "10m",
	"bufferPath":           "/buffers/s3",
	"format":               "json",
	"timekey_use_utc":      "true",
	"s3_object_key_format": "%{path}%{time_slice}_%{index}.%{file_extension}",
}

S3DefaultValues for Amazaon S3 output plugin

Functions

func GetAll

func GetAll() map[string]Plugin

GetAll returns the plugin registry

func GetDefaultValues

func GetDefaultValues(name string) (map[string]string, error)

GetDefaultValues get default values by name

func GetTemplate

func GetTemplate(name string) (string, error)

GetTemplate get template string by name

func RegisterPlugin

func RegisterPlugin(name string, template string, values map[string]string)

RegisterPlugin to use in CRD file

Types

type Plugin

type Plugin struct {
	Template      string
	DefaultValues map[string]string
}

Plugin struct to store plugin informations

type Reconciler

type Reconciler struct {
	resources.PluginReconciler
}

Reconciler holds info what resource to reconcile

func New

func New(client client.Client, pluginList *loggingv1alpha1.PluginList, namespace string) *Reconciler

New creates a new FPlugin reconciler

func (*Reconciler) Reconcile

func (r *Reconciler) Reconcile(log logr.Logger) error

Reconcile reconciles the plugin resource