https://github.com/xing/kubernetes-event-forwarder-gelf

Forward Kubernetes Events using the Graylog Extended Log Format
https://github.com/xing/kubernetes-event-forwarder-gelf

gelf graylog k8s kubernetes logging monitoring olympus

Last synced: 6 months ago
JSON representation

Forward Kubernetes Events using the Graylog Extended Log Format

• Host: GitHub
• URL: https://github.com/xing/kubernetes-event-forwarder-gelf
• Owner: xing
• License: apache-2.0
• Created: 2019-01-08T15:27:52.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-06-10T13:27:40.000Z (about 5 years ago)
• Last Synced: 2024-06-20T01:55:40.724Z (almost 2 years ago)
• Topics: gelf, graylog, k8s, kubernetes, logging, monitoring, olympus
• Language: Go
• Size: 46.9 KB
• Stars: 36
• Watchers: 27
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# kubernetes-event-forwarder-gelf

[![Build Status](https://travis-ci.org/xing/kubernetes-event-forwarder-gelf.svg?branch=master)](https://travis-ci.org/xing/kubernetes-event-forwarder-gelf)

Forward Kubernetes Events using the Graylog Extended Log Format.

## Usage

    Usage:

      event-forwarder-gelf [OPTIONS]

    Application Options:

      -v, --verbose= Show verbose debug information [$VERBOSE]

          --host=    Graylog TCP endpoint host [$GRAYLOG_HOST]

          --port=    Graylog TCP endpoint port [$GRAYLOG_PORT]

          --cluster= Name of this cluster [$CLUSTER]

          --version  Print version information

    Help Options:

      -h, --help     Show this help message

Run the pre-built image [`xingse/event-forwarder-gelf`] locally (with

local permission):

    echo CLUSTER=cluster-name >> .env

    echo GRAYLOG_HOST=graylog >> .env

    echo GRAYLOG_PORT=12222   >> .env

    docker run --env-file=.env xingse/event-forwarder-gelf

## Deployment

Run this controller on Kubernetes with the following commands:

    kubectl create serviceaccount event-forwarder-gelf \

      --namespace=kube-system

    kubectl create clusterrole xing:controller:event-forwarder-gelf \

      --verb=get,watch,list \

      --resource=events

    kubectl create clusterrolebinding xing:controller:event-forwarder-gelf \

      --clusterrole=xing:controller:event-forwarder-gelf \

      --serviceaccount=kube-system:event-forwarder-gelf

    kubectl run event-forwarder-gelf \

      --image=xingse/event-forwarder-gelf \

      --env=CLUSTER=cluster-name \

      --env=GRAYLOG_HOST=graylog \

      --env=GRAYLOG_PORT=12222 \

      --serviceaccount=event-forwarder-gelf

## Development

This project uses go modules introduced by [go 1.11][go-modules]. Please put the

project somewhere outside of your GOPATH to make go automatically recogninze

this.

All build and install steps are managed in the [Makefile](Makefile). `make test`

will fetch external dependencies, compile the code and run the tests. If all

goes well, hack along and submit a pull request. You might need to run the `go

mod tidy` after updating dependencies.

[`xingse/event-forwarder-gelf`]: https://hub.docker.com/r/xingse/event-forwarder-gelf

[go-modules]: https://github.com/golang/go/wiki/Modules

### Releases

Releases are a two-step process, beginning with a manual step:

* Create a release commit

  * Increase the version number in [event-forwarder-gelf.go/VERSION](event-forwarder-gelf.go#L13)

  * Adjust the [CHANGELOG](CHANGELOG.md)

* Run `make release`, which will create an image, retrieve the version from the

  binary, create a git tag and push both your commit and the tag

The Travis CI run will then realize that the current tag refers to the current master commit and

will tag the built docker image accordingly.