Skip to content

Commit 3f05bd1

Browse files
ctlongctlong
committed
Breaking: Remove LOG_CACHE_ADDR env var option
Removes the LOG_CACHE_ADDR env var as an option for telling the plugin where to look for Log Cache. This is a relic of when the plugin had a dual function as a standalone CLI, and is no longer necessary since the plugin can always fetch the Log Cache address from the targeted CF API.
1 parent 72c7f78 commit 3f05bd1

File tree

7 files changed

+48
-140
lines changed

7 files changed

+48
-140
lines changed

‎README.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ USAGE:
5555
tail [options] <source-id/app>
5656
5757
ENVIRONMENT VARIABLES:
58-
LOG_CACHE_ADDR Overrides the default location of log-cache.
5958
LOG_CACHE_SKIP_AUTH Set to 'true' to disable CF authentication.
6059
6160
OPTIONS:
@@ -81,7 +80,6 @@ USAGE:
8180
log-meta [options]
8281
8382
ENVIRONMENT VARIABLES:
84-
LOG_CACHE_ADDR Overrides the default location of log-cache.
8583
LOG_CACHE_SKIP_AUTH Set to 'true' to disable CF authentication.
8684
8785
OPTIONS:
@@ -102,7 +100,6 @@ USAGE:
102100
query <promql-query> [options]
103101
104102
ENVIRONMENT VARIABLES:
105-
LOG_CACHE_ADDR Overrides the default location of log-cache.
106103
LOG_CACHE_SKIP_AUTH Set to 'true' to disable CF authentication.
107104
108105
OPTIONS:

‎internal/command/meta.go‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -506,12 +506,6 @@ func maxDuration(a, b time.Duration) time.Duration {
506506
}
507507

