kube-logger

command module

v0.1.1 Latest Latest Go to latest Published: Apr 20, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/papaya147/kube-logger

Links

Open Source Insights

README ¶

kube-logger

A Go log client for Kubernetes clusters. Supported config file names by preference in the same path as execution:

kube-logger.yaml
kube-logger.json

Getting started

Run go build github.com/papaya147/kube-logger
Set up a configuration file
Run ./kube-logger (move to a Docker image to ease deployment)

Configuration File Format

Property	Description	Type	Mandatory	Default Value	Accepted Values
`namespaces`	Array of namespaces to watch	`[]string`	false	`default`	any
`pod_prefixes`	Array of pods within namespace to watch	`[]string`	false	any	any
`cluster_provider`	Provider of the EKS cluster to generate a Kubernetes clientset API	`string`	true	none	`eks`
`eks.cluster_name`	Name of the EKS cluster	`string`	true (if cluster provider is `eks`)	none	any
`eks.region`	Region of the EKS cluster	`string`	true (if cluster provider is `eks`)	none	any
`eks.access_key`	Access key with credentials to the EKS cluster	`string`	true (if cluster provider is `eks`)	none	any
`eks.secret_key`	Secret key with credentials to the EKS cluster	`string`	true (if cluster provider is `eks`)	none	any
`console.active`	Use console sink	`boolean`	false	`false`	`true`, `false`
`mongo.active`	Use MongoDB sink	`boolean`	false	`false`	`true`, `false`
`mongo.connection_uri`	MongoDB host endpoint with port and credentials	`string`	true (if `mongo.active`)	none	any
`mongo.database`	MongoDB database name (need not exist already)	`string`	true (if `mongo.active`)	none	any
`mongo.collection`	MongoDB collection name (need not exist already)	`string`	true (if `mongo.active`)	none	any
`elasticsearch.active`	Use ElasticSearch sink	`boolean`	fasle	`false`	`true`, `false`
`elasticsearch.host`	ElasticSearch host endpoint with port	`string`	true (if `elasticsearch.active`)	none	any
`elasticsearch.username`	ElasticSearch username	`string`	true (if `elasticsearch.active`)	none	any
`elasticsearch.password`	ElasticSearch password	`string`	true (if `elasticsearch.active`)	none	any
`elasticsearch.index`	ElasticSearch index name (need not exist already)	`string`	true (if `elasticsearch.active`)	none	any

Example

namespaces:
  - default
pod_prefixes:
  - auth
cluster_provider: eks
eks:
  cluster_name: backend-prod
  region: ap-south-1
  access_key: <AWS-ACCESS-KEY>
  secret_key: <AWS-SECRET-KEY>
console:
  active: true
mongo:
  active: true
  connection_uri: mongodb://localhost:27017
  database: logs
  collection: logs
elasticsearch:
  active: true
  host: http://localhost:9200
  username: elastic
  password: elastic
  index: logs

Supported Providers

AWS EKS

Supported Log Sinks

Console (Colored terminal output)
MongoDB
ElasticSearch

Documentation ¶

There is no documentation for this package.

Source Files ¶

View all Source files

main.go

Directories ¶

Path	Synopsis
config
logs
util

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL