Skip to content

revive PR 200: feat(loki): support go template in stream labels #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions pkg/sinks/loki.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import (
"errors"
"fmt"
"github.com/resmoio/kubernetes-event-exporter/pkg/kube"
"io/ioutil"
"io"
"net/http"
"strconv"
"time"
Expand Down Expand Up @@ -51,15 +51,32 @@ func generateTimestamp() string {
return strconv.FormatInt(time.Now().Unix(), 10) + "000000000"
}

func convertStreamTemplate(layout map[string]string, ev *kube.EnhancedEvent) (map[string]string, error) {
result := make(map[string]string)
for key, value := range layout {
rendered, err := GetString(ev, value)
if err != nil {
return nil, err
}

result[key] = rendered
}
return result, nil
}

func (l *Loki) Send(ctx context.Context, ev *kube.EnhancedEvent) error {
eventBody, err := serializeEventWithLayout(l.cfg.Layout, ev)
if err != nil {
return err
}
streamLabels, err := convertStreamTemplate(l.cfg.StreamLabels, ev)
if err != nil {
return err
}
timestamp := generateTimestamp()
a := LokiMsg{
Streams: []promtailStream{{
Stream: l.cfg.StreamLabels,
Stream: streamLabels,
Values: [][]string{{timestamp, string(eventBody)}},
}},
}
Expand Down Expand Up @@ -93,7 +110,7 @@ func (l *Loki) Send(ctx context.Context, ev *kube.EnhancedEvent) error {

defer resp.Body.Close()

body, err := ioutil.ReadAll(resp.Body)
body, err := io.ReadAll(resp.Body)
if err != nil {
return err
}
Expand Down
68 changes: 68 additions & 0 deletions pkg/sinks/loki_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
package sinks

import (
"context"
"encoding/json"
"io"
"net/http"
"net/http/httptest"
"time"

"testing"

"github.com/resmoio/kubernetes-event-exporter/pkg/kube"
"github.com/stretchr/testify/assert"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

func TestLoki_Send(t *testing.T) {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
}))
defer ts.Close()
client := Loki{cfg: &LokiConfig{URL: ts.URL}}

err := client.Send(context.Background(), &kube.EnhancedEvent{})

assert.NoError(t, err)
}

func TestLoki_Send_StreamLabelsTemplated(t *testing.T) {
rr := httptest.NewRecorder()
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
result, err := io.ReadAll(r.Body)
if err != nil {
w.WriteHeader(http.StatusInternalServerError)
return
}
rr.Write(result)
w.WriteHeader(http.StatusOK)
}))
defer ts.Close()
client := Loki{cfg: &LokiConfig{
URL: ts.URL,
StreamLabels: map[string]string{
"app": "kube-events",
"object_namespace": "{{ .InvolvedObject.Namespace }}",
}}}

ev := &kube.EnhancedEvent{}
ev.Namespace = "default"
ev.Reason = "my reason"
ev.Type = "Warning"
ev.InvolvedObject.Kind = "Pod"
ev.InvolvedObject.Name = "nginx-server-123abc-456def"
ev.InvolvedObject.Namespace = "prod"
ev.Message = "Successfully pulled image \"nginx:latest\""
ev.FirstTimestamp = v1.Time{Time: time.Now()}

err := client.Send(context.Background(), ev)
assert.NoError(t, err)

var res LokiMsg
err = json.Unmarshal(rr.Body.Bytes(), &res)
assert.NoError(t, err)

assert.Equal(t, res.Streams[0].Stream["app"], "kube-events", "Non template labels should remain the same")
assert.Equal(t, res.Streams[0].Stream["object_namespace"], "prod", "Template labels should be templated")
}