508508
func logCacheEndpoint(cli plugin.CliConnection) (string, error) {
509-
logCacheAddr := os.Getenv("LOG_CACHE_ADDR")
510-
511-
if logCacheAddr != "" {
512-
return logCacheAddr, nil
513-
}
514-
515509
apiEndpoint, err := cli.ApiEndpoint()
516510
if err != nil {
517511
return "", err

‎internal/command/meta_test.go‎

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1018,36 +1018,6 @@ var _ = Describe("Meta", func() {
10181018
Expect(strings.Split(tableWriter.String(), "\n")).To(HaveLen(57))
10191019
})
10201020

1021-
It("uses the LOG_CACHE_ADDR environment variable", func() {
1022-
_ = os.Setenv("LOG_CACHE_ADDR", "https://different-log-cache:8080")
1023-
defer func() { _ = os.Unsetenv("LOG_CACHE_ADDR") }()
1024-
1025-
httpClient.responseBody = []string{
1026-
metaResponseInfo("source-1"),
1027-
}
1028-
1029-
cliConn.cliCommandResult = [][]string{
1030-
{
1031-
capiAppsResponse(map[string]string{"source-1": "app-1"}),
1032-
},
1033-
}
1034-
cliConn.cliCommandErr = nil
1035-
1036-
command.Meta(
1037-
cliConn,
1038-
nil,
1039-
httpClient,
1040-
logger,
1041-
tableWriter,
1042-
)
1043-
1044-
Expect(httpClient.requestURLs).To(HaveLen(1))
1045-
u, err := url.Parse(httpClient.requestURLs[0])
1046-
Expect(err).ToNot(HaveOccurred())
1047-
Expect(u.Scheme).To(Equal("https"))
1048-
Expect(u.Host).To(Equal("different-log-cache:8080"))
1049-
})
1050-
10511021
It("does not send Authorization header with LOG_CACHE_SKIP_AUTH", func() {
10521022
_ = os.Setenv("LOG_CACHE_SKIP_AUTH", "true")
10531023
defer func() { _ = os.Unsetenv("LOG_CACHE_SKIP_AUTH") }()

‎internal/command/query.go‎

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -54,25 +54,22 @@ func Query(
5454
})
5555
}
5656

57-
logCacheAddr := os.Getenv("LOG_CACHE_ADDR")
58-
if logCacheAddr == "" {
59-
hasAPI, err := cli.HasAPIEndpoint()
60-
if err != nil {
61-
log.Fatalf("%s", err)
62-
}
63-
64-
if !hasAPI {
65-
log.Fatalf("No API endpoint targeted.")
66-
}
57+
hasAPI, err := cli.HasAPIEndpoint()
58+
if err != nil {
59+
log.Fatalf("%s", err)
60+
}
6761

68-
tokenURL, err := cli.ApiEndpoint()
69-
if err != nil {
70-
log.Fatalf("%s", err)
71-
}
62+
if !hasAPI {
63+
log.Fatalf("No API endpoint targeted.")
64+
}
7265

73-
logCacheAddr = strings.Replace(tokenURL, "api", "log-cache", 1)
66+
tokenURL, err := cli.ApiEndpoint()
67+
if err != nil {
68+
log.Fatalf("%s", err)
7469
}
7570

71+
logCacheAddr := strings.Replace(tokenURL, "api", "log-cache", 1)
72+
7673
client := logcache.NewClient(logCacheAddr, logcache.WithHTTPClient(c))
7774

7875
var res *logcache.PromQLQueryResult

‎internal/command/tail.go‎

Lines changed: 36 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -59,53 +59,50 @@ func Tail(
5959
}
6060
}()
6161

62-
logCacheAddr := os.Getenv("LOG_CACHE_ADDR")
63-
if logCacheAddr == "" {
64-
hasAPI, err := cli.HasAPIEndpoint()
65-
if err != nil {
66-
log.Fatalf("%s", err)
67-
}
62+
hasAPI, err := cli.HasAPIEndpoint()
63+
if err != nil {
64+
log.Fatalf("%s", err)
65+
}
6866

69-
if !hasAPI {
70-
log.Fatalf("No API endpoint targeted.")
71-
}
67+
if !hasAPI {
68+
log.Fatalf("No API endpoint targeted.")
69+
}
7270

73-
tokenURL, err := cli.ApiEndpoint()
74-
if err != nil {
75-
log.Fatalf("%s", err)
76-
}
71+
tokenURL, err := cli.ApiEndpoint()
72+
if err != nil {
73+
log.Fatalf("%s", err)
74+
}
7775

78-
user, err := cli.Username()
79-
if err != nil {
80-
log.Fatalf("%s", err)
81-
}
76+
user, err := cli.Username()
77+
if err != nil {
78+
log.Fatalf("%s", err)
79+
}
8280

83-
org, err := cli.GetCurrentOrg()
84-
if err != nil {
85-
log.Fatalf("%s", err)
86-
}
81+
org, err := cli.GetCurrentOrg()
82+
if err != nil {
83+
log.Fatalf("%s", err)
84+
}
8785

88-
space, err := cli.GetCurrentSpace()
89-
if err != nil {
90-
log.Fatalf("%s", err)
91-
}
86+
space, err := cli.GetCurrentSpace()
87+
if err != nil {
88+
log.Fatalf("%s", err)
89+
}
9290

93-
logCacheAddr = strings.Replace(tokenURL, "api", "log-cache", 1)
91+
logCacheAddr := strings.Replace(tokenURL, "api", "log-cache", 1)
9492

95-
headerPrinter := formatter.sourceHeader
96-
switch o.source.Type {
97-
case _application:
98-
headerPrinter = formatter.appHeader
99-
case _service:
100-
headerPrinter = formatter.serviceHeader
101-
}
93+
headerPrinter := formatter.sourceHeader
94+
switch o.source.Type {
95+
case _application:
96+
headerPrinter = formatter.appHeader
97+
case _service:
98+
headerPrinter = formatter.serviceHeader
99+
}
102100

103-
if !o.noHeaders {
104-
header, ok := headerPrinter(o.source.Name, org.Name, space.Name, user)
105-
if ok {
106-
lw.Write(header)
107-
lw.Write("")
108-
}
101+
if !o.noHeaders {
102+
header, ok := headerPrinter(o.source.Name, org.Name, space.Name, user)
103+
if ok {
104+
lw.Write(header)
105+
lw.Write("")
109106
}
110107
}
111108

‎internal/command/tail_test.go‎

Lines changed: 0 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -826,26 +826,6 @@ var _ = Describe("LogCache", func() {
826826
Expect(wrapperFunc).To(Panic())
827827
})
828828

829-
It("uses the LOG_CACHE_ADDR environment variable", func() {
830-
os.Setenv("LOG_CACHE_ADDR", "https://different-log-cache:8080")
831-
defer os.Unsetenv("LOG_CACHE_ADDR")
832-
833-
command.Tail(
834-
context.Background(),
835-
cliConn,
836-
[]string{"app-name"},
837-
httpClient,
838-
logger,
839-
writer,
840-
)
841-
Expect(httpClient.requestURLs).To(HaveLen(1))
842-
843-
u, err := url.Parse(httpClient.requestURLs[0])
844-
Expect(err).ToNot(HaveOccurred())
845-
Expect(u.Scheme).To(Equal("https"))
846-
Expect(u.Host).To(Equal("different-log-cache:8080"))
847-
})
848-
849829
It("does not send Authorization header with LOG_CACHE_SKIP_AUTH", func() {
850830
os.Setenv("LOG_CACHE_SKIP_AUTH", "true")
851831
defer os.Unsetenv("LOG_CACHE_SKIP_AUTH")
@@ -1621,30 +1601,6 @@ var _ = Describe("LogCache", func() {
16211601
Expect(logger.printfMessages).To(ContainElement("app not found"))
16221602
Expect(logger.printfMessages).To(ContainElement("service not found"))
16231603
})
1624-
1625-
It("uses the LOG_CACHE_ADDR environment variable", func() {
1626-
os.Setenv("LOG_CACHE_ADDR", "https://different-log-cache:8080")
1627-
defer os.Unsetenv("LOG_CACHE_ADDR")
1628-
1629-
cliConn.cliCommandResult = [][]string{{""}, {""}}
1630-
cliConn.cliCommandErr = []error{errors.New("app not found"), errors.New("service not found")}
1631-
1632-
command.Tail(
1633-
context.Background(),
1634-
cliConn,
1635-
[]string{"app-name"},
1636-
httpClient,
1637-
logger,
1638-
writer,
1639-
)
1640-
Expect(httpClient.requestURLs).To(HaveLen(1))
1641-
1642-
u, err := url.Parse(httpClient.requestURLs[0])
1643-
Expect(err).ToNot(HaveOccurred())
1644-
Expect(u.Scheme).To(Equal("https"))
1645-
Expect(u.Host).To(Equal("different-log-cache:8080"))
1646-
Expect(u.Path).To(ContainSubstring("app-name"))
1647-
})
16481604
})
16491605
})
16501606

‎internal/logcache/plugin.go‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,6 @@ func (lc *LogCache) GetMetadata() plugin.PluginMetadata {
6464
Usage: `tail [options] <source-id/app>
6565
6666
ENVIRONMENT VARIABLES:
67-
LOG_CACHE_ADDR Overrides the default location of log-cache.
6867
LOG_CACHE_SKIP_AUTH Set to 'true' to disable CF authentication.`,
6968
Options: map[string]string{
7069
"-start-time": "Start of query range in UNIX nanoseconds.",
@@ -86,7 +85,6 @@ ENVIRONMENT VARIABLES:
8685
Usage: `log-meta [options]
8786
8887
ENVIRONMENT VARIABLES:
89-
LOG_CACHE_ADDR Overrides the default location of log-cache.
9088
LOG_CACHE_SKIP_AUTH Set to 'true' to disable CF authentication.`,
9189
Options: map[string]string{
9290
"-source-type": "Source type of information to show. Available: 'all', 'application', 'service', 'platform', and 'unknown'. Excludes unknown sources unless 'all' or 'unknown' is selected, or `--guid` is used. To receive information on platform or unknown source id's, you must have the doppler.firehose, or logs.admin scope.",
@@ -103,7 +101,6 @@ ENVIRONMENT VARIABLES:
103101
Usage: `query <promql-query> [options]
104102
105103
ENVIRONMENT VARIABLES:
106-
LOG_CACHE_ADDR Overrides the default location of log-cache.
107104
LOG_CACHE_SKIP_AUTH Set to 'true' to disable CF authentication.`,
108105
Options: map[string]string{
109106
"-time": "Effective time for query execution of an instant query. Cannont be used with --start, --end, or --step. Can be a unix timestamp or RFC3339.",

0 commit comments

Comments
 (0)