1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306 |
- package splunk
- import (
- "compress/gzip"
- "fmt"
- "os"
- "testing"
- "time"
- "github.com/docker/docker/daemon/logger"
- )
- // Validate options
- func TestValidateLogOpt(t *testing.T) {
- err := ValidateLogOpt(map[string]string{
- splunkURLKey: "http://127.0.0.1",
- splunkTokenKey: "2160C7EF-2CE9-4307-A180-F852B99CF417",
- splunkSourceKey: "mysource",
- splunkSourceTypeKey: "mysourcetype",
- splunkIndexKey: "myindex",
- splunkCAPathKey: "/usr/cert.pem",
- splunkCANameKey: "ca_name",
- splunkInsecureSkipVerifyKey: "true",
- splunkFormatKey: "json",
- splunkVerifyConnectionKey: "true",
- splunkGzipCompressionKey: "true",
- splunkGzipCompressionLevelKey: "1",
- envKey: "a",
- envRegexKey: "^foo",
- labelsKey: "b",
- tagKey: "c",
- })
- if err != nil {
- t.Fatal(err)
- }
- err = ValidateLogOpt(map[string]string{
- "not-supported-option": "a",
- })
- if err == nil {
- t.Fatal("Expecting error on unsupported options")
- }
- }
- // Driver require user to specify required options
- func TestNewMissedConfig(t *testing.T) {
- info := logger.Info{
- Config: map[string]string{},
- }
- _, err := New(info)
- if err == nil {
- t.Fatal("Logger driver should fail when no required parameters specified")
- }
- }
- // Driver require user to specify splunk-url
- func TestNewMissedUrl(t *testing.T) {
- info := logger.Info{
- Config: map[string]string{
- splunkTokenKey: "4642492F-D8BD-47F1-A005-0C08AE4657DF",
- },
- }
- _, err := New(info)
- if err.Error() != "splunk: splunk-url is expected" {
- t.Fatal("Logger driver should fail when no required parameters specified")
- }
- }
- // Driver require user to specify splunk-token
- func TestNewMissedToken(t *testing.T) {
- info := logger.Info{
- Config: map[string]string{
- splunkURLKey: "http://127.0.0.1:8088",
- },
- }
- _, err := New(info)
- if err.Error() != "splunk: splunk-token is expected" {
- t.Fatal("Logger driver should fail when no required parameters specified")
- }
- }
- // Test default settings
- func TestDefault(t *testing.T) {
- hec := NewHTTPEventCollectorMock(t)
- go hec.Serve()
- info := logger.Info{
- Config: map[string]string{
- splunkURLKey: hec.URL(),
- splunkTokenKey: hec.token,
- },
- ContainerID: "containeriid",
- ContainerName: "container_name",
- ContainerImageID: "contaimageid",
- ContainerImageName: "container_image_name",
- }
- hostname, err := info.Hostname()
- if err != nil {
- t.Fatal(err)
- }
- loggerDriver, err := New(info)
- if err != nil {
- t.Fatal(err)
- }
- if loggerDriver.Name() != driverName {
- t.Fatal("Unexpected logger driver name")
- }
- if !hec.connectionVerified {
- t.Fatal("By default connection should be verified")
- }
- splunkLoggerDriver, ok := loggerDriver.(*splunkLoggerInline)
- if !ok {
- t.Fatal("Unexpected Splunk Logging Driver type")
- }
- if splunkLoggerDriver.url != hec.URL()+"/services/collector/event/1.0" ||
- splunkLoggerDriver.auth != "Splunk "+hec.token ||
- splunkLoggerDriver.nullMessage.Host != hostname ||
- splunkLoggerDriver.nullMessage.Source != "" ||
- splunkLoggerDriver.nullMessage.SourceType != "" ||
- splunkLoggerDriver.nullMessage.Index != "" ||
- splunkLoggerDriver.gzipCompression != false ||
- splunkLoggerDriver.postMessagesFrequency != defaultPostMessagesFrequency ||
- splunkLoggerDriver.postMessagesBatchSize != defaultPostMessagesBatchSize ||
- splunkLoggerDriver.bufferMaximum != defaultBufferMaximum ||
- cap(splunkLoggerDriver.stream) != defaultStreamChannelSize {
- t.Fatal("Found not default values setup in Splunk Logging Driver.")
- }
- message1Time := time.Now()
- if err := loggerDriver.Log(&logger.Message{Line: []byte("{\"a\":\"b\"}"), Source: "stdout", Timestamp: message1Time}); err != nil {
- t.Fatal(err)
- }
- message2Time := time.Now()
- if err := loggerDriver.Log(&logger.Message{Line: []byte("notajson"), Source: "stdout", Timestamp: message2Time}); err != nil {
- t.Fatal(err)
- }
- err = loggerDriver.Close()
- if err != nil {
- t.Fatal(err)
- }
- if len(hec.messages) != 2 {
- t.Fatal("Expected two messages")
- }
- if *hec.gzipEnabled {
- t.Fatal("Gzip should not be used")
- }
- message1 := hec.messages[0]
- if message1.Time != fmt.Sprintf("%f", float64(message1Time.UnixNano())/float64(time.Second)) ||
- message1.Host != hostname ||
- message1.Source != "" ||
- message1.SourceType != "" ||
- message1.Index != "" {
- t.Fatalf("Unexpected values of message 1 %v", message1)
- }
- if event, err := message1.EventAsMap(); err != nil {
- t.Fatal(err)
- } else {
- if event["line"] != "{\"a\":\"b\"}" ||
- event["source"] != "stdout" ||
- event["tag"] != "containeriid" ||
- len(event) != 3 {
- t.Fatalf("Unexpected event in message %v", event)
- }
- }
- message2 := hec.messages[1]
- if message2.Time != fmt.Sprintf("%f", float64(message2Time.UnixNano())/float64(time.Second)) ||
- message2.Host != hostname ||
- message2.Source != "" ||
- message2.SourceType != "" ||
- message2.Index != "" {
- t.Fatalf("Unexpected values of message 1 %v", message2)
- }
- if event, err := message2.EventAsMap(); err != nil {
- t.Fatal(err)
- } else {
- if event["line"] != "notajson" ||
- event["source"] != "stdout" ||
- event["tag"] != "containeriid" ||
- len(event) != 3 {
- t.Fatalf("Unexpected event in message %v", event)
- }
- }
- err = hec.Close()
- if err != nil {
- t.Fatal(err)
- }
- }
- // Verify inline format with a not default settings for most of options
- func TestInlineFormatWithNonDefaultOptions(t *testing.T) {
- hec := NewHTTPEventCollectorMock(t)
- go hec.Serve()
- info := logger.Info{
- Config: map[string]string{
- splunkURLKey: hec.URL(),
- splunkTokenKey: hec.token,
- splunkSourceKey: "mysource",
- splunkSourceTypeKey: "mysourcetype",
- splunkIndexKey: "myindex",
- splunkFormatKey: splunkFormatInline,
- splunkGzipCompressionKey: "true",
- tagKey: "{{.ImageName}}/{{.Name}}",
- labelsKey: "a",
- envRegexKey: "^foo",
- },
- ContainerID: "containeriid",
- ContainerName: "/container_name",
- ContainerImageID: "contaimageid",
- ContainerImageName: "container_image_name",
- ContainerLabels: map[string]string{
- "a": "b",
- },
- ContainerEnv: []string{"foo_finder=bar"},
- }
- hostname, err := info.Hostname()
- if err != nil {
- t.Fatal(err)
- }
- loggerDriver, err := New(info)
- if err != nil {
- t.Fatal(err)
- }
- if !hec.connectionVerified {
- t.Fatal("By default connection should be verified")
- }
- splunkLoggerDriver, ok := loggerDriver.(*splunkLoggerInline)
- if !ok {
- t.Fatal("Unexpected Splunk Logging Driver type")
- }
- if splunkLoggerDriver.url != hec.URL()+"/services/collector/event/1.0" ||
- splunkLoggerDriver.auth != "Splunk "+hec.token ||
- splunkLoggerDriver.nullMessage.Host != hostname ||
- splunkLoggerDriver.nullMessage.Source != "mysource" ||
- splunkLoggerDriver.nullMessage.SourceType != "mysourcetype" ||
- splunkLoggerDriver.nullMessage.Index != "myindex" ||
- splunkLoggerDriver.gzipCompression != true ||
- splunkLoggerDriver.gzipCompressionLevel != gzip.DefaultCompression ||
- splunkLoggerDriver.postMessagesFrequency != defaultPostMessagesFrequency ||
- splunkLoggerDriver.postMessagesBatchSize != defaultPostMessagesBatchSize ||
- splunkLoggerDriver.bufferMaximum != defaultBufferMaximum ||
- cap(splunkLoggerDriver.stream) != defaultStreamChannelSize {
- t.Fatal("Values do not match configuration.")
- }
- messageTime := time.Now()
- if err := loggerDriver.Log(&logger.Message{Line: []byte("1"), Source: "stdout", Timestamp: messageTime}); err != nil {
- t.Fatal(err)
- }
- err = loggerDriver.Close()
- if err != nil {
- t.Fatal(err)
- }
- if len(hec.messages) != 1 {
- t.Fatal("Expected one message")
- }
- if !*hec.gzipEnabled {
- t.Fatal("Gzip should be used")
- }
- message := hec.messages[0]
- if message.Time != fmt.Sprintf("%f", float64(messageTime.UnixNano())/float64(time.Second)) ||
- message.Host != hostname ||
- message.Source != "mysource" ||
- message.SourceType != "mysourcetype" ||
- message.Index != "myindex" {
- t.Fatalf("Unexpected values of message %v", message)
- }
- if event, err := message.EventAsMap(); err != nil {
- t.Fatal(err)
- } else {
- if event["line"] != "1" ||
- event["source"] != "stdout" ||
- event["tag"] != "container_image_name/container_name" ||
- event["attrs"].(map[string]interface{})["a"] != "b" ||
- event["attrs"].(map[string]interface{})["foo_finder"] != "bar" ||
- len(event) != 4 {
- t.Fatalf("Unexpected event in message %v", event)
- }
- }
- err = hec.Close()
- if err != nil {
- t.Fatal(err)
- }
- }
- // Verify JSON format
- func TestJsonFormat(t *testing.T) {
- hec := NewHTTPEventCollectorMock(t)
- go hec.Serve()
- info := logger.Info{
- Config: map[string]string{
- splunkURLKey: hec.URL(),
- splunkTokenKey: hec.token,
- splunkFormatKey: splunkFormatJSON,
- splunkGzipCompressionKey: "true",
- splunkGzipCompressionLevelKey: "1",
- },
- ContainerID: "containeriid",
- ContainerName: "/container_name",
- ContainerImageID: "contaimageid",
- ContainerImageName: "container_image_name",
- }
- hostname, err := info.Hostname()
- if err != nil {
- t.Fatal(err)
- }
- loggerDriver, err := New(info)
- if err != nil {
- t.Fatal(err)
- }
- if !hec.connectionVerified {
- t.Fatal("By default connection should be verified")
- }
- splunkLoggerDriver, ok := loggerDriver.(*splunkLoggerJSON)
- if !ok {
- t.Fatal("Unexpected Splunk Logging Driver type")
- }
- if splunkLoggerDriver.url != hec.URL()+"/services/collector/event/1.0" ||
- splunkLoggerDriver.auth != "Splunk "+hec.token ||
- splunkLoggerDriver.nullMessage.Host != hostname ||
- splunkLoggerDriver.nullMessage.Source != "" ||
- splunkLoggerDriver.nullMessage.SourceType != "" ||
- splunkLoggerDriver.nullMessage.Index != "" ||
- splunkLoggerDriver.gzipCompression != true ||
- splunkLoggerDriver.gzipCompressionLevel != gzip.BestSpeed ||
- splunkLoggerDriver.postMessagesFrequency != defaultPostMessagesFrequency ||
- splunkLoggerDriver.postMessagesBatchSize != defaultPostMessagesBatchSize ||
- splunkLoggerDriver.bufferMaximum != defaultBufferMaximum ||
- cap(splunkLoggerDriver.stream) != defaultStreamChannelSize {
- t.Fatal("Values do not match configuration.")
- }
- message1Time := time.Now()
- if err := loggerDriver.Log(&logger.Message{Line: []byte("{\"a\":\"b\"}"), Source: "stdout", Timestamp: message1Time}); err != nil {
- t.Fatal(err)
- }
- message2Time := time.Now()
- if err := loggerDriver.Log(&logger.Message{Line: []byte("notjson"), Source: "stdout", Timestamp: message2Time}); err != nil {
- t.Fatal(err)
- }
- err = loggerDriver.Close()
- if err != nil {
- t.Fatal(err)
- }
- if len(hec.messages) != 2 {
- t.Fatal("Expected two messages")
- }
- message1 := hec.messages[0]
- if message1.Time != fmt.Sprintf("%f", float64(message1Time.UnixNano())/float64(time.Second)) ||
- message1.Host != hostname ||
- message1.Source != "" ||
- message1.SourceType != "" ||
- message1.Index != "" {
- t.Fatalf("Unexpected values of message 1 %v", message1)
- }
- if event, err := message1.EventAsMap(); err != nil {
- t.Fatal(err)
- } else {
- if event["line"].(map[string]interface{})["a"] != "b" ||
- event["source"] != "stdout" ||
- event["tag"] != "containeriid" ||
- len(event) != 3 {
- t.Fatalf("Unexpected event in message 1 %v", event)
- }
- }
- message2 := hec.messages[1]
- if message2.Time != fmt.Sprintf("%f", float64(message2Time.UnixNano())/float64(time.Second)) ||
- message2.Host != hostname ||
- message2.Source != "" ||
- message2.SourceType != "" ||
- message2.Index != "" {
- t.Fatalf("Unexpected values of message 2 %v", message2)
- }
- // If message cannot be parsed as JSON - it should be sent as a line
- if event, err := message2.EventAsMap(); err != nil {
- t.Fatal(err)
- } else {
- if event["line"] != "notjson" ||
- event["source"] != "stdout" ||
- event["tag"] != "containeriid" ||
- len(event) != 3 {
- t.Fatalf("Unexpected event in message 2 %v", event)
- }
- }
- err = hec.Close()
- if err != nil {
- t.Fatal(err)
- }
- }
- // Verify raw format
- func TestRawFormat(t *testing.T) {
- hec := NewHTTPEventCollectorMock(t)
- go hec.Serve()
- info := logger.Info{
- Config: map[string]string{
- splunkURLKey: hec.URL(),
- splunkTokenKey: hec.token,
- splunkFormatKey: splunkFormatRaw,
- },
- ContainerID: "containeriid",
- ContainerName: "/container_name",
- ContainerImageID: "contaimageid",
- ContainerImageName: "container_image_name",
- }
- hostname, err := info.Hostname()
- if err != nil {
- t.Fatal(err)
- }
- loggerDriver, err := New(info)
- if err != nil {
- t.Fatal(err)
- }
- if !hec.connectionVerified {
- t.Fatal("By default connection should be verified")
- }
- splunkLoggerDriver, ok := loggerDriver.(*splunkLoggerRaw)
- if !ok {
- t.Fatal("Unexpected Splunk Logging Driver type")
- }
- if splunkLoggerDriver.url != hec.URL()+"/services/collector/event/1.0" ||
- splunkLoggerDriver.auth != "Splunk "+hec.token ||
- splunkLoggerDriver.nullMessage.Host != hostname ||
- splunkLoggerDriver.nullMessage.Source != "" ||
- splunkLoggerDriver.nullMessage.SourceType != "" ||
- splunkLoggerDriver.nullMessage.Index != "" ||
- splunkLoggerDriver.gzipCompression != false ||
- splunkLoggerDriver.postMessagesFrequency != defaultPostMessagesFrequency ||
- splunkLoggerDriver.postMessagesBatchSize != defaultPostMessagesBatchSize ||
- splunkLoggerDriver.bufferMaximum != defaultBufferMaximum ||
- cap(splunkLoggerDriver.stream) != defaultStreamChannelSize ||
- string(splunkLoggerDriver.prefix) != "containeriid " {
- t.Fatal("Values do not match configuration.")
- }
- message1Time := time.Now()
- if err := loggerDriver.Log(&logger.Message{Line: []byte("{\"a\":\"b\"}"), Source: "stdout", Timestamp: message1Time}); err != nil {
- t.Fatal(err)
- }
- message2Time := time.Now()
- if err := loggerDriver.Log(&logger.Message{Line: []byte("notjson"), Source: "stdout", Timestamp: message2Time}); err != nil {
- t.Fatal(err)
- }
- err = loggerDriver.Close()
- if err != nil {
- t.Fatal(err)
- }
- if len(hec.messages) != 2 {
- t.Fatal("Expected two messages")
- }
- message1 := hec.messages[0]
- if message1.Time != fmt.Sprintf("%f", float64(message1Time.UnixNano())/float64(time.Second)) ||
- message1.Host != hostname ||
- message1.Source != "" ||
- message1.SourceType != "" ||
- message1.Index != "" {
- t.Fatalf("Unexpected values of message 1 %v", message1)
- }
- if event, err := message1.EventAsString(); err != nil {
- t.Fatal(err)
- } else {
- if event != "containeriid {\"a\":\"b\"}" {
- t.Fatalf("Unexpected event in message 1 %v", event)
- }
- }
- message2 := hec.messages[1]
- if message2.Time != fmt.Sprintf("%f", float64(message2Time.UnixNano())/float64(time.Second)) ||
- message2.Host != hostname ||
- message2.Source != "" ||
- message2.SourceType != "" ||
- message2.Index != "" {
- t.Fatalf("Unexpected values of message 2 %v", message2)
- }
- if event, err := message2.EventAsString(); err != nil {
- t.Fatal(err)
- } else {
- if event != "containeriid notjson" {
- t.Fatalf("Unexpected event in message 1 %v", event)
- }
- }
- err = hec.Close()
- if err != nil {
- t.Fatal(err)
- }
- }
- // Verify raw format with labels
- func TestRawFormatWithLabels(t *testing.T) {
- hec := NewHTTPEventCollectorMock(t)
- go hec.Serve()
- info := logger.Info{
- Config: map[string]string{
- splunkURLKey: hec.URL(),
- splunkTokenKey: hec.token,
- splunkFormatKey: splunkFormatRaw,
- labelsKey: "a",
- },
- ContainerID: "containeriid",
- ContainerName: "/container_name",
- ContainerImageID: "contaimageid",
- ContainerImageName: "container_image_name",
- ContainerLabels: map[string]string{
- "a": "b",
- },
- }
- hostname, err := info.Hostname()
- if err != nil {
- t.Fatal(err)
- }
- loggerDriver, err := New(info)
- if err != nil {
- t.Fatal(err)
- }
- if !hec.connectionVerified {
- t.Fatal("By default connection should be verified")
- }
- splunkLoggerDriver, ok := loggerDriver.(*splunkLoggerRaw)
- if !ok {
- t.Fatal("Unexpected Splunk Logging Driver type")
- }
- if splunkLoggerDriver.url != hec.URL()+"/services/collector/event/1.0" ||
- splunkLoggerDriver.auth != "Splunk "+hec.token ||
- splunkLoggerDriver.nullMessage.Host != hostname ||
- splunkLoggerDriver.nullMessage.Source != "" ||
- splunkLoggerDriver.nullMessage.SourceType != "" ||
- splunkLoggerDriver.nullMessage.Index != "" ||
- splunkLoggerDriver.gzipCompression != false ||
- splunkLoggerDriver.postMessagesFrequency != defaultPostMessagesFrequency ||
- splunkLoggerDriver.postMessagesBatchSize != defaultPostMessagesBatchSize ||
- splunkLoggerDriver.bufferMaximum != defaultBufferMaximum ||
- cap(splunkLoggerDriver.stream) != defaultStreamChannelSize ||
- string(splunkLoggerDriver.prefix) != "containeriid a=b " {
- t.Fatal("Values do not match configuration.")
- }
- message1Time := time.Now()
- if err := loggerDriver.Log(&logger.Message{Line: []byte("{\"a\":\"b\"}"), Source: "stdout", Timestamp: message1Time}); err != nil {
- t.Fatal(err)
- }
- message2Time := time.Now()
- if err := loggerDriver.Log(&logger.Message{Line: []byte("notjson"), Source: "stdout", Timestamp: message2Time}); err != nil {
- t.Fatal(err)
- }
- err = loggerDriver.Close()
- if err != nil {
- t.Fatal(err)
- }
- if len(hec.messages) != 2 {
- t.Fatal("Expected two messages")
- }
- message1 := hec.messages[0]
- if message1.Time != fmt.Sprintf("%f", float64(message1Time.UnixNano())/float64(time.Second)) ||
- message1.Host != hostname ||
- message1.Source != "" ||
- message1.SourceType != "" ||
- message1.Index != "" {
- t.Fatalf("Unexpected values of message 1 %v", message1)
- }
- if event, err := message1.EventAsString(); err != nil {
- t.Fatal(err)
- } else {
- if event != "containeriid a=b {\"a\":\"b\"}" {
- t.Fatalf("Unexpected event in message 1 %v", event)
- }
- }
- message2 := hec.messages[1]
- if message2.Time != fmt.Sprintf("%f", float64(message2Time.UnixNano())/float64(time.Second)) ||
- message2.Host != hostname ||
- message2.Source != "" ||
- message2.SourceType != "" ||
- message2.Index != "" {
- t.Fatalf("Unexpected values of message 2 %v", message2)
- }
- if event, err := message2.EventAsString(); err != nil {
- t.Fatal(err)
- } else {
- if event != "containeriid a=b notjson" {
- t.Fatalf("Unexpected event in message 2 %v", event)
- }
- }
- err = hec.Close()
- if err != nil {
- t.Fatal(err)
- }
- }
- // Verify that Splunk Logging Driver can accept tag="" which will allow to send raw messages
- // in the same way we get them in stdout/stderr
- func TestRawFormatWithoutTag(t *testing.T) {
- hec := NewHTTPEventCollectorMock(t)
- go hec.Serve()
- info := logger.Info{
- Config: map[string]string{
- splunkURLKey: hec.URL(),
- splunkTokenKey: hec.token,
- splunkFormatKey: splunkFormatRaw,
- tagKey: "",
- },
- ContainerID: "containeriid",
- ContainerName: "/container_name",
- ContainerImageID: "contaimageid",
- ContainerImageName: "container_image_name",
- }
- hostname, err := info.Hostname()
- if err != nil {
- t.Fatal(err)
- }
- loggerDriver, err := New(info)
- if err != nil {
- t.Fatal(err)
- }
- if !hec.connectionVerified {
- t.Fatal("By default connection should be verified")
- }
- splunkLoggerDriver, ok := loggerDriver.(*splunkLoggerRaw)
- if !ok {
- t.Fatal("Unexpected Splunk Logging Driver type")
- }
- if splunkLoggerDriver.url != hec.URL()+"/services/collector/event/1.0" ||
- splunkLoggerDriver.auth != "Splunk "+hec.token ||
- splunkLoggerDriver.nullMessage.Host != hostname ||
- splunkLoggerDriver.nullMessage.Source != "" ||
- splunkLoggerDriver.nullMessage.SourceType != "" ||
- splunkLoggerDriver.nullMessage.Index != "" ||
- splunkLoggerDriver.gzipCompression != false ||
- splunkLoggerDriver.postMessagesFrequency != defaultPostMessagesFrequency ||
- splunkLoggerDriver.postMessagesBatchSize != defaultPostMessagesBatchSize ||
- splunkLoggerDriver.bufferMaximum != defaultBufferMaximum ||
- cap(splunkLoggerDriver.stream) != defaultStreamChannelSize ||
- string(splunkLoggerDriver.prefix) != "" {
- t.Log(string(splunkLoggerDriver.prefix) + "a")
- t.Fatal("Values do not match configuration.")
- }
- message1Time := time.Now()
- if err := loggerDriver.Log(&logger.Message{Line: []byte("{\"a\":\"b\"}"), Source: "stdout", Timestamp: message1Time}); err != nil {
- t.Fatal(err)
- }
- message2Time := time.Now()
- if err := loggerDriver.Log(&logger.Message{Line: []byte("notjson"), Source: "stdout", Timestamp: message2Time}); err != nil {
- t.Fatal(err)
- }
- err = loggerDriver.Close()
- if err != nil {
- t.Fatal(err)
- }
- if len(hec.messages) != 2 {
- t.Fatal("Expected two messages")
- }
- message1 := hec.messages[0]
- if message1.Time != fmt.Sprintf("%f", float64(message1Time.UnixNano())/float64(time.Second)) ||
- message1.Host != hostname ||
- message1.Source != "" ||
- message1.SourceType != "" ||
- message1.Index != "" {
- t.Fatalf("Unexpected values of message 1 %v", message1)
- }
- if event, err := message1.EventAsString(); err != nil {
- t.Fatal(err)
- } else {
- if event != "{\"a\":\"b\"}" {
- t.Fatalf("Unexpected event in message 1 %v", event)
- }
- }
- message2 := hec.messages[1]
- if message2.Time != fmt.Sprintf("%f", float64(message2Time.UnixNano())/float64(time.Second)) ||
- message2.Host != hostname ||
- message2.Source != "" ||
- message2.SourceType != "" ||
- message2.Index != "" {
- t.Fatalf("Unexpected values of message 2 %v", message2)
- }
- if event, err := message2.EventAsString(); err != nil {
- t.Fatal(err)
- } else {
- if event != "notjson" {
- t.Fatalf("Unexpected event in message 2 %v", event)
- }
- }
- err = hec.Close()
- if err != nil {
- t.Fatal(err)
- }
- }
- // Verify that we will send messages in batches with default batching parameters,
- // but change frequency to be sure that numOfRequests will match expected 17 requests
- func TestBatching(t *testing.T) {
- if err := os.Setenv(envVarPostMessagesFrequency, "10h"); err != nil {
- t.Fatal(err)
- }
- hec := NewHTTPEventCollectorMock(t)
- go hec.Serve()
- info := logger.Info{
- Config: map[string]string{
- splunkURLKey: hec.URL(),
- splunkTokenKey: hec.token,
- },
- ContainerID: "containeriid",
- ContainerName: "/container_name",
- ContainerImageID: "contaimageid",
- ContainerImageName: "container_image_name",
- }
- loggerDriver, err := New(info)
- if err != nil {
- t.Fatal(err)
- }
- for i := 0; i < defaultStreamChannelSize*4; i++ {
- if err := loggerDriver.Log(&logger.Message{Line: []byte(fmt.Sprintf("%d", i)), Source: "stdout", Timestamp: time.Now()}); err != nil {
- t.Fatal(err)
- }
- }
- err = loggerDriver.Close()
- if err != nil {
- t.Fatal(err)
- }
- if len(hec.messages) != defaultStreamChannelSize*4 {
- t.Fatal("Not all messages delivered")
- }
- for i, message := range hec.messages {
- if event, err := message.EventAsMap(); err != nil {
- t.Fatal(err)
- } else {
- if event["line"] != fmt.Sprintf("%d", i) {
- t.Fatalf("Unexpected event in message %v", event)
- }
- }
- }
- // 1 to verify connection and 16 batches
- if hec.numOfRequests != 17 {
- t.Fatalf("Unexpected number of requests %d", hec.numOfRequests)
- }
- err = hec.Close()
- if err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarPostMessagesFrequency, ""); err != nil {
- t.Fatal(err)
- }
- }
- // Verify that test is using time to fire events not rare than specified frequency
- func TestFrequency(t *testing.T) {
- if err := os.Setenv(envVarPostMessagesFrequency, "5ms"); err != nil {
- t.Fatal(err)
- }
- hec := NewHTTPEventCollectorMock(t)
- go hec.Serve()
- info := logger.Info{
- Config: map[string]string{
- splunkURLKey: hec.URL(),
- splunkTokenKey: hec.token,
- },
- ContainerID: "containeriid",
- ContainerName: "/container_name",
- ContainerImageID: "contaimageid",
- ContainerImageName: "container_image_name",
- }
- loggerDriver, err := New(info)
- if err != nil {
- t.Fatal(err)
- }
- for i := 0; i < 10; i++ {
- if err := loggerDriver.Log(&logger.Message{Line: []byte(fmt.Sprintf("%d", i)), Source: "stdout", Timestamp: time.Now()}); err != nil {
- t.Fatal(err)
- }
- time.Sleep(15 * time.Millisecond)
- }
- err = loggerDriver.Close()
- if err != nil {
- t.Fatal(err)
- }
- if len(hec.messages) != 10 {
- t.Fatal("Not all messages delivered")
- }
- for i, message := range hec.messages {
- if event, err := message.EventAsMap(); err != nil {
- t.Fatal(err)
- } else {
- if event["line"] != fmt.Sprintf("%d", i) {
- t.Fatalf("Unexpected event in message %v", event)
- }
- }
- }
- // 1 to verify connection and 10 to verify that we have sent messages with required frequency,
- // but because frequency is too small (to keep test quick), instead of 11, use 9 if context switches will be slow
- if hec.numOfRequests < 9 {
- t.Fatalf("Unexpected number of requests %d", hec.numOfRequests)
- }
- err = hec.Close()
- if err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarPostMessagesFrequency, ""); err != nil {
- t.Fatal(err)
- }
- }
- // Simulate behavior similar to first version of Splunk Logging Driver, when we were sending one message
- // per request
- func TestOneMessagePerRequest(t *testing.T) {
- if err := os.Setenv(envVarPostMessagesFrequency, "10h"); err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarPostMessagesBatchSize, "1"); err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarBufferMaximum, "1"); err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarStreamChannelSize, "0"); err != nil {
- t.Fatal(err)
- }
- hec := NewHTTPEventCollectorMock(t)
- go hec.Serve()
- info := logger.Info{
- Config: map[string]string{
- splunkURLKey: hec.URL(),
- splunkTokenKey: hec.token,
- },
- ContainerID: "containeriid",
- ContainerName: "/container_name",
- ContainerImageID: "contaimageid",
- ContainerImageName: "container_image_name",
- }
- loggerDriver, err := New(info)
- if err != nil {
- t.Fatal(err)
- }
- for i := 0; i < 10; i++ {
- if err := loggerDriver.Log(&logger.Message{Line: []byte(fmt.Sprintf("%d", i)), Source: "stdout", Timestamp: time.Now()}); err != nil {
- t.Fatal(err)
- }
- }
- err = loggerDriver.Close()
- if err != nil {
- t.Fatal(err)
- }
- if len(hec.messages) != 10 {
- t.Fatal("Not all messages delivered")
- }
- for i, message := range hec.messages {
- if event, err := message.EventAsMap(); err != nil {
- t.Fatal(err)
- } else {
- if event["line"] != fmt.Sprintf("%d", i) {
- t.Fatalf("Unexpected event in message %v", event)
- }
- }
- }
- // 1 to verify connection and 10 messages
- if hec.numOfRequests != 11 {
- t.Fatalf("Unexpected number of requests %d", hec.numOfRequests)
- }
- err = hec.Close()
- if err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarPostMessagesFrequency, ""); err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarPostMessagesBatchSize, ""); err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarBufferMaximum, ""); err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarStreamChannelSize, ""); err != nil {
- t.Fatal(err)
- }
- }
- // Driver should not be created when HEC is unresponsive
- func TestVerify(t *testing.T) {
- hec := NewHTTPEventCollectorMock(t)
- hec.simulateServerError = true
- go hec.Serve()
- info := logger.Info{
- Config: map[string]string{
- splunkURLKey: hec.URL(),
- splunkTokenKey: hec.token,
- },
- ContainerID: "containeriid",
- ContainerName: "/container_name",
- ContainerImageID: "contaimageid",
- ContainerImageName: "container_image_name",
- }
- _, err := New(info)
- if err == nil {
- t.Fatal("Expecting driver to fail, when server is unresponsive")
- }
- err = hec.Close()
- if err != nil {
- t.Fatal(err)
- }
- }
- // Verify that user can specify to skip verification that Splunk HEC is working.
- // Also in this test we verify retry logic.
- func TestSkipVerify(t *testing.T) {
- hec := NewHTTPEventCollectorMock(t)
- hec.simulateServerError = true
- go hec.Serve()
- info := logger.Info{
- Config: map[string]string{
- splunkURLKey: hec.URL(),
- splunkTokenKey: hec.token,
- splunkVerifyConnectionKey: "false",
- },
- ContainerID: "containeriid",
- ContainerName: "/container_name",
- ContainerImageID: "contaimageid",
- ContainerImageName: "container_image_name",
- }
- loggerDriver, err := New(info)
- if err != nil {
- t.Fatal(err)
- }
- if hec.connectionVerified {
- t.Fatal("Connection should not be verified")
- }
- for i := 0; i < defaultStreamChannelSize*2; i++ {
- if err := loggerDriver.Log(&logger.Message{Line: []byte(fmt.Sprintf("%d", i)), Source: "stdout", Timestamp: time.Now()}); err != nil {
- t.Fatal(err)
- }
- }
- if len(hec.messages) != 0 {
- t.Fatal("No messages should be accepted at this point")
- }
- hec.simulateServerError = false
- for i := defaultStreamChannelSize * 2; i < defaultStreamChannelSize*4; i++ {
- if err := loggerDriver.Log(&logger.Message{Line: []byte(fmt.Sprintf("%d", i)), Source: "stdout", Timestamp: time.Now()}); err != nil {
- t.Fatal(err)
- }
- }
- err = loggerDriver.Close()
- if err != nil {
- t.Fatal(err)
- }
- if len(hec.messages) != defaultStreamChannelSize*4 {
- t.Fatal("Not all messages delivered")
- }
- for i, message := range hec.messages {
- if event, err := message.EventAsMap(); err != nil {
- t.Fatal(err)
- } else {
- if event["line"] != fmt.Sprintf("%d", i) {
- t.Fatalf("Unexpected event in message %v", event)
- }
- }
- }
- err = hec.Close()
- if err != nil {
- t.Fatal(err)
- }
- }
- // Verify logic for when we filled whole buffer
- func TestBufferMaximum(t *testing.T) {
- if err := os.Setenv(envVarPostMessagesBatchSize, "2"); err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarBufferMaximum, "10"); err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarStreamChannelSize, "0"); err != nil {
- t.Fatal(err)
- }
- hec := NewHTTPEventCollectorMock(t)
- hec.simulateServerError = true
- go hec.Serve()
- info := logger.Info{
- Config: map[string]string{
- splunkURLKey: hec.URL(),
- splunkTokenKey: hec.token,
- splunkVerifyConnectionKey: "false",
- },
- ContainerID: "containeriid",
- ContainerName: "/container_name",
- ContainerImageID: "contaimageid",
- ContainerImageName: "container_image_name",
- }
- loggerDriver, err := New(info)
- if err != nil {
- t.Fatal(err)
- }
- if hec.connectionVerified {
- t.Fatal("Connection should not be verified")
- }
- for i := 0; i < 11; i++ {
- if err := loggerDriver.Log(&logger.Message{Line: []byte(fmt.Sprintf("%d", i)), Source: "stdout", Timestamp: time.Now()}); err != nil {
- t.Fatal(err)
- }
- }
- if len(hec.messages) != 0 {
- t.Fatal("No messages should be accepted at this point")
- }
- hec.simulateServerError = false
- err = loggerDriver.Close()
- if err != nil {
- t.Fatal(err)
- }
- if len(hec.messages) != 9 {
- t.Fatalf("Expected # of messages %d, got %d", 9, len(hec.messages))
- }
- // First 1000 messages are written to daemon log when buffer was full
- for i, message := range hec.messages {
- if event, err := message.EventAsMap(); err != nil {
- t.Fatal(err)
- } else {
- if event["line"] != fmt.Sprintf("%d", i+2) {
- t.Fatalf("Unexpected event in message %v", event)
- }
- }
- }
- err = hec.Close()
- if err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarPostMessagesBatchSize, ""); err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarBufferMaximum, ""); err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarStreamChannelSize, ""); err != nil {
- t.Fatal(err)
- }
- }
- // Verify that we are not blocking close when HEC is down for the whole time
- func TestServerAlwaysDown(t *testing.T) {
- if err := os.Setenv(envVarPostMessagesBatchSize, "2"); err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarBufferMaximum, "4"); err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarStreamChannelSize, "0"); err != nil {
- t.Fatal(err)
- }
- hec := NewHTTPEventCollectorMock(t)
- hec.simulateServerError = true
- go hec.Serve()
- info := logger.Info{
- Config: map[string]string{
- splunkURLKey: hec.URL(),
- splunkTokenKey: hec.token,
- splunkVerifyConnectionKey: "false",
- },
- ContainerID: "containeriid",
- ContainerName: "/container_name",
- ContainerImageID: "contaimageid",
- ContainerImageName: "container_image_name",
- }
- loggerDriver, err := New(info)
- if err != nil {
- t.Fatal(err)
- }
- if hec.connectionVerified {
- t.Fatal("Connection should not be verified")
- }
- for i := 0; i < 5; i++ {
- if err := loggerDriver.Log(&logger.Message{Line: []byte(fmt.Sprintf("%d", i)), Source: "stdout", Timestamp: time.Now()}); err != nil {
- t.Fatal(err)
- }
- }
- err = loggerDriver.Close()
- if err != nil {
- t.Fatal(err)
- }
- if len(hec.messages) != 0 {
- t.Fatal("No messages should be sent")
- }
- err = hec.Close()
- if err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarPostMessagesBatchSize, ""); err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarBufferMaximum, ""); err != nil {
- t.Fatal(err)
- }
- if err := os.Setenv(envVarStreamChannelSize, ""); err != nil {
- t.Fatal(err)
- }
- }
- // Cannot send messages after we close driver
- func TestCannotSendAfterClose(t *testing.T) {
- hec := NewHTTPEventCollectorMock(t)
- go hec.Serve()
- info := logger.Info{
- Config: map[string]string{
- splunkURLKey: hec.URL(),
- splunkTokenKey: hec.token,
- },
- ContainerID: "containeriid",
- ContainerName: "/container_name",
- ContainerImageID: "contaimageid",
- ContainerImageName: "container_image_name",
- }
- loggerDriver, err := New(info)
- if err != nil {
- t.Fatal(err)
- }
- if err := loggerDriver.Log(&logger.Message{Line: []byte("message1"), Source: "stdout", Timestamp: time.Now()}); err != nil {
- t.Fatal(err)
- }
- err = loggerDriver.Close()
- if err != nil {
- t.Fatal(err)
- }
- if err := loggerDriver.Log(&logger.Message{Line: []byte("message2"), Source: "stdout", Timestamp: time.Now()}); err == nil {
- t.Fatal("Driver should not allow to send messages after close")
- }
- if len(hec.messages) != 1 {
- t.Fatal("Only one message should be sent")
- }
- message := hec.messages[0]
- if event, err := message.EventAsMap(); err != nil {
- t.Fatal(err)
- } else {
- if event["line"] != "message1" {
- t.Fatalf("Unexpected event in message %v", event)
- }
- }
- err = hec.Close()
- if err != nil {
- t.Fatal(err)
- }
- }
|